Pennello: gradienti e ombreggiatori

Un Brush in Compose descrive come viene disegnato qualcosa sullo schermo: determina i colori che vengono disegnati nell'area di disegno (ad es. un cerchio, un quadrato, un percorso). Esistono alcuni pennelli integrati utili per il disegno, come LinearGradient, RadialGradient o un semplice pennello SolidColor.

I pennelli possono essere utilizzati con le chiamate draw Modifier.background(), TextStyle o DrawScope per applicare lo stile di pittura ai contenuti in fase di disegno.

Ad esempio, un pennello con gradiente orizzontale può essere applicato per disegnare un cerchio in DrawScope:

val brush = Brush.horizontalGradient(listOf(Color.Red, Color.Blue))
Canvas(
    modifier = Modifier.size(200.dp),
    onDraw = {
        drawCircle(brush)
    }
)
BrushExampleSnippets.kt

Pennelli sfumati

Esistono molti pennelli gradiente integrati che possono essere utilizzati per ottenere diversi effetti di gradiente. Questi pennelli consentono di specificare l'elenco di colori da cui creare una sfumatura.

Un elenco dei pennelli gradiente disponibili e il relativo output:

Tipo di pennello gradiente	Output
Brush.horizontalGradient(colorList)
Brush.linearGradient(colorList)
Brush.verticalGradient(colorList)
Brush.sweepGradient(colorList) Nota: per ottenere una transizione graduale tra i colori, imposta l'ultimo colore sul colore iniziale.
Brush.radialGradient(colorList)

Cambia la distribuzione dei colori con colorStops

Per personalizzare la visualizzazione dei colori nel gradiente, puoi modificare il valore colorStops per ciascuno. colorStops deve essere specificato come frazione, compreso tra 0 e 1. I valori superiori a 1 fanno sì che i colori non vengano visualizzati come parte del gradiente.

Puoi configurare le interruzioni di colore in modo che abbiano quantità diverse, ad esempio meno o più di un colore:

val colorStops = arrayOf(
    0.0f to Color.Yellow,
    0.2f to Color.Red,
    1f to Color.Blue
)
Box(
    modifier = Modifier
        .requiredSize(200.dp)
        .background(Brush.horizontalGradient(colorStops = colorStops))
)
BrushExampleSnippets.kt

I colori sono dispersi nell'offset fornito come definito nella coppia colorStop, meno giallo rispetto al rosso e al blu.

Ripeti una sequenza con TileMode

Per ogni pennello gradiente è possibile impostare un TileMode. Potresti non vedere TileMode se non hai impostato un'origine e un'estremità per il gradiente, poiché per impostazione predefinita viene riempita l'intera area. Un TileMode suddivide il gradiente in riquadri solo se le dimensioni dell'area sono maggiori di quelle del pennello.

Il seguente codice ripeterà il pattern di gradiente 4 volte, poiché endX è impostato su 50.dp e la dimensione è impostata su 200.dp:

val listColors = listOf(Color.Yellow, Color.Red, Color.Blue)
val tileSize = with(LocalDensity.current) {
    50.dp.toPx()
}
Box(
    modifier = Modifier
        .requiredSize(200.dp)
        .background(
            Brush.horizontalGradient(
                listColors,
                endX = tileSize,
                tileMode = TileMode.Repeated
            )
        )
)
BrushExampleSnippets.kt

Di seguito è riportata una tabella che descrive in dettaglio cosa fanno le diverse modalità dei riquadri per l'esempio HorizontalGradient sopra:

TileMode	Output
TileMode.Repeated: il bordo viene ripetuto dall'ultimo colore al primo.
TileMode.Mirror: il bordo viene specchiato dall'ultimo colore al primo.
TileMode.Clamp: il bordo è fissato al colore finale. Verrà quindi applicato il colore più simile per il resto della regione.
TileMode.Decal: esegui il rendering solo fino alle dimensioni dei limiti. TileMode.Decal utilizza il nero trasparente per campionare i contenuti al di fuori dei limiti originali, mentre TileMode.Clamp campiona il colore del bordo.

