Color

fun hsl(
    hue: Float,
    saturation: Float,
    lightness: Float,
    alpha: Float = 1.0f,
    colorSpace: Rgb = ColorSpaces.Srgb
): Color

Return a Color from hue, saturation, and lightness (HSL representation).

fun hsv(
    hue: Float,
    saturation: Float,
    value: Float,
    alpha: Float = 1.0f,
    colorSpace: Rgb = ColorSpaces.Srgb
): Color

Return a Color from hue, saturation, and value (HSV representation).

val Unspecified: Color

Because Color is an inline class, this represents an unset value without having to box the Color. It will be treated as Transparent when drawn. A Color can compare with Unspecified for equality or use isUnspecified to check for the unset value or isSpecified for any color that isn't Unspecified.

fun convert(colorSpace: ColorSpace): Color

Converts this color from its color space to the specified color space. The conversion is done using the default rendering intent as specified by ColorSpace.connect.

fun copy(
    alpha: Float = this.alpha,
    red: Float = this.red,
    green: Float = this.green,
    blue: Float = this.blue
): Color

Copies the existing color, changing only the provided values. The ColorSpace of the returned Color is the same as this colorSpace.

open fun toString(): String

Returns a string representation of the object. This method returns a string equal to the value of:

"Color($r, $g, $b, $a, ${colorSpace.name})"

For instance, the string representation of opaque black in the sRGB color space is equal to the following value:

Color(0.0, 0.0, 0.0, 1.0, sRGB IEC61966-2.1)

val alpha: Float

Returns the value of the alpha component in the range [0..1].

val blue: Float

Returns the value of the blue component in the range defined by this color's color space (see ColorSpace.getMinValue and ColorSpace.getMaxValue).

If this color's color model is not RGB, calling this is the third component of the ColorSpace.

val colorSpace: ColorSpace

Returns this color's color space.

val green: Float

Returns the value of the green component in the range defined by this color's color space (see ColorSpace.getMinValue and ColorSpace.getMaxValue).

If this color's color model is not RGB, calling this is the second component of the ColorSpace.

val red: Float

Returns the value of the red component in the range defined by this color's color space (see ColorSpace.getMinValue and ColorSpace.getMaxValue).

If this color's color model is not RGB, calling this is the first component of the ColorSpace.

fun Color.toColorLong(): @ColorLong Long

Converts the Color to a 64-bit ColorLong value that can be used by Android's framework. Color.value isn't fully compatible with Android's 64-bit ColorLong values as some color spaces differ, so this method handles the conversion. Color spaces that are not supported by the current Android API level will safely fallback to the ColorSpaces.Srgb color space.

fun Color.compositeOver(background: Color): Color

Composites this color on top of background using the Porter-Duff 'source over' mode.

Both this and background must not be pre-multiplied, and the resulting color will also not be pre-multiplied.

The ColorSpace of the result is always the ColorSpace of background.

fun Color.luminance(): Float

Returns the relative luminance of this color.

Based on the formula for relative luminance defined in WCAG 2.0, W3C Recommendation 11 December 2008.

inline fun Color.takeOrElse(block: () -> Color): Color

If this color isSpecified then this is returned, otherwise block is executed and its result is returned.

fun Color.toArgb(): @ColorInt Int

Converts this color to an ARGB color int. A color int is always in the sRGB color space. This implies a color space conversion is applied if needed.

val Color.isSpecified: Boolean

false when this is Color.Unspecified.

val Color.isUnspecified: Boolean

true when this is Color.Unspecified.

val Color.rc: RemoteColor

Extension property to convert a Color to a RemoteColor.