Target

Artifact: androidx.palette:palette

View Source

Added in 1.0.0

---

Kotlin |Java

class Target

---

A class which allows custom selection of colors in a Palette's generation. Instances can be created via the Builder class.

To use the target, use the addTarget API when building a Palette.

Summary

Nested types
class Target.Builder Builder class for generating custom Target instances.

Constants
const Target!	DARK_MUTED A target which has the characteristics of a muted color which is dark in luminance.
const Target!	DARK_VIBRANT A target which has the characteristics of a vibrant color which is dark in luminance.
const Target!	LIGHT_MUTED A target which has the characteristics of a muted color which is light in luminance.
const Target!	LIGHT_VIBRANT A target which has the characteristics of a vibrant color which is light in luminance.
const Target!	MUTED A target which has the characteristics of a muted color which is neither light or dark.
const Target!	VIBRANT A target which has the characteristics of a vibrant color which is neither light or dark.

Public functions
Float	getLightnessWeight() Returns the weight of importance that this target places on a color's lightness within the image.
@FloatRange(from = 0, to = 1) Float	getMaximumLightness() The maximum lightness value for this target.
@FloatRange(from = 0, to = 1) Float	getMaximumSaturation() The maximum saturation value for this target.
@FloatRange(from = 0, to = 1) Float	getMinimumLightness() The minimum lightness value for this target.
@FloatRange(from = 0, to = 1) 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.
@FloatRange(from = 0, to = 1) Float	getTargetLightness() The target lightness value for this target.
@FloatRange(from = 0, to = 1) 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.

Constants

DARK_MUTED

Added in 1.0.0

const val DARK_MUTED: Target!

A target which has the characteristics of a muted color which is dark in luminance.

DARK_VIBRANT

Added in 1.0.0

const val DARK_VIBRANT: Target!

A target which has the characteristics of a vibrant color which is dark in luminance.

LIGHT_MUTED

Added in 1.0.0

const val LIGHT_MUTED: Target!

A target which has the characteristics of a muted color which is light in luminance.

LIGHT_VIBRANT

Added in 1.0.0

const val LIGHT_VIBRANT: Target!

A target which has the characteristics of a vibrant color which is light in luminance.

MUTED

Added in 1.0.0

const val MUTED: Target!

A target which has the characteristics of a muted color which is neither light or dark.

VIBRANT

Added in 1.0.0

const val VIBRANT: Target!

A target which has the characteristics of a vibrant color which is neither light or dark.

Public functions

getLightnessWeight

Added in 1.0.0

fun getLightnessWeight(): Float

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.

See also
getTargetLightness

getMaximumLightness

Added in 1.0.0

fun getMaximumLightness(): @FloatRange(from = 0, to = 1) Float

The maximum lightness value for this target.

getMaximumSaturation

Added in 1.0.0

fun getMaximumSaturation(): @FloatRange(from = 0, to = 1) Float

The maximum saturation value for this target.

getMinimumLightness

Added in 1.0.0

fun getMinimumLightness(): @FloatRange(from = 0, to = 1) Float

The minimum lightness value for this target.

getMinimumSaturation

Added in 1.0.0

fun getMinimumSaturation(): @FloatRange(from = 0, to = 1) Float

The minimum saturation value for this target.

getPopulationWeight

Added in 1.0.0

fun getPopulationWeight(): Float

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.

getSaturationWeight

Added in 1.0.0

fun getSaturationWeight(): Float

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.

See also
getTargetSaturation

getTargetLightness

Added in 1.0.0

fun getTargetLightness(): @FloatRange(from = 0, to = 1) Float

The target lightness value for this target.

getTargetSaturation

Added in 1.0.0

fun getTargetSaturation(): @FloatRange(from = 0, to = 1) Float

The target saturation value for this target.

isExclusive

Added in 1.0.0

fun isExclusive(): Boolean

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.