TileMode funziona in modo simile per gli altri gradienti direzionali, la differenza sta nella direzione in cui si verifica la ripetizione.

Modificare le dimensioni del pennello

Se conosci le dimensioni dell'area in cui verrà disegnato il pennello, puoi impostare il riquadro endX come abbiamo visto sopra nella sezione TileMode. Se ti trovi in un DrawScope, puoi utilizzare la relativa proprietà size per ottenere le dimensioni dell'area.

Se non conosci le dimensioni dell'area di disegno (ad esempio se Brush è assegnato a Testo), puoi estendere Shader e utilizzare le dimensioni dell'area di disegno nella funzione createShader.

In questo esempio, dividi le dimensioni per 4 per ripetere il pattern 4 volte:

val listColors = listOf(Color.Yellow, Color.Red, Color.Blue)
val customBrush = remember {
    object : ShaderBrush() {
        override fun createShader(size: Size): Shader {
            return LinearGradientShader(
                colors = listColors,
                from = Offset.Zero,
                to = Offset(size.width / 4f, 0f),
                tileMode = TileMode.Mirror
            )
        }
    }
}
Box(
    modifier = Modifier
        .requiredSize(200.dp)
        .background(customBrush)
)
BrushExampleSnippets.kt

Puoi anche modificare la dimensione del pennello di qualsiasi altro gradiente, ad esempio le sfumature radiali. Se non specifichi una dimensione e un centro, il gradiente occuperà tutti i limiti di DrawScope e il centro del gradiente radiale sarà impostato per impostazione predefinita sul centro dei limiti di DrawScope. Di conseguenza, il centro del gradiente radiale viene visualizzato come il centro della dimensione più piccola (larghezza o altezza):

Box(
    modifier = Modifier
        .fillMaxSize()
        .background(
            Brush.radialGradient(
                listOf(Color(0xFF2be4dc), Color(0xFF243484))
            )
        )
)
BrushExampleSnippets.kt

Quando la sfumatura radiale viene modificata per impostare la dimensione del raggio sulla dimensione massima, puoi vedere che produce un effetto di sfumatura radiale migliore:

val largeRadialGradient = object : ShaderBrush() {
    override fun createShader(size: Size): Shader {
        val biggerDimension = maxOf(size.height, size.width)
        return RadialGradientShader(
            colors = listOf(Color(0xFF2be4dc), Color(0xFF243484)),
            center = size.center,
            radius = biggerDimension / 2f,
            colorStops = listOf(0f, 0.95f)
        )
    }
}

Box(
    modifier = Modifier
        .fillMaxSize()
        .background(largeRadialGradient)
)
BrushExampleSnippets.kt

Vale la pena notare che le dimensioni effettive passate alla creazione dello shader vengono determinate dal punto in cui viene richiamato. Per impostazione predefinita, Brush rialloca internamente il proprio Shader se le dimensioni sono diverse dall'ultima creazione di Brush o se un oggetto stato utilizzato per la creazione dell'shader è cambiato.

Il seguente codice crea lo streamr tre volte diverse con dimensioni diverse, man mano che cambiano le dimensioni dell'area di disegno:

val colorStops = arrayOf(
    0.0f to Color.Yellow,
    0.2f to Color.Red,
    1f to Color.Blue
)
val brush = Brush.horizontalGradient(colorStops = colorStops)
Box(
    modifier = Modifier
        .requiredSize(200.dp)
        .drawBehind {
            drawRect(brush = brush) // will allocate a shader to occupy the 200 x 200 dp drawing area
            inset(10f) {
      /* Will allocate a shader to occupy the 180 x 180 dp drawing area as the
       inset scope reduces the drawing  area by 10 pixels on the left, top, right,
      bottom sides */
                drawRect(brush = brush)
                inset(5f) {
        /* will allocate a shader to occupy the 170 x 170 dp drawing area as the
         inset scope reduces the  drawing area by 5 pixels on the left, top,
         right, bottom sides */
                    drawRect(brush = brush)
                }
            }
        }
)
BrushExampleSnippets.kt

