BrushFamily

Artifact: androidx.ink:ink-brush

View Source

Added in 1.0.0-alpha05

---

Kotlin |Java

Android/JVM

• android

  class BrushFamily

---

A BrushFamily describes a family of brushes (e.g. “highlighter” or “pressure pen”), irrespective of their size or color.

For now, BrushFamily is an opaque type that can only be instantiated via StockBrushes. A future version of this module will allow creating fully custom BrushFamily objects.

BrushFamily objects are immutable.

Summary

Nested types
object BrushFamily.Companion

Public functions
open operator Boolean	equals(other: Any?)	android
open Int	hashCode()	android
open String	toString()	android

Protected functions
Unit	finalize() Deletes native BrushFamily memory.	android

Extension functions
Unit	@ExperimentalInkCustomBrushApi BrushFamily.encode(     output: OutputStream,     textureBitmapStore: TextureBitmapStore ) Write a gzip-compressed ink.proto.BrushFamily binary proto message representing the BrushFamily to the given OutputStream.	android
Unit	@ExperimentalInkCustomBrushApi BrushFamily.encode(output: OutputStream) Write a gzip-compressed serialized ink.proto.BrushFamily proto message representing the BrushFamily to the given OutputStream.	android

Public functions

equals

android

open operator fun equals(other: Any?): Boolean

hashCode

android

open fun hashCode(): Int

toString

android

open fun toString(): String

Protected functions

finalize

android

Added in 1.0.0-alpha05

protected fun finalize(): Unit

Deletes native BrushFamily memory.

Extension functions

encode

android

Artifact: androidx.ink:ink-storage

View Source

@ExperimentalInkCustomBrushApi
fun BrushFamily.encode(
    output: OutputStream,
    textureBitmapStore: TextureBitmapStore
): Unit

Write a gzip-compressed ink.proto.BrushFamily binary proto message representing the BrushFamily to the given OutputStream.

Parameters
BrushFamily	The BrushFamily object to encode.
output: OutputStream	The OutputStream to write the gzip-compressed encoded bytes to.
textureBitmapStore: TextureBitmapStore	The TextureBitmapStore to use to encode the texture images within the encoded BrushFamily. If this is not desired behavior, e.g. if the application has a static set of texture images that it includes as resources, then this can be a TextureBitmapStore that always returns null.

encode

android

Artifact: androidx.ink:ink-storage

View Source

@ExperimentalInkCustomBrushApi
fun BrushFamily.encode(output: OutputStream): Unit

Write a gzip-compressed serialized ink.proto.BrushFamily proto message representing the BrushFamily to the given OutputStream.