Rgb

Kotlin |Java

open class Rgb : ColorSpace

kotlin.Any
↳	android.graphics.ColorSpace
	↳	android.graphics.ColorSpace.Rgb

An RGB color space is an additive color space using the RGB color model (a color is therefore represented by a tuple of 3 numbers).

A specific RGB color space is defined by the following properties:

Three chromaticities of the red, green and blue primaries, which define the gamut of the color space.
A white point chromaticity that defines the stimulus to which color space values are normalized (also just called "white").
An opto-electronic transfer function, also called opto-electronic conversion function or often, and approximately, gamma function.
An electro-optical transfer function, also called electo-optical conversion function or often, and approximately, gamma function.
A range of valid RGB values (most commonly $[0..1]$).

The most commonly used RGB color space is sRGB.

Primaries and white point chromaticities

In this implementation, the chromaticity of the primaries and the white point of an RGB color space is defined in the CIE xyY color space. This color space separates the chromaticity of a color, the x and y components, and its luminance, the Y component. Since the primaries and the white point have full brightness, the Y component is assumed to be 1 and only the x and y components are needed to encode them.

For convenience, this implementation also allows to define the primaries and white point in the CIE XYZ space. The tristimulus XYZ values are internally converted to xyY.

sRGB primaries and white point

Transfer functions

A transfer function is a color component conversion function, defined as a single variable, monotonic mathematical function. It is applied to each individual component of a color. They are used to perform the mapping between linear tristimulus values and non-linear electronic signal value.

The opto-electronic transfer function (OETF or OECF) encodes tristimulus values in a scene to a non-linear electronic signal value. An OETF is often expressed as a power function with an exponent between 0.38 and 0.55 (the reciprocal of 1.8 to 2.6).

The electro-optical transfer function (EOTF or EOCF) decodes a non-linear electronic signal value to a tristimulus value at the display. An EOTF is often expressed as a power function with an exponent between 1.8 and 2.6.

Transfer functions are used as a compression scheme. For instance, linear sRGB values would normally require 11 to 12 bits of precision to store all values that can be perceived by the human eye. When encoding sRGB values using the appropriate OETF (see sRGB for an exact mathematical description of that OETF), the values can be compressed to only 8 bits precision.

When manipulating RGB values, particularly sRGB values, it is safe to assume that these values have been encoded with the appropriate OETF (unless noted otherwise). Encoded values are often said to be in "gamma space". They are therefore defined in a non-linear space. This in turns means that any linear operation applied to these values is going to yield mathematically incorrect results (any linear interpolation such as gradient generation for instance, most image processing functions such as blurs, etc.).

To properly process encoded RGB values you must first apply the EOTF to decode the value into linear space. After processing, the RGB value must be encoded back to non-linear ("gamma") space. Here is a formal description of the process, where $f$ is the processing function to apply:

$$RGB_{out} = OETF(f(EOTF(RGB_{in})))$$

If the transfer functions of the color space can be expressed as an ICC parametric curve as defined in ICC.1:2004-10, the numeric parameters can be retrieved by calling getTransferParameters(). This can be useful to match color spaces for instance.

Some RGB color spaces, such as Named#ACES and scRGB, are said to be linear because their transfer functions are the identity function: $f(x) = x$. If the source and/or destination are known to be linear, it is not necessary to invoke the transfer functions.

Range

Most RGB color spaces allow RGB values in the range $[0..1]$. There are however a few RGB color spaces that allow much larger ranges. For instance, scRGB is used to manipulate the range $[-0.5..7.5]$ while ACES can be used throughout the range $[-65504, 65504]$.

Extended sRGB and its large range

Converting between RGB color spaces

Conversion between two color spaces is achieved by using an intermediate color space called the profile connection space (PCS). The PCS used by this implementation is CIE XYZ. The conversion operation is defined as such:

$$RGB_{out} = OETF(T_{dst}^{-1} \cdot T_{src} \cdot EOTF(RGB_{in}))$$

Where $T_{src}$ is the RGB to XYZ transform of the source color space and $T_{dst}^{-1}$ the XYZ to RGB transform of the destination color space.

