BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-06-05 13:08:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated supported languages in the docs.

Browse Source 
Change-Id: I607f5f33b609c47fe32342f5e9d066f61f5546cd
This commit is contained in:
Wouter van Oortmerssen
2015-11-09 17:23:32 -08:00
parent b0b39543de
commit 9dc5d378b1
4 changed files with 58 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/source/FlatBuffers.md
View File

@@ -1,8 +1,9 @@
# FlatBuffers
FlatBuffers is an efficient cross platform serialization library for C++,
with support for Java, C# and Go. It was created at Google specifically for game
development and other performance-critical applications.
FlatBuffers is an efficient cross platform serialization library for C++, Java,
C#, Go, Python and JavaScript (C, PHP & Ruby in progress).
It was originally created at Google for game development and other
performance-critical applications.
It is available as Open Source on [GitHub](http://github.com/google/flatbuffers)
under the Apache license, v2 (see LICENSE.txt).
@@ -16,8 +17,8 @@ under the Apache license, v2 (see LICENSE.txt).
structure evolution (forwards/backwards compatibility).
- **Memory efficiency and speed** - The only memory needed to access
your data is that of the buffer. It requires 0 additional allocations.
FlatBuffers is also very
your data is that of the buffer. It requires 0 additional allocations
(in C++, other languages may vary). FlatBuffers is also very
suitable for use with mmap (or streaming), requiring only part of the
buffer to be in memory. Access is close to the speed of raw
struct access with only one extra indirection (a kind of vtable) to
@@ -47,9 +48,10 @@ under the Apache license, v2 (see LICENSE.txt).
needed (faster and more memory efficient than other JSON
parsers).
Java and Go code supports object-reuse.
Java and Go code supports object-reuse. C# has efficient struct based
accessors.
- **Cross platform C++11/Java/C#/Go code with no dependencies** - will work
- **Cross platform code with no dependencies** - C++ code will work
with any recent gcc/clang and VS2010. Comes with build files for the tests &
samples (Android .mk files, and cmake for all other platforms).
@@ -139,6 +141,9 @@ sections provide a more in-depth usage guide.
- [Landing page](http://google.github.io/flatbuffers)
- [FlatBuffers Google Group](http://group.google.com/group/flatbuffers)
- [FlatBuffers Issues Tracker](http://github.com/google/flatbuffers/issues)
- Independent implementations & tools:
- [FlatCC](https://github.com/dvidelabs/flatcc) Alternative FlatBuffers
parser, code generator and runtime all in C.
- Videos:
- Colt's [DevByte](https://www.youtube.com/watch?v=iQTxMkSJ1dQ).
- GDC 2015 [Lightning Talk](https://www.youtube.com/watch?v=olmL1fUnQAQ).

36
docs/source/Support.md
View File

@@ -17,23 +17,25 @@ In general:
NOTE: this table is a start, it needs to be extended.
Feature | C++ | Java | C# | Go | Python | JS
------------------------------ | ------ | ------ | ------ | ------ | ------ | ------
Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | WIP
JSON parsing | Yes | No | No | No | No | No
Simple mutation | Yes | WIP | WIP | No | No | No
Reflection | Yes | No | No | No | No | No
Buffer verifier | Yes | No | No | No | No | No
Testing: basic | Yes | Yes | Yes | Yes | Yes | WIP
Testing: fuzz | Yes | No | No | Yes | Yes | No
Performance: | Superb | Great | Great | Great | Ok | ?
Platform: Windows | VS2010 | Yes | Yes | ? | ? | ?
Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ?
Platform: OS X | Xcode4 | ? | ? | ? | Yes | ?
Platform: Android | NDK10d | Yes | ? | ? | ? | ?
Platform: iOS | ? | ? | ? | ? | ? | ?
Engine: Unity | ? | ? | Yes | ? | ? | ?
Primary authors (github) | wvo | wvo | (ev/js)| rw | rw | (ev)
Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby
------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ---- | --- | ----
Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | WiP | WiP | WiP
JSON parsing | Yes | No | No | No | No | No | No | No | No
Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No
Reflection | Yes | No | No | No | No | No | No | No | No
Buffer verifier | Yes | No | No | No | No | No | No | No | No
Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | ? | ? | ?
Testing: fuzz | Yes | No | No | Yes | Yes | No | ? | ? | ?
Performance: | Superb | Great | Great | Great | Ok | ? |Superb| ? | ?
Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? | ? | ? | ?
Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | ? | ? | ?
Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | ? | ? | ?
Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ? | ? | ?
Platform: iOS | ? | ? | ? | ? | ? | ? | ? | ? | ?
Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ?
Primary authors (github) | gwvo | gwvo | ev*/js*| rw | rw | evanw/ev* | mik* | ch* | rw
* ev = evolutional
* js = jonsimantov
* mik = mikkelfj
* ch = chobie