colormath/com.github.ajalt.colormath.model/RGBInt

RGBInt

value class RGBInt(val argb: UInt) : Color

A representation of RGB that packs color components into a single integer.

This is an inline value class stores the color as a packed argb integer, such as those returned from android.graphics.Color.argb or java.awt.image.BufferedImage.getRGB.

This color always uses the sRGB color space.

You can destructure this class into r, g, b, and a components: val (r, g, b, a) = RGBInt(0xaa112233u)

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

Constructors

RGBInt

constructor(r: UByte, g: UByte, b: UByte, alpha: UByte = 0xff.toUByte())

constructor(r: Int, g: Int, b: Int, alpha: Int = 255)

constructor(r: Float, g: Float, b: Float, alpha: Float = 1.0f)

Construct an RGBInt instance from Float value in the range [0, 1]

constructor(argb: UInt)

Types

Companion

object Companion : ColorSpace<RGBInt>

Default constructors for RGBInt.

Properties

val a: UByte

The alpha component scaled to [0, 255]

alpha

open override val alpha: Float

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

argb

val argb: UInt

val b: UByte

The blue component, in the range [0, 255]

blueFloat

val blueFloat: Float

The blue component as a Float in the range [0, 1]

val g: UByte

The green component, in the range [0, 255]

greenFloat

val greenFloat: Float

The green component as a Float in the range [0, 1]

val r: UByte

The red component, in the range [0, 255]

redFloat

val redFloat: Float

The red component as a Float in the range [0, 1]

space

open override val space: ColorSpace<RGBInt>

The color space describing this color

Functions

clamp

open override fun clamp(): RGBInt

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

component1

operator fun component1(): UByte

component2

operator fun component2(): UByte

component3

operator fun component3(): UByte

component4

operator fun component4(): UByte

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