Many RGB color spaces commonly used with electronic devices use the standard illuminant D65. Care must be take however when converting between two RGB color spaces if their white points do not match. This can be achieved by either calling adapt(android.graphics.ColorSpace,float[]) to adapt one or both color spaces to a single common white point. This can be achieved automatically by calling ColorSpace#connect(ColorSpace, ColorSpace), which also handles non-RGB color spaces.

To learn more about the white point adaptation process, refer to the documentation of Adaptation.

Summary

Nested classes
open	`TransferParameters` Defines the parameters for the ICC parametric curve type 4, as defined in ICC.

Inherited constants

From class ColorSpace

Int

MAX_ID

The maximum ID value a color space can have.

Int

MIN_ID

The minimum ID value a color space can have.

Public constructors
`Rgb(name: String, toXYZ: FloatArray, oetf: DoubleUnaryOperator, eotf: DoubleUnaryOperator)` Creates a new RGB color space using a 3x3 column-major transform matrix.
`Rgb(name: String, primaries: FloatArray, whitePoint: FloatArray, oetf: DoubleUnaryOperator, eotf: DoubleUnaryOperator, min: Float, max: Float)` Creates a new RGB color space using a specified set of primaries and a specified white point.
`Rgb(name: String, toXYZ: FloatArray, function: ColorSpace.Rgb.TransferParameters)` Creates a new RGB color space using a 3x3 column-major transform matrix.
`Rgb(name: String, primaries: FloatArray, whitePoint: FloatArray, function: ColorSpace.Rgb.TransferParameters)` Creates a new RGB color space using a specified set of primaries and a specified white point.
`Rgb(name: String, toXYZ: FloatArray, gamma: Double)` Creates a new RGB color space using a 3x3 column-major transform matrix.
`Rgb(name: String, primaries: FloatArray, whitePoint: FloatArray, gamma: Double)` Creates a new RGB color space using a specified set of primaries and a specified white point.

Public methods
open Boolean	`equals(other: Any?)`
open FloatArray	`fromLinear(r: Float, g: Float, b: Float)` Encodes an RGB value from linear space to this color space's "gamma space".
open FloatArray	`fromLinear(v: FloatArray)` Encodes an RGB value from linear space to this color space's "gamma space".
open FloatArray	`fromXyz(v: FloatArray)` Converts tristimulus values from the CIE XYZ space to this color space's color model.
open DoubleUnaryOperator	`getEotf()` Returns the electro-optical transfer function (EOTF) of this color space.
open FloatArray	`getInverseTransform(inverseTransform: FloatArray)` Copies the inverse transform of this color space in specified array.
open FloatArray	`getInverseTransform()` Returns the inverse transform of this color space as a new array.
open Float	`getMaxValue(component: Int)`
open Float	`getMinValue(component: Int)`
open DoubleUnaryOperator	`getOetf()` Returns the opto-electronic transfer function (OETF) of this color space.
open FloatArray	`getPrimaries(primaries: FloatArray)` Copies the primaries of this color space in specified array.
open FloatArray	`getPrimaries()` Returns the primaries of this color space as a new array of 6 floats.
open ColorSpace.Rgb.TransferParameters?	`getTransferParameters()` Returns the parameters used by the `electro-optical` and `opto-electronic` transfer functions.
open FloatArray	`getTransform(transform: FloatArray)` Copies the transform of this color space in specified array.
open FloatArray	`getTransform()` Returns the transform of this color space as a new array.
open FloatArray	`getWhitePoint(whitePoint: FloatArray)` Copies the non-adapted CIE xyY white point of this color space in specified array.
open FloatArray	`getWhitePoint()` Returns the non-adapted CIE xyY white point of this color space as a new array of 2 floats.
open Int	`hashCode()`
open Boolean	`isSrgb()`
open Boolean	`isWideGamut()`
open FloatArray	`toLinear(r: Float, g: Float, b: Float)` Decodes an RGB value to linear space.
open FloatArray	`toLinear(v: FloatArray)` Decodes an RGB value to linear space.
open FloatArray	`toXyz(v: FloatArray)` Converts a color value from this color space's model to tristimulus CIE XYZ values.

Inherited functions

From class ColorSpace

