APIs de pincel

Las APIs de Brush te proporcionan las herramientas para definir el estilo visual de tus trazos. Puedes crear pinceles con diferentes colores, tamaños y familias para lograr una variedad de estilos.

Cómo crear un pincel

Para crear un pincel, usa los métodos complementarios de Compose Brush con argumentos con nombre, como Brush.Companion.createWithComposeColor. Esta clase te permite establecer las siguientes propiedades:

  • family: Es el estilo del pincel, análogo a un tipo de letra o una fuente en el texto. Consulta StockBrushes para ver los valores de BrushFamily disponibles.
  • color: Es el color del pincel. Puedes establecer el color con un ColorLong.
  • size: Es el grosor general de los trazos creados con el pincel.
  • epsilon: Es la distancia más pequeña para la que se deben considerar dos puntos visualmente distintos a los efectos de la geometría de generación de trazos. La proporción de puntos de épsilon y trazo controla cuánto se puede acercar un trazo sin artefactos, a costa de la memoria. Un buen punto de partida para las unidades de trazo es 1 px, y un buen punto de partida para el valor de epsilon es 0.1. Los valores de épsilon más altos usan menos memoria, pero permiten menos zoom antes de que aparezcan artefactos triangulares. Experimenta para encontrar el valor adecuado para tu caso de uso.
val brush = Brush.createWithComposeColor(
  family = StockBrushes.pressure(),
  colorIntArgb = Color.Black,
  size = 5F,
  epsilon = 0.1F
)

Cómo modificar las propiedades del pincel

Puedes crear una copia de un pincel existente con el método copyWithComposeColor(), que te permite cambiar cualquiera de las propiedades del pincel.

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

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

Pinceles personalizados

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
)