Brush.Builder
-
Cmn
class Brush.Builder
Builder for Brush.
For Java developers, use Brush.Builder to construct a Brush with default values, overriding only as needed. For example: Brush brush = Brush.builder().setFamily(family).setSize(size).setEpsilon(epsilon).build();
Summary
Public constructors |
|
|---|---|
Builder() |
Cmn
|
Public functions |
||
|---|---|---|
Brush |
build() |
Cmn
|
Brush.Builder |
setColorIntArgb(colorIntArgb: @ColorInt Int)Sets the color using a |
Cmn
|
Brush.Builder |
setColorLong(colorLong: @ColorLong Long)Sets the color using a |
Cmn
|
Brush.Builder |
setEpsilon(Sets the epsilon of the brush, in stroke units. |
Cmn
|
Brush.Builder |
setFamily(family: BrushFamily)Sets the |
Cmn
|
Brush.Builder |
setSize(Sets the size of the brush, in stroke units. |
Cmn
|
Extension functions |
||
|---|---|---|
Brush.Builder |
Brush.Builder.setComposeColor(color: Color)Set the color on a |
android
|
Brush.Builder |
@RequiresApi(value = 26)Set the color on a |
android
|
Public constructors
Public functions
build
fun build(): Brush
Constructs a Brush from this Builder.
| Throws | |
|---|---|
IllegalStateException |
if |
setColorIntArgb
fun setColorIntArgb(colorIntArgb: @ColorInt Int): Brush.Builder
Sets the color using a ColorInt, which is in the sRGB color space by definition. Note that the ColorInt channel order puts alpha first (in the most significant byte).
Kotlin interprets integer literals greater than 0x7fffffff as Longs, so Kotlin callers that want to specify a literal ColorInt with alpha >= 0x80 must call Long.toInt on the literal.
setColorLong
fun setColorLong(colorLong: @ColorLong Long): Brush.Builder
Sets the color using a ColorLong, which can encode several different color spaces. sRGB and Display P3 are supported; a color in any other color space will be converted to Display P3.
Some libraries (notably Jetpack UI Graphics) use ULong for ColorLongs, so the caller must call ULong.toLong on such a value before passing it to this method.
setEpsilon
fun setEpsilon(
epsilon: @FloatRange(from = 0.0, fromInclusive = false, to = Infinity, toInclusive = false) Float
): Brush.Builder
Sets the epsilon of the brush, in stroke units.
setFamily
fun setFamily(family: BrushFamily): Brush.Builder
Sets the BrushFamily for this brush. See StockBrushes for available BrushFamily values.
setSize
fun setSize(
size: @FloatRange(from = 0.0, fromInclusive = false, to = Infinity, toInclusive = false) Float
): Brush.Builder
Sets the size of the brush, in stroke units.
Extension functions
Brush.Builder.setComposeColor
fun Brush.Builder.setComposeColor(color: Color): Brush.Builder
Set the color on a Brush.Builder as an androidx.compose.ui.graphics.Color value. sRGB and Display P3 are supported; a color in any other color space will be converted to Display P3.
Brush.Builder.setAndroidColor
@RequiresApi(value = 26)
fun Brush.Builder.setAndroidColor(color: Color): Brush.Builder
Set the color on a Brush.Builder as an android.graphics.Color instance. sRGB and Display P3 are supported; a color in any other color space will be converted to Display P3.