belongs to Maven artifact com.android.support:palette-v7:28.0.0-alpha1
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
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 |
interface | Palette.Filter A Filter provides a mechanism for exercising fine-grained control over which colors are valid within a resulting |
interface | Palette.PaletteAsyncListener Listener to be used with |
class | Palette.Swatch Represents a color swatch generated from an image's palette. |
Public methods | |
|---|---|
static Palette | from(List<Palette.Swatch> swatches) Generate a |
static Palette.Builder | from(Bitmap bitmap) Start generating a |
static Palette | generate(Bitmap bitmap, int numColors) This method was deprecated in API level 22.1.0. Use |
static Palette | generate(Bitmap bitmap) This method was deprecated in API level 22.1.0. Use |
static AsyncTask<Bitmap, Void, Palette> | generateAsync(Bitmap bitmap, int numColors, Palette.PaletteAsyncListener listener) This method was deprecated in API level 22.1.0. Use |
static AsyncTask<Bitmap, Void, Palette> | generateAsync(Bitmap bitmap, Palette.PaletteAsyncListener listener) This method was deprecated in API level 22.1.0. Use |
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 | getDominantColor(int defaultColor) Returns the color of the dominant swatch from the palette, as an RGB packed int. |
Palette.Swatch | getDominantSwatch() Returns the dominant 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 |
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 | |
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 was deprecated in API level 22.1.0.
Use Palette.Builder to generate the Palette.
| Parameters | |
|---|---|
bitmap | Bitmap |
numColors | int |
| Returns | |
|---|---|
Palette | |
generate
Palette generate (Bitmap bitmap)
This method was deprecated in API level 22.1.0.
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 was deprecated in API level 22.1.0.
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 was deprecated in API level 22.1.0.
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
Palette.Swatch getDarkMutedSwatch ()
Returns a muted and dark swatch from the palette. Might be null.
| Returns | |
|---|---|
Palette.Swatch | |
See also:
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
Palette.Swatch getDarkVibrantSwatch ()
Returns a dark and vibrant swatch from the palette. Might be null.
| Returns | |
|---|---|
Palette.Swatch | |
See also:
getDominantColor
int getDominantColor (int defaultColor)
Returns the color of the dominant swatch from the palette, as an RGB packed int.
| Parameters | |
|---|---|
defaultColor | int: value to return if the swatch isn't available |
| Returns | |
|---|---|
int | |
See also:
getDominantSwatch
Palette.Swatch getDominantSwatch ()
Returns the dominant swatch from the palette.
The dominant swatch is defined as the swatch with the greatest population (frequency) within the palette.
| Returns | |
|---|---|
Palette.Swatch | |
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
Palette.Swatch getLightMutedSwatch ()
Returns a muted and light swatch from the palette. Might be null.
| Returns | |
|---|---|
Palette.Swatch | |
See also:
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
Palette.Swatch getLightVibrantSwatch ()
Returns a light and vibrant swatch from the palette. Might be null.
| Returns | |
|---|---|
Palette.Swatch | |
See also:
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
Palette.Swatch getMutedSwatch ()
Returns a muted swatch from the palette. Might be null.
| Returns | |
|---|---|
Palette.Swatch | |
See also:
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
Palette.Swatch getVibrantSwatch ()
Returns the most vibrant swatch in the palette. Might be null.
| Returns | |
|---|---|
Palette.Swatch | |
See also:
Interfaces
Classes
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.