WallpaperColors

public final class WallpaperColors
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.WallpaperColors


Provides information about the colors of a wallpaper.

Exposes the 3 most visually representative colors of a wallpaper. Can be either WallpaperColors#getPrimaryColor(), WallpaperColors#getSecondaryColor() or WallpaperColors#getTertiaryColor().

Summary

Constants

int HINT_SUPPORTS_DARK_TEXT

Specifies that dark text is preferred over the current wallpaper for best presentation.

int HINT_SUPPORTS_DARK_THEME

Specifies that dark theme is preferred over the current wallpaper for best presentation.

Inherited constants

Fields

public static final Creator<WallpaperColors> CREATOR

Public constructors

WallpaperColors(Parcel parcel)
WallpaperColors(Color primaryColor, Color secondaryColor, Color tertiaryColor)

Constructs a new object from three colors.

WallpaperColors(Color primaryColor, Color secondaryColor, Color tertiaryColor, int colorHints)

Constructs a new object from three colors, where hints can be specified.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

static WallpaperColors fromBitmap(Bitmap bitmap)

Constructs WallpaperColors from a bitmap.

static WallpaperColors fromDrawable(Drawable drawable)

Constructs WallpaperColors from a drawable.

int getColorHints()

Returns the color hints for this instance.

Color getPrimaryColor()

Gets the most visually representative color of the wallpaper.

Color getSecondaryColor()

Gets the second most preeminent color of the wallpaper.

Color getTertiaryColor()

Gets the third most preeminent color of the wallpaper.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

HINT_SUPPORTS_DARK_TEXT

Added in API level 31
public static final int HINT_SUPPORTS_DARK_TEXT

Specifies that dark text is preferred over the current wallpaper for best presentation.

eg. A launcher may set its text color to black if this flag is specified.

Constant Value: 1 (0x00000001)

HINT_SUPPORTS_DARK_THEME

Added in API level 31
public static final int HINT_SUPPORTS_DARK_THEME

Specifies that dark theme is preferred over the current wallpaper for best presentation.

eg. A launcher may set its drawer color to black if this flag is specified.

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 27
public static final Creator<WallpaperColors> CREATOR

Public constructors

WallpaperColors

Added in API level 27
public WallpaperColors (Parcel parcel)

Parameters
parcel Parcel

WallpaperColors

Added in API level 27
public WallpaperColors (Color primaryColor, 
                Color secondaryColor, 
                Color tertiaryColor)

Constructs a new object from three colors.

Parameters
primaryColor Color: Primary color. This value cannot be null.

secondaryColor Color: Secondary color. This value may be null.

tertiaryColor Color: Tertiary color. This value may be null.

WallpaperColors

Added in API level 27
public WallpaperColors (Color primaryColor, 
                Color secondaryColor, 
                Color tertiaryColor, 
                int colorHints)

Constructs a new object from three colors, where hints can be specified.

Parameters
primaryColor Color: Primary color. This value cannot be null.

secondaryColor Color: Secondary color. This value may be null.

tertiaryColor Color: Tertiary color. This value may be null.

colorHints int: A combination of color hints. Value is either 0 or a combination of HINT_SUPPORTS_DARK_TEXT, and HINT_SUPPORTS_DARK_THEME

Public methods

describeContents

Added in API level 27
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 27
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

fromBitmap

Added in API level 27
public static WallpaperColors fromBitmap (Bitmap bitmap)

Constructs WallpaperColors from a bitmap.

Main colors will be extracted from the bitmap.

Parameters
bitmap Bitmap: Source where to extract from. This value cannot be null.

Returns
WallpaperColors

fromDrawable

Added in API level 27
public static WallpaperColors fromDrawable (Drawable drawable)

Constructs WallpaperColors from a drawable.

Main colors will be extracted from the drawable.

Parameters
drawable Drawable: Source where to extract from.

Returns
WallpaperColors

getColorHints

Added in API level 31
public int getColorHints ()

Returns the color hints for this instance.

Returns
int The color hints. Value is either 0 or a combination of HINT_SUPPORTS_DARK_TEXT, and HINT_SUPPORTS_DARK_THEME

getPrimaryColor

Added in API level 27
public Color getPrimaryColor ()

Gets the most visually representative color of the wallpaper. "Visually representative" means easily noticeable in the image, probably happening at high frequency. fromBitmap

Returns
Color A color. This value cannot be null.

getSecondaryColor

Added in API level 27
public Color getSecondaryColor ()

Gets the second most preeminent color of the wallpaper. Can be null.

Returns
Color A color, may be null.

getTertiaryColor

Added in API level 27
public Color getTertiaryColor ()

Gets the third most preeminent color of the wallpaper. Can be null.

Returns
Color A color, may be null.

hashCode

Added in API level 27
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

Added in API level 27
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 27
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES