Brush-APIs

Die Brush-APIs bieten Ihnen die Tools, mit denen Sie den visuellen Stil Ihrer Striche definieren können. Sie können Pinsel mit verschiedenen Farben, Größen und Familien erstellen, um unterschiedliche Looks zu erzielen.

Pinsel erstellen

Verwenden Sie zum Erstellen eines Pinsels die Compose-Companion-Methoden Brush mit benannten Argumenten wie Brush.Companion.createWithComposeColor. Mit dieser Klasse können Sie die folgenden Attribute festlegen:

• family: Der Stil des Pinsels, analog zu einer Schriftart im Text. Mögliche BrushFamily-Werte finden Sie unter StockBrushes.
• color: Die Farbe des Pinsels. Sie können die Farbe mit einem ColorLong festlegen.
• size: Die Gesamtstärke der mit dem Pinsel erstellten Striche.
• epsilon: Der kleinste Abstand, bei dem zwei Punkte für die Generierung von Strichgeometrie als visuell unterschiedlich betrachtet werden sollten. Das Verhältnis von Epsilon und Strichpunkten steuert, wie stark ein Strich vergrößert werden kann, ohne dass Artefakte entstehen. Dies geht jedoch auf Kosten des Arbeitsspeichers. Ein guter Ausgangspunkt für Stricheinheiten ist 1 px und für Epsilon 0, 1. Höhere Epsilon-Werte erfordern weniger Arbeitsspeicher, ermöglichen aber weniger Zoom, bevor Dreieckartefakte auftreten. Experimentieren Sie, um den richtigen Wert für Ihren Anwendungsfall zu finden.

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

Pinseleigenschaften ändern

Sie können mit der Methode copyWithComposeColor() eine Kopie eines vorhandenen Pinsels erstellen und so die Eigenschaften des Pinsels ändern.

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

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

Benutzerdefinierte Pinsel

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
)