Palette.Builder

Builder(bitmap: Bitmap)

Construct a new Builder using a source Bitmap

Builder(swatches: (Mutable)List<Palette.Swatch!>)

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

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.

You can retrieve the result via getSwatchForTarget.

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.

fun generate(listener: Palette.PaletteAsyncListener): AsyncTask<Bitmap!, Void!, Palette!>

Generate the Palette asynchronously. The provided listener's onGenerated method will be called with the palette when generated.

fun maximumColorCount(colors: Int): Palette.Builder

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

Good values for depend on the source image type. For landscapes, good values are in the range 10-16. For images which are largely made up of people's faces then this value should be increased to ~24.

fun resizeBitmapArea(area: Int): Palette.Builder

Set the resize value when using a android.graphics.Bitmap 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.

This value has a large effect on the processing time. The larger the resized image is, the greater time it will take to generate the palette. The smaller the image is, the more detail is lost in the resulting image and thus less precision for color selection.

fun resizeBitmapSize(maxDimension: Int): Palette.Builder

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

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

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

This only works when the original input is a Bitmap.