BrushFamily.Companion

Added in 1.0.0

Kotlin |Java

android
```
object BrushFamily.Companion
```

Summary

Extension functions
`BrushFamily`	`@ExperimentalInkCustomBrushApi BrushFamily.Companion.decode( input: InputStream, getClientTextureId: BrushFamilyDecodeCallback )` Read a serialized `BrushFamily` from the given `InputStream` and parse it into a `BrushFamily`, throwing an exception if parsing or validation was not successful.	android
`BrushFamily`	`@ExperimentalInkCustomBrushApi BrushFamily.Companion.decode(input: InputStream)` Read a serialized `BrushFamily` from the given `InputStream` and parse it into a `BrushFamily`, throwing an exception if parsing or validation was not successful.	android

Extension functions

decode

android

Artifact: androidx.ink:ink-storage

View Source

@ExperimentalInkCustomBrushApi
fun BrushFamily.Companion.decode(
    input: InputStream,
    getClientTextureId: BrushFamilyDecodeCallback
): BrushFamily

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

Parameters
`input: InputStream`	`InputStream` providing gzip-compressed `ink.proto.BrushFamily` binary proto messages, the same as written to `OutputStream` by `encode`.
`getClientTextureId: BrushFamilyDecodeCallback`	A callback to store the decoded texture image, if one were encoded inside the serialized `BrushFamily`, into a `TextureBitmapStore`. This is called synchronously as part of this function call on the same thread.

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

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

decode

android

Artifact: androidx.ink:ink-storage

View Source

@ExperimentalInkCustomBrushApi
fun BrushFamily.Companion.decode(input: InputStream): BrushFamily

Parameters
`input: InputStream`	`InputStream` providing gzip-compressed `ink.proto.BrushFamily` binary proto messages, the same as written to `OutputStream` by `encode`.

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

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