Most visited

Recently visited

Results for

Summary: Nested Classes | Methods | Inherited Methods | [Expand All]

Palette

public final class Palette
extends Object

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

A helper class to extract prominent colors from an image.

A number of colors with different profiles are extracted from the image:

Vibrant
Vibrant Dark
Vibrant Light
Muted
Muted Dark
Muted Light

These can be retrieved from the appropriate getter method.

Instances are created with a Palette.Builder which supports several options to tweak the generated Palette. See that class' documentation for more information.

Generation should always be completed on a background thread, ideally the one in which you load your image on. Palette.Builder supports both synchronous and asynchronous generation:

 // Synchronous
 Palette p = Palette.from(bitmap).generate();

 // Asynchronous
 Palette.from(bitmap).generate(new PaletteAsyncListener() {
     public void onGenerated(Palette p) {
         // Use generated instance
     }
 });

Summary

Nested classes
`class`	`Palette.Builder` Builder class for generating `Palette` instances.
`interface`	`Palette.Filter` A Filter provides a mechanism for exercising fine-grained control over which colors are valid within a resulting `Palette`.
`interface`	`Palette.PaletteAsyncListener` Listener to be used with `generateAsync(Bitmap, PaletteAsyncListener)` or `generateAsync(Bitmap, int, PaletteAsyncListener)`
`class`	`Palette.Swatch` Represents a color swatch generated from an image's palette.

Public methods
`static Palette`	`from(List<Palette.Swatch> swatches)` Generate a `Palette` from the pre-generated list of `Palette.Swatch` swatches.
`static Palette.Builder`	`from(Bitmap bitmap)` Start generating a `Palette` with the returned `Palette.Builder` instance.
`static Palette`	`generate(Bitmap bitmap, int numColors)` This method is deprecated. Use `Palette.Builder` to generate the Palette.
`static Palette`	`generate(Bitmap bitmap)` This method is deprecated. Use `Palette.Builder` to generate the Palette.
`static AsyncTask<Bitmap, Void, Palette>`	`generateAsync(Bitmap bitmap, int numColors, Palette.PaletteAsyncListener listener)` This method is deprecated. Use `Palette.Builder` to generate the Palette.
`static AsyncTask<Bitmap, Void, Palette>`	`generateAsync(Bitmap bitmap, Palette.PaletteAsyncListener listener)` This method is deprecated. Use `Palette.Builder` to generate the Palette.
`int`	`getColorForTarget(Target target, int defaultColor)` Returns the selected color for the given target from the palette as an RGB packed int.
`int`	`getDarkMutedColor(int defaultColor)` Returns a muted and dark color from the palette as an RGB packed int.
`Palette.Swatch`	`getDarkMutedSwatch()` Returns a muted and dark swatch from the palette.
`int`	`getDarkVibrantColor(int defaultColor)` Returns a dark and vibrant color from the palette as an RGB packed int.
`Palette.Swatch`	`getDarkVibrantSwatch()` Returns a dark and vibrant swatch from the palette.
`int`	`getLightMutedColor(int defaultColor)` Returns a muted and light color from the palette as an RGB packed int.
`Palette.Swatch`	`getLightMutedSwatch()` Returns a muted and light swatch from the palette.
`int`	`getLightVibrantColor(int defaultColor)` Returns a light and vibrant color from the palette as an RGB packed int.
`Palette.Swatch`	`getLightVibrantSwatch()` Returns a light and vibrant swatch from the palette.
`int`	`getMutedColor(int defaultColor)` Returns a muted color from the palette as an RGB packed int.
`Palette.Swatch`	`getMutedSwatch()` Returns a muted swatch from the palette.
`Palette.Swatch`	`getSwatchForTarget(Target target)` Returns the selected swatch for the given target from the palette, or `null` if one could not be found.
`List<Palette.Swatch>`	`getSwatches()` Returns all of the swatches which make up the palette.
`List<Target>`	`getTargets()` Returns the targets used to generate this palette.
`int`	`getVibrantColor(int defaultColor)` Returns the most vibrant color in the palette as an RGB packed int.
`Palette.Swatch`	`getVibrantSwatch()` Returns the most vibrant swatch in the palette.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

from

Palette from (List<Palette.Swatch> swatches)

Generate a Palette from the pre-generated list of Palette.Swatch swatches. This is useful for testing, or if you want to resurrect a Palette instance from a list of swatches. Will return null if the swatches is null.

Parameters
`swatches`	`List`

Returns
`Palette`

from

Palette.Builder from (Bitmap bitmap)

Start generating a Palette with the returned Palette.Builder instance.

Parameters
`bitmap`	`Bitmap`

Returns
`Palette.Builder`

generate

Palette generate (Bitmap bitmap, 
                int numColors)

This method is deprecated.
Use Palette.Builder to generate the Palette.

Parameters
`bitmap`	`Bitmap`
`numColors`	`int`

Returns
`Palette`

generate

Palette generate (Bitmap bitmap)

