• OctoMY API
  • OctoMY API Reference
  • C++ Classes
  • OctoMY
  • SyncSchemaEntry
  • SyncSchemaEntry Struct

    Describes one field of a SyncSchema: its name, its type and its bit width. More...

    Header: #include <SyncSchemaEntry>

    Detailed Description

    The typeId is the TypeID tag of the field's C++ type, and SyncClient refuses a value whose type does not match it. For integer and bool fields, bits is the number of bits the encoder writes. Floating-point fields always use their full size, and a string field uses a 32-bit length followed by its UTF-8 bytes. description is for people and is not encoded.

    Construct an entry with the type as a template argument through createEntry(), or pass the typeId directly.

    See also SyncSchema and SyncClient.