`ColorSpace`	`adapt(colorSpace: ColorSpace, whitePoint: FloatArray)` Performs the chromatic adaptation of a color space from its native white point to the specified white point. The chromatic adaptation is performed using the `Adaptation#BRADFORD` matrix. The color space returned by this method always has an ID of `MIN_ID`.
`ColorSpace`	`adapt(colorSpace: ColorSpace, whitePoint: FloatArray, adaptation: ColorSpace.Adaptation)` 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`. The color space returned by this method always has an ID of `MIN_ID`.
`FloatArray`	`cctToXyz(cct: Int)` Computes the chromaticity coordinates of a specified correlated color temperature (CCT) on the Planckian locus. The specified CCT must be greater than 0. A meaningful CCT range is [1667, 25000]. The transform is computed using the methods in Kang et al., Design of Advanced Color - Temperature Control System for HDTV Applications, Journal of Korean Physical Society 41, 865-871 (2002).
`FloatArray`	`chromaticAdaptation(adaptation: ColorSpace.Adaptation, srcWhitePoint: FloatArray, dstWhitePoint: FloatArray)` Computes the chromatic adaptation transform from the specified source white point to the specified destination white point. The transform is computed using the von Kries method, described in more details in the documentation of `Adaptation`. The `Adaptation` enum provides different matrices that can be used to perform the adaptation.
`ColorSpace.Connector`	`connect(source: ColorSpace, destination: ColorSpace)` 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. Colors are mapped from the source color space to the destination color space using the `perceptual` render intent.
`ColorSpace.Connector`	`connect(source: ColorSpace, destination: ColorSpace, intent: ColorSpace.RenderIntent)` 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.
`ColorSpace.Connector`	`connect(source: ColorSpace)` Connects the specified color spaces to sRGB. If the source color space does not use CIE XYZ D65 as its profile connection space, the two spaces are chromatically adapted to use the CIE standard illuminant `D50` as needed. If the source is the sRGB color space, an optimized connector is returned to avoid unnecessary computations and loss of precision. Colors are mapped from the source color space to the destination color space using the `perceptual` render intent.
`ColorSpace.Connector`	`connect(source: ColorSpace, intent: ColorSpace.RenderIntent)` Connects the specified color spaces to sRGB. If the source color space does not use CIE XYZ D65 as its profile connection space, the two spaces are chromatically adapted to use the CIE standard illuminant `D50` as needed. If the source is the sRGB color space, an optimized connector is returned to avoid unnecessary computations and loss of precision.
`FloatArray`	`fromXyz(x: Float, y: Float, z: Float)` Converts tristimulus values from the CIE XYZ space to this color space's color model.
`ColorSpace`	`get(name: ColorSpace.Named)` Returns an instance of `ColorSpace` identified by the specified name. The list of names provided in the `Named` enum gives access to a variety of common RGB color spaces. This method always returns the same instance for a given name. This method is thread-safe. Note that in the Android W release and later, this can return the SRGB ColorSpace if the `ColorSpace.Named` parameter is not enabled in the corresponding release.
`Int`	`getComponentCount()` Returns the number of components that form a color value according to this color space's color model.
`Int`	`getDataSpace()` Retrieve the `DataSpace` value from a `ColorSpace` object. If this `ColorSpace` object has no matching `dataSpace` value, `DATASPACE_UNKNOWN` will return.
`ColorSpace?`	`getFromDataSpace(dataSpace: Int)` Create a `ColorSpace` object using a `DataSpace` value. This function maps from a dataspace to a `Named` ColorSpace. If no `Named` ColorSpace object matching the `dataSpace` value can be created, `null` will return.
`Int`	`getId()` Returns the ID of this color space. Positive IDs match the color spaces enumerated in `Named`. A negative ID indicates a color space created by calling one of the public constructors.
`ColorSpace.Model`	`getModel()` Return the color model of this color space.
`String`	`getName()` 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.
`ColorSpace?`	`match(toXYZD50: FloatArray, function: ColorSpace.Rgb.TransferParameters)` Returns a `Named` instance of `ColorSpace` that matches the specified RGB to CIE XYZ transform and transfer functions. If no instance can be found, this method returns null. The color transform matrix is assumed to target the CIE XYZ space a `D50` standard illuminant.
`String`	`toString()` Returns a string representation of the object. This method returns a string equal to the value of: getName() + "(id=" + getId() + ", model=" + getModel() + ")" For instance, the string representation of the `sRGB` color space is equal to the following value: sRGB IEC61966-2.1 (id=0, model=RGB)
`FloatArray`	`toXyz(r: Float, g: Float, b: Float)` 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 `Model#LAB` for instance). With color spaces using fewer or more components, use `toXyz(float[])` instead .

