Doc clarifications (Java vectors, test working dir, benchmark fix).

Change-Id: If8cc05669d82df892e1d4e11f7fbbd68b2dc05bf
This commit is contained in:
Wouter van Oortmerssen
2014-06-23 13:33:34 -07:00
parent 65cfa18855
commit ff0d7a89d8
6 changed files with 24 additions and 8 deletions

View File

@@ -22,6 +22,12 @@ method to which you can pass a `Vec3` object you've already created. This allows
you to reuse it across many calls and reduce the amount of object allocation (and
thus garbage collection) your program does.
Java does not support unsigned scalars. This means that any unsigned types you
use in your schema will actually be represented as a signed value. This means
all bits are still present, but may represent a negative value when used.
For example, to read a `byte b` as an unsigned number, you can do:
`(short)(b & 0xFF)`
Sadly the string accessors currently always create a new string when accessed,
since FlatBuffer's UTF-8 strings can't be read in-place by Java.
@@ -72,6 +78,11 @@ You can use the generated method `startInventoryVector` to conveniently call
elements you want to write. You write the elements backwards since the buffer
is being constructed back to front.
There are `add` functions for all the scalar types. You use `addOffset` for
any previously constructed objects (such as other tables, strings, vectors).
For structs, you use the appropriate `create` function in-line, as shown
above in the `Monster` example.
## Text Parsing
There currently is no support for parsing text (Schema's and JSON) directly