API Brush

Le API Brush ti forniscono gli strumenti per definire lo stile visivo dei tuoi tratti. Puoi creare pennelli con colori, dimensioni e famiglie diversi per ottenere una varietà di look.

Creare un pennello

Per creare un pennello, utilizza i metodi complementari Compose Brush con argomenti denominati come Brush.Companion.createWithComposeColor. Questa classe consente di impostare le seguenti proprietà:

• family: lo stile del pennello, analogo a un carattere di testo. Consulta StockBrushes per i valori BrushFamily disponibili.
• color: il colore del pennello. Puoi impostare il colore utilizzando un ColorLong.
• size: Lo spessore complessivo dei tratti creati con il pennello.
• epsilon: la distanza più piccola per cui due punti devono essere considerati visivamente distinti ai fini della geometria di generazione del tratto. Il rapporto tra epsilon e punti del tratto controlla il livello di zoom di un tratto senza artefatti, a scapito della memoria. Un buon punto di partenza per le unità di tratto è 1 px e un buon punto di partenza per epsilon è 0, 1. Valori epsilon più elevati utilizzano meno memoria, ma consentono un livello di zoom inferiore prima che compaiano artefatti triangolari. Sperimenta per trovare il valore giusto per il tuo caso d'uso.

val brush = Brush.createWithComposeColor(
  family = StockBrushes.pressure(),
  colorIntArgb = Color.Black,
  size = 5F,
  epsilon = 0.1F
)

Modificare le proprietà del pennello

Puoi creare una copia di un pennello esistente utilizzando il metodo copyWithComposeColor(), che ti consente di modificare qualsiasi proprietà del pennello.

val redBrush = Brush.createWithComposeColor(
  family = StockBrushes.pressurePen(),
  colorIntArgb = Color.RED,
  size = 5F,
  epsilon = 0.1F
)

val blueBrush = redBrush.copyWithComposeColor(color = Color.BLUE)

Pennelli personalizzati

While StockBrushes provides a versatile set of common brushes, Ink API also offers an advanced path for creating entirely new brush behaviors for unique artistic effects or to replicate specific existing brushes for backward compatibility.

A custom BrushFamily is loaded from its serialized format. The required format is the gzipped binary encoding of the BrushFamily protocol buffer. This lets you load and use custom brush files today. Once deserialized, the custom BrushFamily can be used to create a new Brush with a specific color and size, just like any of the StockBrushes families.

class CustomBrushes(val context: Context) {

  private const val TAG = "CustomBrushes"

  val brushes by lazy { loadCustomBrushes(context) }

  @OptIn(ExperimentalInkCustomBrushApi::class)
  private fun loadCustomBrushes(): List<CustomBrush> {
    val brushFiles = mapOf(
        "Calligraphy" to (R.raw.calligraphy to R.drawable.draw_24px),
        "Flag Banner" to (R.raw.flag_banner to R.drawable.flag_24px),
        "Graffiti" to (R.raw.graffiti to R.drawable.format_paint_24px),
    // ...
    )

    val loadedBrushes = brushFiles.mapNotNull { (name, pair) ->
      val (resourceId, icon) = pair
      val brushFamily = context.resources.openRawResource(resourceId).use
      { inputStream ->
          BrushFamily.decode(inputStream)
      }
      CustomBrush(name, icon, brushFamily.copy(clientBrushFamilyId = name))     
    }
    return loadedBrushes
  }
}

data class CustomBrush(
  val name: String,
  val icon: Int,
  val brushFamily: BrushFamily
)