Target
public
final
class
Target
extends Object
java.lang.Object | |
↳ | androidx.palette.graphics.Target |
A class which allows custom selection of colors in a Palette
's generation. Instances
can be created via the Target.Builder
class.
To use the target, use the Palette.Builder.addTarget(Target)
API when building a
Palette.
Summary
Nested classes | |
---|---|
class |
Target.Builder
Builder class for generating custom |
Fields | |
---|---|
public
static
final
Target |
DARK_MUTED
A target which has the characteristics of a muted color which is dark in luminance. |
public
static
final
Target |
DARK_VIBRANT
A target which has the characteristics of a vibrant color which is dark in luminance. |
public
static
final
Target |
LIGHT_MUTED
A target which has the characteristics of a muted color which is light in luminance. |
public
static
final
Target |
LIGHT_VIBRANT
A target which has the characteristics of a vibrant color which is light in luminance. |
public
static
final
Target |
MUTED
A target which has the characteristics of a muted color which is neither light or dark. |
public
static
final
Target |
VIBRANT
A target which has the characteristics of a vibrant color which is neither light or dark. |
Public methods | |
---|---|
float
|
getLightnessWeight()
Returns the weight of importance that this target places on a color's lightness within the image. |
float
|
getMaximumLightness()
The maximum lightness value for this target. |
float
|
getMaximumSaturation()
The maximum saturation value for this target. |
float
|
getMinimumLightness()
The minimum lightness value for this target. |
float
|
getMinimumSaturation()
The minimum saturation value for this target. |
float
|
getPopulationWeight()
Returns the weight of importance that this target places on a color's population within the image. |
float
|
getSaturationWeight()
Returns the weight of importance that this target places on a color's saturation within the image. |
float
|
getTargetLightness()
The target lightness value for this target. |
float
|
getTargetSaturation()
The target saturation value for this target. |
boolean
|
isExclusive()
Returns whether any color selected for this target is exclusive for this target only. |
Inherited methods | |
---|---|
Fields
DARK_MUTED
public static final Target DARK_MUTED
A target which has the characteristics of a muted color which is dark in luminance.
DARK_VIBRANT
public static final Target DARK_VIBRANT
A target which has the characteristics of a vibrant color which is dark in luminance.
LIGHT_MUTED
public static final Target LIGHT_MUTED
A target which has the characteristics of a muted color which is light in luminance.
LIGHT_VIBRANT
public static final Target LIGHT_VIBRANT
A target which has the characteristics of a vibrant color which is light in luminance.
MUTED
public static final Target MUTED
A target which has the characteristics of a muted color which is neither light or dark.
VIBRANT
public static final Target VIBRANT
A target which has the characteristics of a vibrant color which is neither light or dark.
Public methods
getLightnessWeight
public float getLightnessWeight ()
Returns the weight of importance that this target places on a color's lightness within the image.
The larger the weight, relative to the other weights, the more important that a color being close to the target value has on selection.
Returns | |
---|---|
float |
See also:
getMaximumLightness
public float getMaximumLightness ()
The maximum lightness value for this target.
Returns | |
---|---|
float |
Value is between 0.0 and 1.0 inclusive. |
getMaximumSaturation
public float getMaximumSaturation ()
The maximum saturation value for this target.
Returns | |
---|---|
float |
Value is between 0.0 and 1.0 inclusive. |
getMinimumLightness
public float getMinimumLightness ()
The minimum lightness value for this target.
Returns | |
---|---|
float |
Value is between 0.0 and 1.0 inclusive. |
getMinimumSaturation
public float getMinimumSaturation ()
The minimum saturation value for this target.
Returns | |
---|---|
float |
Value is between 0.0 and 1.0 inclusive. |
getPopulationWeight
public float getPopulationWeight ()
Returns the weight of importance that this target places on a color's population within the image.
The larger the weight, relative to the other weights, the more important that a color's population being close to the most populous has on selection.
Returns | |
---|---|
float |
getSaturationWeight
public float getSaturationWeight ()
Returns the weight of importance that this target places on a color's saturation within the image.
The larger the weight, relative to the other weights, the more important that a color being close to the target value has on selection.
Returns | |
---|---|
float |
See also:
getTargetLightness
public float getTargetLightness ()
The target lightness value for this target.
Returns | |
---|---|
float |
Value is between 0.0 and 1.0 inclusive. |
getTargetSaturation
public float getTargetSaturation ()
The target saturation value for this target.
Returns | |
---|---|
float |
Value is between 0.0 and 1.0 inclusive. |
isExclusive
public boolean isExclusive ()
Returns whether any color selected for this target is exclusive for this target only.
If false, then the color can be selected for other targets.
Returns | |
---|---|
boolean |
Interfaces
Classes