Remote Compose Storybook Русский GitHub

RemoteBrush · Image brush

A bitmap as a brush, with each RemoteTileMode.

RemoteBrush · Image brush: the document drawn by the Remote Compose player
Open the live, interactive demo →

Change its controls, read the remote document it produces and the diff after every change.

What it is

Colour gradients — straight, circular or sweeping — used to fill shapes.

Good for

  • Gradient backgrounds and buttons
  • Colourful progress indicators

Code

The story's source with androidx.compose.remote imports. CI compiles every snippet on this site against AndroidX.

import androidx.compose.remote.creation.compose.layout.RemoteCanvas
import androidx.compose.remote.creation.compose.layout.RemoteComposable
import androidx.compose.remote.creation.compose.layout.RemoteOffset
import androidx.compose.remote.creation.compose.modifier.RemoteModifier
import androidx.compose.remote.creation.compose.modifier.size
import androidx.compose.remote.creation.compose.shaders.RemoteBrush
import androidx.compose.remote.creation.compose.shaders.image
import androidx.compose.remote.creation.compose.state.RemoteImageBitmap
import androidx.compose.remote.creation.compose.state.RemotePaint
import androidx.compose.remote.creation.compose.state.RemoteTileMode
import androidx.compose.remote.creation.compose.state.rdp
import androidx.compose.remote.creation.compose.state.rf
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.graphics.Canvas
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.ImageBitmap
import androidx.compose.ui.graphics.Paint

@Composable
@RemoteComposable
fun CanvasImageBrush(tileMode: RemoteTileMode) {
    val tile = remember {
        val bitmap = ImageBitmap(40, 40)
        Canvas(bitmap).apply {
            drawRect(0f, 0f, 40f, 40f, Paint().apply { color = Color(0xFFFFF3E0) })
            drawCircle(Offset(10f, 10f), 9f, Paint().apply { color = Color(0xFFFB8C00) })
        }
        RemoteImageBitmap(bitmap)
    }
    RemoteCanvas(modifier = RemoteModifier.size(280.rdp, 180.rdp)) {
        // An image brush fills a shape with a bitmap; the tile mode decides what happens past its
        // edges.
        val brush = RemoteBrush.image(tile, tileModeX = tileMode, tileModeY = tileMode)
        val paint = RemotePaint()
        with(brush) { applyTo(paint, size) }
        drawRoundRect(paint, size = size, cornerRadius = RemoteOffset(24f.rf, 24f.rf))
    }
}

API

creation.compose.shaders.RemoteBrush

class RemoteBrush
  void applyTo(RemoteStateScope, RemotePaint paint, RemoteSize size)
  RemoteBrush.Companion Companion

creation.compose.shaders.linearGradient

RemoteShaderBrush linearGradient(RemoteBrush.Companion, List<RemoteColor> colors, optional RemoteOffset? start, optional RemoteOffset? end, optional RemoteTileMode tileMode)
RemoteShaderBrush linearGradient(RemoteBrush.Companion, Pair<RemoteFloat,RemoteColor>... colorStops, optional RemoteOffset? start, optional RemoteOffset? end, optional RemoteTileMode tileMode)

creation.compose.shaders.radialGradient

RemoteShaderBrush radialGradient(RemoteBrush.Companion, List<RemoteColor> colors, optional RemoteOffset? center, optional RemoteFloat? radius, optional RemoteTileMode tileMode)
RemoteShaderBrush radialGradient(RemoteBrush.Companion, Pair<RemoteFloat,RemoteColor>... colorStops, optional RemoteOffset? center, optional RemoteFloat? radius, optional RemoteTileMode tileMode)

creation.compose.shaders.sweepGradient

RemoteShaderBrush sweepGradient(RemoteBrush.Companion, List<? extends RemoteColor> colors, optional RemoteOffset? center)
RemoteShaderBrush sweepGradient(RemoteBrush.Companion, Pair<? extends RemoteFloat,? extends RemoteColor>[] colorStops, optional RemoteOffset? center)

creation.compose.shaders.image

RemoteShaderBrush image(RemoteBrush.Companion, RemoteImageBitmap image, optional RemoteTileMode tileModeX, optional RemoteTileMode tileModeY, optional RemoteContentScale contentScale)

Reference

Other stories of this component

More in Canvas