openrndr-color/org.openrndr.color/ColorRGBa

ColorRGBa

@Serializable

data class ColorRGBa(val r: Double, val g: Double, val b: Double, val alpha: Double = 1.0, val linearity: Linearity = Linearity.LINEAR) : ColorModel<ColorRGBa> , ShadableColor<ColorRGBa> , AlgebraicColor<ColorRGBa> (source)

Represents a color in the RGBA color space. Each component, includingC, green, blue, and alpha (opacity), is represented as a Double in the range [0.0, 1.0]. The color can be defined in linear, sRGB or Display P3 space, determined by the linearity property.

This class provides a wide variety of utility functions for manipulating and converting colors, such as shading, opacity adjustment, and format transformations. It also includes methods for parsing colors from hexadecimal notation or vectors.

Constructors

ColorRGBa

constructor(r: Double, g: Double, b: Double, alpha: Double = 1.0, linearity: Linearity = Linearity.LINEAR)

Types

Companion

object Companion

Component

enum Component : Enum<ColorRGBa.Component>

Properties

alpha

open override val alpha: Double

Alpha (opacity) component of the color as a value between 0.0 and 1.0. Defaults to 1.0.

alphaMultiplied

val alphaMultiplied: ColorRGBa

Returns a new instance of ColorRGBa where the red, green, and blue components are multiplied by the alpha value of the original color. The alpha value and linearity remain unchanged.

val b: Double

Blue component of the color as a value between 0.0 and 1.0.

val g: Double

Green component of the color as a value between 0.0 and 1.0.

linearity

val linearity: Linearity

Indicates whether the color is defined in linear, sRGB or Display P3 space. Defaults to Linearity.LINEAR.

luminance

val luminance: Double

calculate luminance value luminance value is according to https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef

maxValue

val maxValue: Double

The maximum value over r, g, b

minValue

val minValue: Double

The minimum value over r, g, b

val r: Double

Red component of the color as a value between 0.0 and 1.0.

Functions

clip

fun clip(): ColorRGBa

Copy of the color with all of its fields clamped to [0, 1]

div

open operator override fun div(scale: Double): ColorRGBa

get

operator fun get(index: Int): Double

Retrieves the color's RGBA component value based on the specified index: index should be 0 for red, 1 for green, 2 for blue, 3 for alpha. Other index values throw an IndexOutOfBoundsException.

getContrastRatio

fun getContrastRatio(other: ColorRGBa): Double

calculate the contrast value between this color and the given color contrast value is accordingo to // see http://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef

hashCode

open override fun hashCode(): Int

minus

open operator override fun minus(right: ColorRGBa): ColorRGBa

mix

open override fun mix(other: ColorRGBa, factor: Double): ColorRGBa

opacify

open override fun opacify(factor: Double): ColorRGBa

Creates a copy of color with adjusted opacity

plus

open operator override fun plus(right: ColorRGBa): ColorRGBa

shade

open override fun shade(factor: Double): ColorRGBa

Creates a copy of color with adjusted color

times

open operator override fun times(scale: Double): ColorRGBa

toHSLa

fun toHSLa(): ColorHSLa

toHSVa

fun toHSVa(): ColorHSVa

toLABa

fun toLABa(ref: ColorXYZa = ColorXYZa.NEUTRAL): ColorLABa

toLCHABa

fun toLCHABa(ref: ColorXYZa = ColorXYZa.NEUTRAL): ColorLCHABa

toLCHUVa

fun toLCHUVa(ref: ColorXYZa = ColorXYZa.NEUTRAL): ColorLCHUVa

toLinear

fun toLinear(): ColorRGBa

Convert to linear, with the sRGB primaries. Colors outside of the sRGB gamut, such as Linearity.DISPLAY_P3 colors, have components below 0 or above 1.

toLinearity