colormath/com.github.ajalt.colormath/HueColor

HueColor

interface HueColor : Color

Inheritors

Properties

abstract val alpha: Float

The opacity of this color, in the range [0, 1], or NaN if the opacity is unspecified

abstract val h: Float

The hue, as degrees in the range [0, 360)

abstract val space: ColorSpace<*>

The color space describing this color

Functions

open fun clamp(): Color

Return a copy of this color with all component values in their reference range.

fun <T : Color> Color.convertTo(space: ColorSpace<T>): T

Convert this color to a given space.

differenceCIE2000

fun Color.differenceCIE2000(other: Color): Float

Calculate the difference ΔEab between this color and other using the CIE 2000 recommendation.

differenceCIE76

fun Color.differenceCIE76(other: Color): Float

Calculate the difference ΔEab between this color and other using the CIE 1976 recommendation.

differenceCIE94

fun Color.differenceCIE94(other: Color, textiles: Boolean = false): Float

Calculate the difference ΔEab between this color and other using the CIE 1994 recommendation.

fun Color.differenceCMC(other: Color, l: Float = 2.0f, c: Float = 1.0f): Float

Calculate the difference ΔEcmc between this color and other using the Colour Measurement Committee recommendation.

fun Color.differenceEz(other: Color): Float

Calculate the difference ΔEz between this color and other using the JzAzBz color space.

firstWithContrast

fun Color.firstWithContrast(vararg colors: Color, targetContrast: Float): Color

Return the first color with a contrast ratio exceeding the targetContrast against this color. If no color meets the target, black or white will be returned, whichever has the most contrast.

firstWithContrastOrNull

fun Color.firstWithContrastOrNull(vararg colors: Color, targetContrast: Float): Color?

Return the first color with a contrast ratio greater or equal to the targetContrast against this color, or null if no color meets the target.

formatCssString

fun Color.formatCssString(hueUnit: AngleUnit = AngleUnit.AUTO, renderAlpha: RenderCondition = RenderCondition.AUTO, unitsPercent: Boolean = false, alphaPercent: Boolean = false, legacyName: Boolean = false, legacyFormat: Boolean = false, customColorSpaces: Map<String, ColorSpace<*>> = emptyMap()): String

Render this color in CSS functional notation.

formatCssStringOrNull

fun Color.formatCssStringOrNull(hueUnit: AngleUnit = AngleUnit.AUTO, renderAlpha: RenderCondition = RenderCondition.AUTO, unitsPercent: Boolean = false, alphaPercent: Boolean = false, legacyName: Boolean = false, legacyFormat: Boolean = false, customColorSpaces: Map<String, ColorSpace<*>> = emptyMap()): String?

Render this color in CSS functional notation if this color space is defined in the CSS standard, or return null if this color is in another color space.

fun HueColor.hueAsGrad(): Float

Convert this color's hue to gradians (360° == 400 gradians)

fun HueColor.hueAsRad(): Float

Convert this color's hue to radians (360° == 2π radians)

fun HueColor.hueAsTurns(): Float

Convert this color's hue to turns (360° == 1 turn)

fun HueColor.hueOr(whenNaN: Number): Float

If this color's hue is NaN (meaning the hue is undefined), return whenNaN. Otherwise, return the hue unchanged.

fun Color.isInSRGBGamut(): Boolean

Return true if all channels of this color, when converted to sRGB, lie in the range [0, 1]

mostContrasting

fun Color.mostContrasting(vararg colors: Color): Color

Return the color with the highest contrast ratio against this color.

open fun toAnsi16(): Ansi16

Convert this color to a 16-color ANSI code

open fun toAnsi256(): Ansi256

Convert this color to a 256-color ANSI code

abstract fun toArray(): FloatArray

Create a FloatArray containing all components of this color, with the alpha as the last component

open fun toCMYK(): CMYK

Convert this color to device-independent CMYK

open fun toHPLuv(): HPLuv

Convert this color to HPLuv

open fun toHSL(): HSL

Convert this color to HSL

open fun toHSLuv(): HSLuv

Convert this color to HSLuv

open fun toHSV(): HSV

Convert this color to HSV

open fun toHWB(): HWB

Convert this color to HWB

open fun toICtCp(): ICtCp

Convert this color to ICtCp

open fun toJzAzBz(): JzAzBz

Convert this color to JzAzBz

open fun toJzCzHz(): JzCzHz

Convert this color to JzCzHz

open fun toLAB(): LAB

Convert this color to CIE LAB

open fun toLCHab(): LCHab

Convert this color to CIE LCh(ab)

open fun toLCHuv(): LCHuv

Convert this color to CIE LCh(uv)

open fun toLUV(): LUV

Convert this color to CIE LUV

open fun toOklab(): Oklab

Convert this color to Oklab

open fun toOklch(): Oklch

Convert this color to Oklch

abstract fun toSRGB(): RGB

Convert this color to sRGB

open fun toXYZ(): XYZ

Convert this color to CIE XYZ

wcagContrastRatio

fun Color.wcagContrastRatio(other: Color): Float

Calculate the contrast ration of this color with other according to the Web Content Accessibility Guidelines

fun Color.wcagLuminance(): Float

Calculate the relative luminance of this color according to the Web Content Accessibility Guidelines