Palette.Builder

extends Object

java.lang.Object
↳	android.support.v7.graphics.Palette.Builder

Class Overview

Builder class for generating Palette instances.

Summary

Public Constructors
	Palette.Builder(Bitmap bitmap) Construct a new `Palette.Builder` using a source `Bitmap`
	Palette.Builder(List<Palette.Swatch> swatches) Construct a new `Palette.Builder` using a list of `Palette.Swatch` instances.

Public Methods
Palette.Builder	addFilter(Palette.Filter filter) Add a filter to be able to have fine grained controlled over the colors which are allowed in the resulting palette.
Palette.Builder	clearFilters() Clear all added filters.
Palette	generate() Generate and return the `Palette` synchronously.
AsyncTask<Bitmap, Void, Palette>	generate(Palette.PaletteAsyncListener listener) Generate the `Palette` asynchronously.
Palette.Builder	maximumColorCount(int colors) Set the maximum number of colors to use in the quantization step when using a `Bitmap` as the source.
Palette.Builder	resizeBitmapSize(int maxDimension) Set the resize value when using a `Bitmap` as the source.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public Palette.Builder (Bitmap bitmap)

Construct a new Palette.Builder using a source Bitmap

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

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

Public Methods

public Palette.Builder addFilter (Palette.Filter filter)

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

Parameters

filter	filter to add.

public Palette.Builder clearFilters ()

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

public Palette generate ()

Generate and return the Palette synchronously.

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

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

public Palette.Builder resizeBitmapSize (int maxDimension)

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 it's largest dimension matches maxDimension. 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.

Results

Interfaces

Classes