Inherited properties

From class ColorSpace

`FloatArray!`	`ILLUMINANT_A` Standard CIE 1931 2° illuminant A, encoded in xyY. This illuminant has a color temperature of 2856K.
`FloatArray!`	`ILLUMINANT_B` Standard CIE 1931 2° illuminant B, encoded in xyY. This illuminant has a color temperature of 4874K.
`FloatArray!`	`ILLUMINANT_C` Standard CIE 1931 2° illuminant C, encoded in xyY. This illuminant has a color temperature of 6774K.
`FloatArray!`	`ILLUMINANT_D50` Standard CIE 1931 2° illuminant D50, encoded in xyY. This illuminant has a color temperature of 5003K. This illuminant is used by the profile connection space in ICC profiles.
`FloatArray!`	`ILLUMINANT_D55` Standard CIE 1931 2° illuminant D55, encoded in xyY. This illuminant has a color temperature of 5503K.
`FloatArray!`	`ILLUMINANT_D60` Standard CIE 1931 2° illuminant D60, encoded in xyY. This illuminant has a color temperature of 6004K.
`FloatArray!`	`ILLUMINANT_D65` Standard CIE 1931 2° illuminant D65, encoded in xyY. This illuminant has a color temperature of 6504K. This illuminant is commonly used in RGB color spaces such as sRGB, BT.709, etc.
`FloatArray!`	`ILLUMINANT_D75` Standard CIE 1931 2° illuminant D75, encoded in xyY. This illuminant has a color temperature of 7504K.
`FloatArray!`	`ILLUMINANT_E` Standard CIE 1931 2° illuminant E, encoded in xyY. This illuminant has a color temperature of 5454K.

Parameters
`name`	String: Name of the color space, cannot be null, its length must be >= 1
`toXYZ`	FloatArray: 3x3 column-major transform matrix from RGB to the profile connection space CIE XYZ as an array of 9 floats, cannot be null
`oetf`	DoubleUnaryOperator: Opto-electronic transfer function, cannot be null
`eotf`	DoubleUnaryOperator: Electro-optical transfer function, cannot be null

Parameters
`name`	String: Name of the color space, cannot be null, its length must be >= 1
`primaries`	FloatArray: RGB primaries as an array of 6 (xy) or 9 (XYZ) floats This value cannot be `null`.
`whitePoint`	FloatArray: Reference white as an array of 2 (xy) or 3 (XYZ) floats This value cannot be `null`.
`oetf`	DoubleUnaryOperator: Opto-electronic transfer function, cannot be null
`eotf`	DoubleUnaryOperator: Electro-optical transfer function, cannot be null
`min`	Float: The minimum valid value in this color space's RGB range
`max`	Float: The maximum valid value in this color space's RGB range

Parameters
`r`	Float: The red component to encode from linear space
`g`	Float: The green component to encode from linear space
`b`	Float: The blue component to encode from linear space

Parameters
`r`	Float: The red component to decode to linear space
`g`	Float: The green component to decode to linear space
`b`	Float: The blue component to decode to linear space

Rgb

Primaries and white point chromaticities

Transfer functions

Range

Converting between RGB color spaces

Summary

Public constructors

Rgb

Rgb

Rgb

Rgb

Rgb

Rgb

Public methods

equals

fromLinear

fromLinear

fromXyz

getEotf

getInverseTransform

getInverseTransform

getMaxValue

getMinValue

getOetf

getPrimaries

getPrimaries

getTransferParameters

getTransform

getTransform

getWhitePoint

getWhitePoint

hashCode

isSrgb

isWideGamut

toLinear

toLinear

toXyz