Namespace: Serialization
Serialization
Classes
Namespaces
Type Definitions
CompressionType
Enum of RIFF chunk supported compression types
Properties:
| Name | Type | Description |
|---|---|---|
NONE | object | Compression not applied |
ZIP | object | ZIP compression for particular chunk |
LZMA | object | LZMA compression for particular chunk |
ContentType
Enum of RIFF chunk contnet types
Properties:
| Name | Type | Description |
|---|---|---|
LIST | object | sequence of data |
BINARY | object | binary/octet-stream |
PROTO | object | application/protobuf |
JSON | object | application/json |
TEXT | object | text/plain |
InkData
Decoded InkData structure
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
strokes | Array.<Stroke> | |||
unitScaleFactor | float | <optional> | 1 | PX to DIP converion factor |
transform | Common.Matrix | <optional> |
InkToolInit
Decoded InkTool configuration
Properties:
| Name | Type | Description |
|---|---|---|
brush | Rendering.Brush | |
blendMode | Rendering.BlendMode | |
statics | PathBuilding.PathPointProperties | |
dynamics | PathBuilding.PathPointSettings |
RIFFChunkDescriptor
RIFF chunk configuration
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
data | Uint8Array|JSON|string|Array.<(Uint8Array|JSON|string|Array)> | User defined data | ||
fourCC | RIFFFormat.fourCC|string|Uint8Array | <optional> | RIFFFormat.fourCC.DATA | Chunk identifier, should be 4 chars long, where allowed chars are latin leters, numbers and space |
version | string | <optional> | 0.0.0 | Uint8Array | Chunk semantic version (MAJOR.MINOR.PATCH) |
contentType | RIFFFormat.ContentType | <optional> | RIFFFormat.ContentType.BINARY | |
compressionType | RIFFFormat.CompressionType | <optional> | RIFFFormat.CompressionType.NONE |
RIFFDescriptor
RIFF descriptor
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
format | string | RIFF format | |
version | string | <optional> | File format semantic version (MAJOR.MINOR.PATCH) when available |
chunks | Array.<object> | Serialized user defined data |