BrushFamily.Companion


public static class BrushFamily.Companion


Summary

Extension functions

static final BrushFamily

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, returning null if parsing was not successful.

static final @NonNull BrushFamily

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing was not successful.

static final BrushFamily

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, returning null if parsing was not successful.

static final @NonNull BrushFamily

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing was not successful.

Extension functions

AndroidBrushFamilyExtensions.decodeOrNull

@ExperimentalInkCustomBrushApi
public static final BrushFamily AndroidBrushFamilyExtensions.decodeOrNull(
    @NonNull BrushFamily.Companion receiver,
    @NonNull InputStream input,
    @NonNull BrushFamilyDecodeCallback getClientTextureId
)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, returning null if parsing was not successful. The serialized representation is gzip-compressed ink.proto.BrushFamily binary proto messages, the same as written to OutputStream by BrushFamily.encode. Java callers should use AndroidBrushFamilySerialization.decodeOrNull.

getClientTextureId is called synchronously as part of this function call, on the same thread.

AndroidBrushFamilyExtensions.decodeOrThrow

@ExperimentalInkCustomBrushApi
public static final @NonNull BrushFamily AndroidBrushFamilyExtensions.decodeOrThrow(
    @NonNull BrushFamily.Companion receiver,
    @NonNull InputStream input,
    @NonNull BrushFamilyDecodeCallback getClientTextureId
)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing was not successful. The serialized representation is gzip-compressed ink.proto.BrushFamily binary proto messages, the same as written to OutputStream by BrushFamily.encode. Java callers should use AndroidBrushFamilySerialization.decodeOrThrow.

getClientTextureId is called synchronously as part of this function call, on the same thread.

BrushFamilyExtensions.decodeOrNull

public static final BrushFamily BrushFamilyExtensions.decodeOrNull(
    @NonNull BrushFamily.Companion receiver,
    @NonNull InputStream input
)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, returning null if parsing was not successful. The serialized representation is gzip-compressed ink.proto.BrushFamily binary proto messages, the same as written to OutputStream by BrushFamily.encode. Java callers should use BrushFamilySerialization.decodeOrNull.

BrushFamilyExtensions.decodeOrThrow

public static final @NonNull BrushFamily BrushFamilyExtensions.decodeOrThrow(
    @NonNull BrushFamily.Companion receiver,
    @NonNull InputStream input
)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing was not successful. The serialized representation is gzip-compressed ink.proto.BrushFamily binary proto messages, the same as written to OutputStream by BrushFamily.encode. Java callers should use BrushFamilySerialization.decodeOrThrow.