BrushFamilySerialization

Added in 1.0.0

Kotlin |Java

public static class BrushFamilySerialization

Summary

Public fields
`static @NonNull BrushFamilySerialization`	`INSTANCE`

Public methods
`static final @NonNull BrushFamily`	`decode( @NonNull byte[] input, @NonNull OnDecodeTexturePngBytes onDecodeTexture )` See `decode` above.
`static final @NonNull BrushFamily`	`decode( @NonNull InputStream input, @NonNull OnDecodeTexturePngBytes onDecodeTexture )` See `decode` above.
`static final @NonNull BrushFamily`	`decode( @NonNull byte[] input, @NonNull Version maxVersion, OnDecodeTexturePngBytes onDecodeTexture )` Read a serialized `BrushFamily` from the given `ByteArray` and parse it into a `BrushFamily`, throwing an exception if parsing or validation was not successful.
`static final @NonNull BrushFamily`	`decode( @NonNull InputStream input, @NonNull Version maxVersion, OnDecodeTexturePngBytes onDecodeTexture )` Read a serialized `BrushFamily` from the given `InputStream` and parse it into a `BrushFamily`, throwing an exception if parsing or validation was not successful.
`static final @NonNull byte[]`	`encode( @NonNull BrushFamily brushFamily, TexturePngBytesLookup textureIdToPngBytes )` Write a gzip-compressed serialized `ink.proto.BrushFamily` proto message representing the `BrushFamily` to a `ByteArray`.
`static final void`	`encode( @NonNull BrushFamily brushFamily, @NonNull OutputStream output, TexturePngBytesLookup textureIdToPngBytes )` Write a gzip-compressed serialized `ink.proto.BrushFamily` proto message representing the `BrushFamily` to the given `OutputStream`.

Public fields

INSTANCE

Added in 1.0.0

public static @NonNull BrushFamilySerialization INSTANCE

Public methods

decode

Added in 1.1.0-alpha06

public static final @NonNull BrushFamily decode(
    @NonNull byte[] input,
    @NonNull OnDecodeTexturePngBytes onDecodeTexture
)

See decode above. This overload uses Version.MAX_SUPPORTED.

decode

Added in 1.1.0-alpha06

public static final @NonNull BrushFamily decode(
    @NonNull InputStream input,
    @NonNull OnDecodeTexturePngBytes onDecodeTexture
)

See decode above. This overload uses Version.MAX_SUPPORTED.

decode

Added in 1.1.0-alpha06

public static final @NonNull BrushFamily decode(
    @NonNull byte[] input,
    @NonNull Version maxVersion,
    OnDecodeTexturePngBytes onDecodeTexture
)

Read a serialized BrushFamily from the given ByteArray and parse it into a BrushFamily, throwing an exception if parsing or validation was not successful. Kotlin callers should use BrushFamily.Companion.decode instead.

Parameters
`@NonNull byte[] input`	`ByteArray` providing gzip-compressed `ink.proto.BrushFamily` binary proto messages, the same as written by `encode`.
`@NonNull Version maxVersion`	The maximum `Version` supported by the deserializer. Proto objects with a `min_version` of greater than maxVersion will be rejected.
`OnDecodeTexturePngBytes onDecodeTexture`	A callback to store any decoded texture image, if any were encoded inside the serialized `BrushFamily`s. This is called synchronously as part of this function call, on the same thread, once for each texture image.

Returns
`@NonNull BrushFamily`	The `BrushFamily` parsed from the `ByteArray`.

Throws
`IllegalArgumentException`	`input` does not provide a valid `ink.proto.BrushFamily` proto message, or the corresponding `BrushFamily` is invalid.

decode

Added in 1.1.0-alpha06

public static final @NonNull BrushFamily decode(
    @NonNull InputStream input,
    @NonNull Version maxVersion,
    OnDecodeTexturePngBytes onDecodeTexture
)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing or validation was not successful. Kotlin callers should use BrushFamily.Companion.decode instead.

Parameters
`@NonNull InputStream input`	`InputStream` providing gzip-compressed `ink.proto.BrushFamily` binary proto messages, the same as written by `encode`.
`@NonNull Version maxVersion`	The maximum `Version` supported by the deserializer. Proto objects with a `min_version` of greater than maxVersion will be rejected.
`OnDecodeTexturePngBytes onDecodeTexture`	A callback to store any decoded texture image, if any were encoded inside the serialized `BrushFamily`s. This is called synchronously as part of this function call, on the same thread, once for each texture image.

Returns
`@NonNull BrushFamily`	The `BrushFamily` parsed from the `InputStream`.

Throws
`java.io.IOException`	if gzip-format bytes cannot be read from `input`.
`IllegalArgumentException`	`input` does not provide a valid `ink.proto.BrushFamily` proto message, or the corresponding `BrushFamily` is invalid.

encode

Added in 1.1.0-alpha06

public static final @NonNull byte[] encode(
    @NonNull BrushFamily brushFamily,
    TexturePngBytesLookup textureIdToPngBytes
)

Write a gzip-compressed serialized ink.proto.BrushFamily proto message representing the BrushFamily to a ByteArray. If BrushFamily.hasFallbacks is true, then the stored proto message including fallbacks for this BrushFamily will be used instead of recomputing the proto from the BrushFamily object.

encode

Added in 1.1.0-alpha06

public static final void encode(
    @NonNull BrushFamily brushFamily,
    @NonNull OutputStream output,
    TexturePngBytesLookup textureIdToPngBytes
)

Write a gzip-compressed serialized ink.proto.BrushFamily proto message representing the BrushFamily to the given OutputStream. If BrushFamily.hasFallbacks is true, then the stored proto message including fallbacks for this BrushFamily will be used instead of recomputing the proto from the BrushFamily object.