Palette.Builder

public Builder(@NonNull Bitmap bitmap)

Construct a new Builder using a source Bitmap

public Builder(@NonNull List<Palette.Swatch> swatches)

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

public @NonNull 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.

public @NonNull Palette.Builder addTarget(@NonNull Target target)

Add a target profile to be generated in the palette.

You can retrieve the result via getSwatchForTarget.

public @NonNull Palette.Builder clearFilters()

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

public @NonNull Palette.Builder clearRegion()

Clear any previously region set via setRegion.

public @NonNull Palette.Builder clearTargets()

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

public @NonNull Palette generate()

Generate and return the Palette synchronously.

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

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

public @NonNull Palette.Builder maximumColorCount(int colors)

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.

public @NonNull Palette.Builder resizeBitmapArea(int area)

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.

public @NonNull Palette.Builder resizeBitmapSize(int maxDimension)

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.

public @NonNull Palette.Builder setRegion(@Px int left, @Px int top, @Px int right, @Px 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.