androidx-palette/com.kmpalette.palette.graphics/Palette/Builder

Builder

Builder class for generating Palette instances.

Constructors

constructor(bitmap: ImageBitmap)

Construct a new Builder using a source ImageBitmap

constructor(swatches: List<Palette.Swatch>)

Construct a new Builder using a list of Swatch instances. Typically only used for testing.

Functions

fun addFilter(filter: Palette.Filter): Palette.Builder

Add a filter to be able to have fine grained control over which colors are allowed in the resulting palette.

fun addTarget(target: Target): Palette.Builder

Add a target profile to be generated in the palette.

fun clearFilters(): Palette.Builder

Clear all added filters. This includes any default filters added automatically by Palette.

fun clearRegion(): Palette.Builder

Clear any previously region set via .setRegion.

fun clearTargets(): Palette.Builder

Clear all added targets. This includes any default targets added automatically by Palette.

fun generate(): Palette

Generate and return the Palette synchronously.

maximumColorCount

fun maximumColorCount(colors: Int): Palette.Builder

Set the maximum number of colors to use in the quantization step when using a ImageBitmap as the source.

resizeBitmapArea

fun resizeBitmapArea(area: Int): Palette.Builder

Set the resize value when using a ImageBitmap as the source. If the bitmap's area is greater than the value specified, then the bitmap will be resized so that its area matches area. If the bitmap is smaller or equal, the original is used as-is.

fun setRegion(left: Int, top: Int, right: Int, bottom: Int): Palette.Builder

Set a region of the bitmap to be used exclusively when calculating the palette.