Brush.Builder

Kotlin |Java

android
```
class Brush.Builder
```

Builder for Brush.

Use Brush.Builder to construct a Brush with default values, overriding only as needed.

Summary

Public constructors
`Builder()`	android

Public functions
`Brush`	`build()`	android
`Brush.Builder`	`setColorIntArgb(colorIntArgb: @ColorInt Int)` Sets the color using a `ColorInt`, which is in the sRGB color space by definition.	android
`Brush.Builder`	`setColorLong(colorLong: @ColorLong Long)` 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.	android
`Brush.Builder`	`setEpsilon( epsilon: @FloatRange(from = 0.0, fromInclusive = false, to = Infinity, toInclusive = false) Float )`	android
`Brush.Builder`	`setFamily(family: BrushFamily)` Sets the `BrushFamily` for this brush.	android
`Brush.Builder`	`setSize( size: @FloatRange(from = 0.0, fromInclusive = false, to = Infinity, toInclusive = false) Float )`	android

Extension functions
`Brush.Builder`	`@RequiresApi(value = 26) Brush.Builder.setAndroidColor(color: Color)` 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.	android

Public constructors

Builder

android

Added in 1.0.0-alpha01

Builder()

Public functions

build

android

Added in 1.0.0-alpha01

fun build(): Brush

setColorIntArgb

android

Added in 1.0.0-alpha01

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

android

Added in 1.0.0-alpha01

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

android

Added in 1.0.0-alpha01

fun setEpsilon(
    epsilon: @FloatRange(from = 0.0, fromInclusive = false, to = Infinity, toInclusive = false) Float
): Brush.Builder

setFamily

android

Added in 1.0.0-alpha01

fun setFamily(family: BrushFamily): Brush.Builder

Sets the BrushFamily for this brush. See StockBrushes for available BrushFamily values.

setSize

android

Added in 1.0.0-alpha01

fun setSize(
    size: @FloatRange(from = 0.0, fromInclusive = false, to = Infinity, toInclusive = false) Float
): Brush.Builder

Extension functions

setAndroidColor

android

Artifact: androidx.ink:ink-brush

View Source

@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.

Java callers should prefer toBuilderWithAndroidColor or createBrushBuilderWithAndroidColor as a more fluent API.