ColorUtils

java-static fun HSLToColor(hsl: FloatArray): @ColorInt Int

Convert HSL (hue-saturation-lightness) components to a RGB color.

• hsl[0] is Hue [0, 360)
• hsl[1] is Saturation [0, 1]
• hsl[2] is Lightness [0, 1]

java-static fun LABToColor(
    l: @FloatRange(from = 0.0, to = 100) Double,
    a: @FloatRange(from = "-128", to = 127) Double,
    b: @FloatRange(from = "-128", to = 127) Double
): @ColorInt Int

Converts a color from CIE Lab to its RGB representation.

java-static fun LABToXYZ(
    l: @FloatRange(from = 0.0, to = 100) Double,
    a: @FloatRange(from = "-128", to = 127) Double,
    b: @FloatRange(from = "-128", to = 127) Double,
    outXyz: DoubleArray
): Unit

Converts a color from CIE Lab to CIE XYZ representation.

The resulting XYZ representation will use the D65 illuminant and the CIE 2° Standard Observer (1931).

• outXyz[0] is X [0, 95.047)
• outXyz[1] is Y [0, 100)
• outXyz[2] is Z [0, 108.883)

java-static fun M3HCTToColor(
    hue: @FloatRange(from = 0.0, to = 360, toInclusive = false) Float,
    chroma: @FloatRange(from = 0.0, to = Double.POSITIVE_INFINITY, toInclusive = false) Float,
    tone: @FloatRange(from = 0.0, to = 100) Float
): @ColorInt Int

Generate an ARGB color using M3HCT color parameters. HCT color space is a new color space proposed in Material Design 3

java-static fun RGBToHSL(
    r: @IntRange(from = 0, to = 255) Int,
    g: @IntRange(from = 0, to = 255) Int,
    b: @IntRange(from = 0, to = 255) Int,
    outHsl: FloatArray
): Unit

Convert RGB components to HSL (hue-saturation-lightness).

• outHsl[0] is Hue [0, 360)
• outHsl[1] is Saturation [0, 1]
• outHsl[2] is Lightness [0, 1]

java-static fun RGBToLAB(
    r: @IntRange(from = 0, to = 255) Int,
    g: @IntRange(from = 0, to = 255) Int,
    b: @IntRange(from = 0, to = 255) Int,
    outLab: DoubleArray
): Unit

Convert RGB components to its CIE Lab representative components.

• outLab[0] is L [0, 100]
• outLab[1] is a [-128, 127)
• outLab[2] is b [-128, 127)

java-static fun RGBToXYZ(
    r: @IntRange(from = 0, to = 255) Int,
    g: @IntRange(from = 0, to = 255) Int,
    b: @IntRange(from = 0, to = 255) Int,
    outXyz: DoubleArray
): Unit

Convert RGB components to its CIE XYZ representative components.

The resulting XYZ representation will use the D65 illuminant and the CIE 2° Standard Observer (1931).

• outXyz[0] is X [0, 95.047)
• outXyz[1] is Y [0, 100)
• outXyz[2] is Z [0, 108.883)

java-static fun XYZToColor(
    x: @FloatRange(from = 0.0, to = 95.047) Double,
    y: @FloatRange(from = 0.0, to = 100.0) Double,
    z: @FloatRange(from = 0.0, to = 108.883) Double
): @ColorInt Int

Converts a color from CIE XYZ to its RGB representation.

This method expects the XYZ representation to use the D65 illuminant and the CIE 2° Standard Observer (1931).

java-static fun XYZToLAB(
    x: @FloatRange(from = 0.0, to = 95.047) Double,
    y: @FloatRange(from = 0.0, to = 100.0) Double,
    z: @FloatRange(from = 0.0, to = 108.883) Double,
    outLab: DoubleArray
): Unit

Converts a color from CIE XYZ to CIE Lab representation.

This method expects the XYZ representation to use the D65 illuminant and the CIE 2° Standard Observer (1931).

• outLab[0] is L [0, 100]
• outLab[1] is a [-128, 127)
• outLab[2] is b [-128, 127)

