ColorSpace

abstract fun fromXyz(v: @Size(min = 3) FloatArray): @Size(min = 3) FloatArray

Converts tristimulus values from the CIE XYZ space to this color space's color model. The resulting value is passed back in the specified array.

The specified array's length must be at least equal to to the number of color components as returned by ColorModel.componentCount, and its first 3 values must be the XYZ components to convert from.

fun fromXyz(x: Float, y: Float, z: Float): @Size(min = 3) FloatArray

Converts tristimulus values from the CIE XYZ space to this color space's color model.

abstract fun getMaxValue(component: @IntRange(from = 0, to = 3) Int): Float

Returns the maximum valid value for the specified component of this color space's color model.

abstract fun getMinValue(component: @IntRange(from = 0, to = 3) Int): Float

Returns the minimum valid value for the specified component of this color space's color model.

open fun toString(): String

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

"$name "(id=$id, model=$model)"

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

sRGB IEC61966-2.1 (id=0, model=RGB)

abstract fun toXyz(v: @Size(min = 3) FloatArray): @Size(min = 3) FloatArray

Converts a color value from this color space's model to tristimulus CIE XYZ values. If the color model of this color space is not RGB, it is assumed that the target CIE XYZ space uses a D50 standard illuminant.

The specified array's length must be at least equal to to the number of color components as returned by ColorModel.componentCount.

fun toXyz(r: Float, g: Float, b: Float): @Size(value = 3) FloatArray

Converts a color value from this color space's model to tristimulus CIE XYZ values. If the color model of this color space is not RGB, it is assumed that the target CIE XYZ space uses a D50 standard illuminant.

This method is a convenience for color spaces with a model of 3 components (RGB or ColorModel.Lab for instance). With color spaces using fewer or more components, use toXyz instead.

val componentCount: Int

Returns the number of components that form a color value according to this color space's color model.

open val isSrgb: Boolean

Indicates whether this color space is the sRGB color space or equivalent to the sRGB color space.

A color space is considered sRGB if it meets all the following conditions:

• Its color model is ColorModel.Rgb. * Its primaries are within 1e-3 of the true sRGB primaries.

• Its white point is within 1e-3 of the CIE standard illuminant D65.

• Its opto-electronic transfer function is not linear.

• Its electro-optical transfer function is not linear.

• Its transfer functions yield values within 1e-3 of ColorSpaces.Srgb.

• Its range is [0..1].

This method always returns true for ColorSpaces.Srgb.

abstract val isWideGamut: Boolean

Returns whether this color space is a wide-gamut color space. An RGB color space is wide-gamut if its gamut entirely contains the sRGB gamut and if the area of its gamut is 90% of greater than the area of the NTSC gamut.

val model: ColorModel

The color model of this color space.

val name: String

Returns the name of this color space. The name is never null and contains always at least 1 character.

Color space names are recommended to be unique but are not guaranteed to be. There is no defined format but the name usually falls in one of the following categories:

• Generic names used to identify color spaces in non-RGB color models. For instance: Generic Lab*.

• Names tied to a particular specification. For instance: sRGB IEC61966-2.1 or SMPTE ST 2065-1:2012 ACES.

• Ad-hoc names, often generated procedurally or by the user during a calibration workflow. These names often contain the make and model of the display.

Because the format of color space names is not defined, it is not recommended to programmatically identify a color space by its name alone. Names can be used as a first approximation.

It is however perfectly acceptable to display color space names to users in a UI, or in debuggers and logs. When displaying a color space name to the user, it is recommended to add extra information to avoid ambiguities: color model, a representation of the color space's gamut, white point, etc.

@RequiresApi(value = 26)
fun ColorSpace.toAndroidColorSpace(): ColorSpace

Convert the Compose ColorSpace into an Android framework android.graphics.ColorSpace

fun ColorSpace.adapt(
    whitePoint: WhitePoint,
    adaptation: Adaptation = Adaptation.Bradford
): ColorSpace

Performs the chromatic adaptation of a color space from its native white point to the specified white point. If the specified color space does not have an RGB color model, or if the color space already has the target white point, the color space is returned unmodified.

The chromatic adaptation is performed using the von Kries method described in the documentation of Adaptation.

fun ColorSpace.connect(
    destination: ColorSpace = ColorSpaces.Srgb,
    intent: RenderIntent = RenderIntent.Perceptual
): Connector

Connects two color spaces to allow conversion from the source color space to the destination color space. If the source and destination color spaces do not have the same profile connection space (CIE XYZ with the same white point), they are chromatically adapted to use the CIE standard illuminant D50 as needed.

If the source and destination are the same, an optimized connector is returned to avoid unnecessary computations and loss of precision.