ColorFilter
@Immutable class ColorFilter
| kotlin.Any | |
| ↳ | androidx.compose.ui.graphics.ColorFilter |
Effect used to modify the color of each pixel drawn on a Paint that it is installed on
Summary
| Companion functions | |
|---|---|
| ColorFilter |
colorMatrix(colorMatrix: ColorMatrix)Create a ColorFilter that transforms colors through a 4x5 color matrix. |
| ColorFilter |
Create a ColorFilter that can be used to simulate simple lighting effects. |
| ColorFilter |
Creates a color filter that applies the blend mode given as the second argument. |
| Extension functions | ||
|---|---|---|
From androidx.compose.ui.graphics
|
||
Companion functions
colorMatrix
@Stable fun colorMatrix(colorMatrix: ColorMatrix): ColorFilter
Create a ColorFilter that transforms colors through a 4x5 color matrix. This filter can be used to change the saturation of pixels, convert from YUV to RGB, etc.
| Parameters | |
|---|---|
| colorMatrix: ColorMatrix | ColorMatrix used to transform pixel values when drawn |
lighting
@Stable fun lighting(
multiply: Color,
add: Color
): ColorFilter
Create a ColorFilter that can be used to simulate simple lighting effects. A lighting ColorFilter is defined by two parameters, one used to multiply the source color and one used to add to the source color
| Parameters | |
|---|---|
| multiply: Color | Color that will be added to the source color when the color filter is applied |
| add: Color | Color used to multiply the source color when the color filter is applied. |
tint
@Stable fun tint(
color: Color,
blendMode: BlendMode = BlendMode.SrcIn
): ColorFilter
Creates a color filter that applies the blend mode given as the second argument. The source color is the one given as the first argument, and the destination color is the one from the layer being composited.
The output of this filter is then composited into the background according to the Paint.blendMode, using the output of this filter as the source and the background as the destination.
| Parameters | |
|---|---|
| color: Color | Color used to blend source content |
| blendMode: BlendMode = BlendMode.SrcIn | BlendMode used when compositing the tint color to the destination |