This method is deprecated.
Use Palette.Builder to generate the Palette.

Parameters
`bitmap`	`Bitmap`

Returns
`Palette`

generateAsync

AsyncTask<Bitmap, Void, Palette> generateAsync (Bitmap bitmap, 
                int numColors, 
                Palette.PaletteAsyncListener listener)

This method is deprecated.
Use Palette.Builder to generate the Palette.

Parameters
`bitmap`	`Bitmap`
`numColors`	`int`
`listener`	`Palette.PaletteAsyncListener`

Returns
`AsyncTask<Bitmap, Void, Palette>`

generateAsync

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

This method is deprecated.
Use Palette.Builder to generate the Palette.

Parameters
`bitmap`	`Bitmap`
`listener`	`Palette.PaletteAsyncListener`

Returns
`AsyncTask<Bitmap, Void, Palette>`

getColorForTarget

int getColorForTarget (Target target, 
                int defaultColor)

Returns the selected color for the given target from the palette as an RGB packed int.

Parameters
`target`	`Target`
`defaultColor`	`int`: value to return if the swatch isn't available

Returns
`int`

getDarkMutedColor

int getDarkMutedColor (int defaultColor)

Returns a muted and dark color from the palette as an RGB packed int.

Parameters
`defaultColor`	`int`: value to return if the swatch isn't available

Returns
`int`

See also:

getDarkMutedSwatch()

getDarkMutedSwatch

Palette.Swatch getDarkMutedSwatch ()

Returns a muted and dark swatch from the palette. Might be null.

Returns
`Palette.Swatch`

See also:

DARK_MUTED

getDarkVibrantColor

int getDarkVibrantColor (int defaultColor)

Returns a dark and vibrant color from the palette as an RGB packed int.

Parameters
`defaultColor`	`int`: value to return if the swatch isn't available

Returns
`int`

See also:

getDarkVibrantSwatch()

getDarkVibrantSwatch

Palette.Swatch getDarkVibrantSwatch ()

Returns a dark and vibrant swatch from the palette. Might be null.

Returns
`Palette.Swatch`

See also:

DARK_VIBRANT

getLightMutedColor

int getLightMutedColor (int defaultColor)

Returns a muted and light color from the palette as an RGB packed int.

Parameters
`defaultColor`	`int`: value to return if the swatch isn't available

Returns
`int`

See also:

getLightMutedSwatch()

getLightMutedSwatch

Palette.Swatch getLightMutedSwatch ()

Returns a muted and light swatch from the palette. Might be null.

Returns
`Palette.Swatch`

See also:

LIGHT_MUTED

getLightVibrantColor

int getLightVibrantColor (int defaultColor)

Returns a light and vibrant color from the palette as an RGB packed int.

Parameters
`defaultColor`	`int`: value to return if the swatch isn't available

Returns
`int`

See also:

getLightVibrantSwatch()

getLightVibrantSwatch

Palette.Swatch getLightVibrantSwatch ()

Returns a light and vibrant swatch from the palette. Might be null.

Returns
`Palette.Swatch`

See also:

LIGHT_VIBRANT

getMutedColor

int getMutedColor (int defaultColor)

Returns a muted color from the palette as an RGB packed int.

Parameters
`defaultColor`	`int`: value to return if the swatch isn't available

Returns
`int`

See also:

getMutedSwatch()

getMutedSwatch

Palette.Swatch getMutedSwatch ()

Returns a muted swatch from the palette. Might be null.

Returns
`Palette.Swatch`

See also:

MUTED

getSwatchForTarget

Palette.Swatch getSwatchForTarget (Target target)

Returns the selected swatch for the given target from the palette, or null if one could not be found.

Parameters
`target`	`Target`

Returns
`Palette.Swatch`

getSwatches

List<Palette.Swatch> getSwatches ()

Returns all of the swatches which make up the palette.

Returns
`List<Palette.Swatch>`

getTargets

List<Target> getTargets ()

Returns the targets used to generate this palette.

Returns
`List<Target>`

getVibrantColor

int getVibrantColor (int defaultColor)

Returns the most vibrant color in the palette as an RGB packed int.

Parameters
`defaultColor`	`int`: value to return if the swatch isn't available

Returns
`int`

See also:

getVibrantSwatch()

getVibrantSwatch

Palette.Swatch getVibrantSwatch ()

Returns the most vibrant swatch in the palette. Might be null.

Returns
`Palette.Swatch`

See also:

VIBRANT

Most visited

Recently visited

Results for

Palette

Summary

Nested classes

Public methods

Inherited methods

Public methods

from

from

generate

generate

generateAsync

generateAsync

getColorForTarget

getDarkMutedColor

getDarkMutedSwatch

getDarkVibrantColor

getDarkVibrantSwatch

getLightMutedColor

getLightMutedSwatch

getLightVibrantColor

getLightVibrantSwatch

getMutedColor

getMutedSwatch

getSwatchForTarget

getSwatches

getTargets

getVibrantColor

getVibrantSwatch