ממשקי API של מברשות

ממשקי ה-API של Brush מספקים לכם את הכלים להגדרת הסגנון החזותי של הקווים. אתם יכולים ליצור מברשות עם צבעים, גדלים וסוגים שונים כדי להשיג מגוון מראה.

יצירת מברשת

כדי ליצור מברשת, משתמשים בשיטות הנלוות של Compose Brush עם ארגומנטים בעלי שם כמו Brush.Companion.createWithComposeColor. המחלקות האלה מאפשרות להגדיר את המאפיינים הבאים:

  • family: הסגנון של המברשת, בדומה לטיפוגרפיה או לגופן בטקסט. בקטע StockBrushes מפורטים הערכים הזמינים של BrushFamily.
  • color: צבע המברשת. אפשר להגדיר את הצבע באמצעות ColorLong.
  • size: העובי הכולל של הקווים שנוצרו באמצעות המברשת.
  • epsilon: המרחק הקטן ביותר שבו שתי נקודות צריכות להיחשב כנפרדות מבחינה ויזואלית למטרות גיאומטריה של יצירת קו. היחס בין אפסילון לבין נקודות המשיכות קובע עד כמה אפשר להגדיל את התצוגה של משיכה בלי שיופיעו ארטיפקטים, על חשבון הזיכרון. נקודת התחלה טובה ליחידות של שבץ היא 1 px, ונקודת התחלה טובה לאפסילון היא 0.1. ערכי אפסילון גבוהים יותר משתמשים בפחות זיכרון, אבל מאפשרים פחות הגדלה לפני שמופיעים ארטיפקטים של משולשים. מומלץ לערוך ניסויים כדי למצוא את הערך המתאים לתרחיש לדוגמה שלכם.
val brush = Brush.createWithComposeColor(
  family = StockBrushes.pressure(),
  colorIntArgb = Color.Black,
  size = 5F,
  epsilon = 0.1F
)

שינוי המאפיינים של המכחול

אפשר ליצור עותק של מברשת קיימת באמצעות השיטה copyWithComposeColor(), שמאפשרת לשנות את כל המאפיינים של המברשת.

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

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

מברשות בהתאמה אישית

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
)