# BrushPaint.ColorFunction

Artifact: [androidx.ink:ink-brush](https://developer.android.com/jetpack/androidx/releases/ink) [View Source](https://cs.android.com/search?q=file:androidx/ink/brush/BrushPaint.kt+class:androidx.ink.brush.BrushPaint.ColorFunction) Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

*** ** * ** ***

Common/AllAndroid/JVMNative/C/iOS
- Cmn

  ```
  abstract class BrushPaint.ColorFunction
  ```
Known direct subclasses [BrushPaint.ColorFunction.OpacityMultiplier](https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction.OpacityMultiplier), [BrushPaint.ColorFunction.ReplaceColor](https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction.ReplaceColor)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction.OpacityMultiplier` | A `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` that scales the color opacity by a specified multiplier. |
| `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction.ReplaceColor` | A `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` that ignores the input color and replaces it with the specified color. |

*** ** * ** ***

A `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` defines a mapping over colors.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction.OpacityMultiplier : https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` A `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` that scales the color opacity by a specified multiplier. |
| `class https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction.ReplaceColor : https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` A `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` that ignores the input color and replaces it with the specified color. |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/ink/brush/Version` | `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction#calculateMinimumRequiredVersion()()` Returns the minimum required `https://developer.android.com/reference/kotlin/androidx/ink/brush/Version` for this `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction`. | Cmn |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction#transformColorIntArgb(kotlin.Int)(colorIntArgb: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Transforms the input color into a new color. | Cmn |

## Public functions

### calculateMinimumRequiredVersion

Cmn Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

```
fun calculateMinimumRequiredVersion(): Version
```

Returns the minimum required `https://developer.android.com/reference/kotlin/androidx/ink/brush/Version` for this `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction`.

By default, decoding a `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushFamily` containing a `https://developer.android.com/reference/kotlin/androidx/ink/brush/BrushPaint.ColorFunction` with a minimum required version higher than `https://developer.android.com/reference/kotlin/androidx/ink/brush/Version#MAX_SUPPORTED()` will fail.

### transformColorIntArgb

Cmn Added in [1.1.0-alpha11](https://developer.android.com/jetpack/androidx/releases/ink#1.1.0-alpha11)

```
fun transformColorIntArgb(colorIntArgb: @ColorInt Int): @ColorInt Int
```

Transforms the input color into a new color.