colormath/com.github.ajalt.colormath/Color

Color

interface Color

A color that can be converted to other representations.

The conversion functions can return the object they're called on if it is already in the correct format.

Note that there is not a direct conversion between every pair of representations. In those cases, the values may be converted through one or more intermediate representations.

All colors have an alpha value, which is the opacity of the color as a fraction between 0 and

The alpha will be 1 if the value is unspecified or the color model doesn't support transparency.

Inheritors

Types

Companion

object Companion

Properties

alpha

abstract val alpha: Float

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

space

abstract val space: ColorSpace<*>

The color space describing this color

Functions

clamp

open fun clamp(): Color

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

convertTo

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.

differenceCMC

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.

differenceEz

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

@JvmOverloads

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.

isInSRGBGamut

fun Color.isInSRGBGamut(): Boolean

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

mostContrasting