colormath/com.github.ajalt.colormath.model/XYZ

XYZ

data class XYZ : Color

The CIEXYZ color model

XYZ is calculated relative to a given whitePoint, which defaults to Illuminant.D65.

Component	Range
x	`[0, 1]`
y	`[0, 1]`
z	`[0, 1]`

Types

Companion

object Companion : XYZColorSpace

Default constructors for the XYZ color model: the XYZ65 space.

Properties

alpha

open override val alpha: Float

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

space

open override val space: XYZColorSpace

The color space describing this color

val x: Float

val y: Float

val z: Float

Functions

adaptTo

fun adaptTo(space: XYZColorSpace): XYZ

fun adaptTo(space: XYZColorSpace, transformationMatrix: FloatArray): XYZ

fun adaptTo(space: XYZColorSpace, transformationMatrix: FloatArray, inverseTransformationMatrix: FloatArray): XYZ

Apply chromatic adaptation to adapt this color to the white point in the given space.

clamp

open override fun clamp(): XYZ

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