Palette.Builder

Palette.Builder

Palette.Builder (Bitmap bitmap)

Construct a new Palette.Builder using a source Bitmap

Palette.Builder

Palette.Builder (List<Palette.Swatch> swatches)

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

addFilter

Palette.Builder addFilter (Palette.Filter filter)

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

addTarget

Palette.Builder addTarget (Target target)

Add a target profile to be generated in the palette.

You can retrieve the result via getSwatchForTarget(Target).

clearFilters

Palette.Builder clearFilters ()

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

clearRegion

Palette.Builder clearRegion ()

Clear any previously region set via setRegion(int, int, int, int).

clearTargets

Palette.Builder clearTargets ()

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

generate

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

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

generate

Palette generate ()

Generate and return the Palette synchronously.

maximumColorCount

Palette.Builder maximumColorCount (int colors)

Set the maximum number of colors to use in the quantization step when using a 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.

resizeBitmapArea

Palette.Builder resizeBitmapArea (int area)

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

resizeBitmapSize

Palette.Builder resizeBitmapSize (int maxDimension)

This method was deprecated in API level 24.1.0.
Using resizeBitmapArea(int) is preferred since it can handle abnormal aspect ratios more gracefully.

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

setRegion

Palette.Builder setRegion (int left, 
                int top, 
                int right, 
                int bottom)

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

This only works when the original input is a Bitmap.