# BrushFamilySerialization

Artifact: [androidx.ink:ink-storage](https://developer.android.com/jetpack/androidx/releases/ink) [View Source](https://cs.android.com/search?q=file:androidx/ink/storage/BrushFamilyExtensions.jvmAndAndroid.kt+class:androidx.ink.storage.BrushFamilySerialization) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/ink#1.0.0)

*** ** * ** ***


```
public static class BrushFamilySerialization
```

<br />

*** ** * ** ***

## Summary

| ### Public fields |
|---|---|
| `static @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#INSTANCE()` |

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(kotlin.ByteArray,androidx.ink.storage.OnDecodeTexturePngBytes)( @https://developer.android.com/reference/androidx/annotation/NonNull byte[] input, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/storage/OnDecodeTexturePngBytes onDecodeTexture )` See `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(kotlin.ByteArray,androidx.ink.storage.OnDecodeTexturePngBytes)` above. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(java.io.InputStream,androidx.ink.storage.OnDecodeTexturePngBytes)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/InputStream.html input, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/storage/OnDecodeTexturePngBytes onDecodeTexture )` See `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(java.io.InputStream,androidx.ink.storage.OnDecodeTexturePngBytes)` above. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(kotlin.ByteArray,androidx.ink.brush.Version,androidx.ink.storage.OnDecodeTexturePngBytes)( @https://developer.android.com/reference/androidx/annotation/NonNull byte[] input, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/Version maxVersion, https://developer.android.com/reference/androidx/ink/storage/OnDecodeTexturePngBytes onDecodeTexture )` Read a serialized `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` from the given `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html` and parse it into a `https://developer.android.com/reference/androidx/ink/brush/BrushFamily`, throwing an exception if parsing or validation was not successful. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(java.io.InputStream,androidx.ink.brush.Version,androidx.ink.storage.OnDecodeTexturePngBytes)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/InputStream.html input, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/Version maxVersion, https://developer.android.com/reference/androidx/ink/storage/OnDecodeTexturePngBytes onDecodeTexture )` Read a serialized `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` from the given `https://developer.android.com/reference/java/io/InputStream.html` and parse it into a `https://developer.android.com/reference/androidx/ink/brush/BrushFamily`, throwing an exception if parsing or validation was not successful. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull byte[]` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#encode(androidx.ink.brush.BrushFamily,androidx.ink.storage.TexturePngBytesLookup)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily brushFamily, https://developer.android.com/reference/androidx/ink/storage/TexturePngBytesLookup textureIdToPngBytes )` Write a gzip-compressed serialized `ink.proto.BrushFamily` proto message representing the `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html`. |
| `static final void` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#encode(androidx.ink.brush.BrushFamily,java.io.OutputStream,androidx.ink.storage.TexturePngBytesLookup)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily brushFamily, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/OutputStream.html output, https://developer.android.com/reference/androidx/ink/storage/TexturePngBytesLookup textureIdToPngBytes )` Write a gzip-compressed serialized `ink.proto.BrushFamily` proto message representing the `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` to the given `https://developer.android.com/reference/java/io/OutputStream.html`. |

## Public fields

### INSTANCE

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/ink#1.0.0)

```
public static @NonNull BrushFamilySerialization INSTANCE
```

## Public methods

### decode

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

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

See `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(kotlin.ByteArray,androidx.ink.storage.OnDecodeTexturePngBytes)` above. This overload uses `https://developer.android.com/reference/androidx/ink/brush/Version#MAX_SUPPORTED()`.

### decode

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

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

See `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(java.io.InputStream,androidx.ink.storage.OnDecodeTexturePngBytes)` above. This overload uses `https://developer.android.com/reference/androidx/ink/brush/Version#MAX_SUPPORTED()`.

### decode

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

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

Read a serialized `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` from the given `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html` and parse it into a `https://developer.android.com/reference/androidx/ink/brush/BrushFamily`, throwing an exception if parsing or validation was not successful. Kotlin callers should use `https://developer.android.com/reference/androidx/ink/storage/package-summary#(androidx.ink.brush.BrushFamily.Companion).decode(java.io.InputStream,androidx.ink.brush.Version,androidx.ink.storage.OnDecodeTexturePngBytes)` instead.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull byte[] input` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html` providing gzip-compressed `ink.proto.BrushFamily` binary proto messages, the same as written by `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#encode(androidx.ink.brush.BrushFamily,java.io.OutputStream,androidx.ink.storage.TexturePngBytesLookup)`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/Version maxVersion` | The maximum `https://developer.android.com/reference/androidx/ink/brush/Version` supported by the deserializer. Proto objects with a `min_version` of greater than maxVersion will be rejected. |
| `https://developer.android.com/reference/androidx/ink/storage/OnDecodeTexturePngBytes onDecodeTexture` | A callback to store any decoded texture image, if any were encoded inside the serialized `https://developer.android.com/reference/androidx/ink/brush/BrushFamily`s. This is called synchronously as part of this function call, on the same thread, once for each texture image. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily` | The `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` parsed from the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html`. |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(kotlin.ByteArray,androidx.ink.brush.Version,androidx.ink.storage.OnDecodeTexturePngBytes)` does not provide a valid `ink.proto.BrushFamily` proto message, or the corresponding `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` is invalid. |

### decode

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

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

Read a serialized `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` from the given `https://developer.android.com/reference/java/io/InputStream.html` and parse it into a `https://developer.android.com/reference/androidx/ink/brush/BrushFamily`, throwing an exception if parsing or validation was not successful. Kotlin callers should use `https://developer.android.com/reference/androidx/ink/storage/package-summary#(androidx.ink.brush.BrushFamily.Companion).decode(java.io.InputStream,androidx.ink.brush.Version,androidx.ink.storage.OnDecodeTexturePngBytes)` instead.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/InputStream.html input` | `https://developer.android.com/reference/java/io/InputStream.html` providing gzip-compressed `ink.proto.BrushFamily` binary proto messages, the same as written by `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#encode(androidx.ink.brush.BrushFamily,java.io.OutputStream,androidx.ink.storage.TexturePngBytesLookup)`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/Version maxVersion` | The maximum `https://developer.android.com/reference/androidx/ink/brush/Version` supported by the deserializer. Proto objects with a `min_version` of greater than maxVersion will be rejected. |
| `https://developer.android.com/reference/androidx/ink/storage/OnDecodeTexturePngBytes onDecodeTexture` | A callback to store any decoded texture image, if any were encoded inside the serialized `https://developer.android.com/reference/androidx/ink/brush/BrushFamily`s. This is called synchronously as part of this function call, on the same thread, once for each texture image. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/ink/brush/BrushFamily` | The `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` parsed from the `https://developer.android.com/reference/java/io/InputStream.html`. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | if gzip-format bytes cannot be read from `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(java.io.InputStream,androidx.ink.brush.Version,androidx.ink.storage.OnDecodeTexturePngBytes)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | `https://developer.android.com/reference/androidx/ink/storage/BrushFamilySerialization#decode(java.io.InputStream,androidx.ink.brush.Version,androidx.ink.storage.OnDecodeTexturePngBytes)` does not provide a valid `ink.proto.BrushFamily` proto message, or the corresponding `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` is invalid. |

### encode

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

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

Write a gzip-compressed serialized `ink.proto.BrushFamily` proto message representing the `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html`. If `https://developer.android.com/reference/androidx/ink/brush/BrushFamily#hasFallbacks()` is true, then the stored proto message including fallbacks for this `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` will be used instead of recomputing the proto from the `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` object.

### encode

Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

```
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 `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` to the given `https://developer.android.com/reference/java/io/OutputStream.html`. If `https://developer.android.com/reference/androidx/ink/brush/BrushFamily#hasFallbacks()` is true, then the stored proto message including fallbacks for this `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` will be used instead of recomputing the proto from the `https://developer.android.com/reference/androidx/ink/brush/BrushFamily` object.