java-static fun blendARGB(
    color1: @ColorInt Int,
    color2: @ColorInt Int,
    ratio: @FloatRange(from = 0.0, to = 1.0) Float
): @ColorInt Int

Blend between two ARGB colors using the given ratio.

A blend ratio of 0.0 will result in color1, 0.5 will give an even blend, 1.0 will result in color2.

java-static fun blendHSL(
    hsl1: FloatArray,
    hsl2: FloatArray,
    ratio: @FloatRange(from = 0.0, to = 1.0) Float,
    outResult: FloatArray
): Unit

Blend between hsl1 and hsl2 using the given ratio. This will interpolate the hue using the shortest angle.

A blend ratio of 0.0 will result in hsl1, 0.5 will give an even blend, 1.0 will result in hsl2.

java-static fun blendLAB(
    lab1: DoubleArray,
    lab2: DoubleArray,
    ratio: @FloatRange(from = 0.0, to = 1.0) Double,
    outResult: DoubleArray
): Unit

Blend between two CIE-LAB colors using the given ratio.

A blend ratio of 0.0 will result in lab1, 0.5 will give an even blend, 1.0 will result in lab2.

java-static fun calculateContrast(foreground: @ColorInt Int, background: @ColorInt Int): Double

Returns the contrast ratio between foreground and background. background must be opaque.

Formula defined here.

java-static fun calculateLuminance(color: @ColorInt Int): @FloatRange(from = 0.0, to = 1.0) Double

Returns the luminance of a color as a float between 0.0 and 1.0.

Defined as the Y component in the XYZ representation of color.

java-static fun calculateMinimumAlpha(
    foreground: @ColorInt Int,
    background: @ColorInt Int,
    minContrastRatio: Float
): Int

Calculates the minimum alpha value which can be applied to foreground so that would have a contrast value of at least minContrastRatio when compared to background.

java-static fun colorToHSL(color: @ColorInt Int, outHsl: FloatArray): Unit

Convert the ARGB color to its HSL (hue-saturation-lightness) components.

• outHsl[0] is Hue [0, 360)
• outHsl[1] is Saturation [0, 1]
• outHsl[2] is Lightness [0, 1]

java-static fun colorToLAB(color: @ColorInt Int, outLab: DoubleArray): Unit

Convert the ARGB color to its CIE Lab representative components.

java-static fun colorToM3HCT(color: @ColorInt Int, outM3HCT: @Size(value = 3) FloatArray): Unit

Generate a M3HCT color from an ARGB color. HCT color space is a new color space proposed in Material Design 3

java-static fun colorToXYZ(color: @ColorInt Int, outXyz: DoubleArray): Unit

Convert the ARGB color to its CIE XYZ representative components.

The resulting XYZ representation will use the D65 illuminant and the CIE 2° Standard Observer (1931).

• outXyz[0] is X [0, 95.047)
• outXyz[1] is Y [0, 100)
• outXyz[2] is Z [0, 108.883)

@RequiresApi(value = 26)
java-static fun compositeColors(foreground: Color, background: Color): Color

Composites two translucent colors together. More specifically, adds two colors using the source over blending mode. The colors must not be pre-multiplied and the result is a non pre-multiplied color.

If the two colors have different color spaces, the foreground color is converted to the color space of the background color.

The following example creates a purple color by blending opaque blue with semi-translucent red:

Color purple = ColorUtils.compositeColors(
        Color.valueOf(1f, 0f, 0f, 0.5f),
        Color.valueOf(0f, 0f, 1f));

java-static fun compositeColors(foreground: @ColorInt Int, background: @ColorInt Int): Int

Composite two potentially translucent colors over each other and returns the result.

java-static fun distanceEuclidean(labX: DoubleArray, labY: DoubleArray): Double

Returns the euclidean distance between two LAB colors.

java-static fun setAlphaComponent(color: @ColorInt Int, alpha: @IntRange(from = 0, to = 255) Int): @ColorInt Int

Set the alpha component of color to be alpha.