Utilizzare un'immagine come pennello

Per utilizzare un ImageBitmap come Brush, carica l'immagine come ImageBitmap e crea un pennello ImageShader:

val imageBrush =
    ShaderBrush(ImageShader(ImageBitmap.imageResource(id = R.drawable.dog)))

// Use ImageShader Brush with background
Box(
    modifier = Modifier
        .requiredSize(200.dp)
        .background(imageBrush)
)

// Use ImageShader Brush with TextStyle
Text(
    text = "Hello Android!",
    style = TextStyle(
        brush = imageBrush,
        fontWeight = FontWeight.ExtraBold,
        fontSize = 36.sp
    )
)

// Use ImageShader Brush with DrawScope#drawCircle()
Canvas(onDraw = {
    drawCircle(imageBrush)
}, modifier = Modifier.size(200.dp))
BrushExampleSnippets.kt

Il pennello viene applicato a diversi tipi di disegno: uno sfondo, il testo e la tela. L'output è il seguente:

Tieni presente che ora il testo viene visualizzato anche utilizzando ImageBitmap per dipingere i pixel del testo.

Esempio avanzato: pennello personalizzato

Spazzola RuntimeShader AGSL

AGSL offre un sottoinsieme di funzionalità degli shader GLSL. Gli Shader possono essere scritti in AGSL e utilizzati con un pennello in Compose.

Per creare un pennello Shader, devi prima definire lo Shader come stringa Shader AGSL:

@Language("AGSL")
val CUSTOM_SHADER = """
    uniform float2 resolution;
    layout(color) uniform half4 color;
    layout(color) uniform half4 color2;

    half4 main(in float2 fragCoord) {
        float2 uv = fragCoord/resolution.xy;

        float mixValue = distance(uv, vec2(0, 1));
        return mix(color, color2, mixValue);
    }
""".trimIndent()
BrushExampleSnippets.kt

Lo shader riportato sopra prende due colori di input, calcola la distanza dalla parte inferiore sinistra (vec2(0, 1)) dell'area di disegno ed esegue un mix tra i due colori in base alla distanza. Viene prodotto un effetto gradiente.

Quindi, crea il pennello shader e imposta le uniformi per resolution, le dimensioni dell'area di disegno e color e color2 da utilizzare come input per il tuo gradiente personalizzato:

val Coral = Color(0xFFF3A397)
val LightYellow = Color(0xFFF8EE94)

@RequiresApi(Build.VERSION_CODES.TIRAMISU)
@Composable
@Preview
fun ShaderBrushExample() {
    Box(
        modifier = Modifier
            .drawWithCache {
                val shader = RuntimeShader(CUSTOM_SHADER)
                val shaderBrush = ShaderBrush(shader)
                shader.setFloatUniform("resolution", size.width, size.height)
                onDrawBehind {
                    shader.setColorUniform(
                        "color",
                        android.graphics.Color.valueOf(
                            LightYellow.red, LightYellow.green,
                            LightYellow
                                .blue,
                            LightYellow.alpha
                        )
                    )
                    shader.setColorUniform(
                        "color2",
                        android.graphics.Color.valueOf(
                            Coral.red,
                            Coral.green,
                            Coral.blue,
                            Coral.alpha
                        )
                    )
                    drawRect(shaderBrush)
                }
            }
            .fillMaxWidth()
            .height(200.dp)
    )
}
BrushExampleSnippets.kt

Se esegui questo comando, sullo schermo viene visualizzato quanto segue:

Vale la pena notare che con gli shader puoi fare molto di più che creare gradienti, poiché si tratta di calcoli matematici. Per ulteriori informazioni su AGSL, consulta la documentazione AGSL.

Risorse aggiuntive

Per altri esempi di utilizzo del Pennello in Compose, consulta le seguenti risorse:

• Animazione della colorazione del testo con il pennello in Scrivi 🖌️
• Grafica e layout personalizzati in Compose - Android Dev Summit 2022
• Esempio di JetLagged - Pennello RuntimeShader