colormath/com.github.ajalt.colormath.model/RGB

RGB

data class RGB : Color

The RGB color model, using the sRGB color space by default.

There are several ways to construct sRGB instances. All of the following are equivalent:

RGB(0.2, 0.4, 0.6)
SRGB(0.2, 0.4, 0.6)
RGB.from255(51, 102, 153)
RGB("#369")
RGB("#336699")

You also can construct instances of other RGB color spaces:

import com.github.ajalt.colormath.model.RGBColorSpaces.LINEAR_SRGB
LinearSRGB(0.1, 0.2, 0.3)

Component	Description	Range
r	red	`[0, 1]`
g	green	`[0, 1]`
b	blue	`[0, 1]`

Types

Companion

object Companion : RGBColorSpace

Default constructors for the RGB color model: the SRGB 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

alphaInt

val alphaInt: Int

The alpha channel scaled to 0, 255. If the alpha is undefined, 255 will be returned.

val b: Float

blueInt

val blueInt: Int

The blue channel scaled to 0, 255. HDR colors may exceed this range.

val g: Float

greenInt

val greenInt: Int

The green channel scaled to 0, 255.

val r: Float

redInt

val redInt: Int

The red channel scaled to 0, 255.

space

open override val space: RGBColorSpace

The color space describing this color

Functions

clamp

open override fun clamp(): RGB

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

convertTo

fun convertTo(space: RGBColorSpace): RGB

Convert this color to another RGB color space.

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