openrndr-color/org.openrndr.color

Package-level declarations

Types

AlgebraicColor

interface AlgebraicColor<T : AlgebraicColor<T>> : LinearType<T>

Allows performing select algebraic operations on colors of this kind.

ChromaColor

interface ChromaColor<T>

ColorHSLa

@Serializable

@JvmRecord

data class ColorHSLa(val h: Double, val s: Double, val l: Double, val alpha: Double = 1.0) : ColorModel<ColorHSLa> , ShadableColor<ColorHSLa> , HueShiftableColor<ColorHSLa> , SaturatableColor<ColorHSLa> , AlgebraicColor<ColorHSLa>

The HSL color space.

ColorHSVa

@Serializable

@JvmRecord

data class ColorHSVa(val h: Double, val s: Double, val v: Double, val alpha: Double = 1.0) : ColorModel<ColorHSVa> , ShadableColor<ColorHSVa> , HueShiftableColor<ColorHSVa> , SaturatableColor<ColorHSVa> , AlgebraicColor<ColorHSVa>

The HSV color space.

ColorLABa

@Serializable

@JvmRecord

data class ColorLABa(val l: Double, val a: Double, val b: Double, val alpha: Double = 1.0, val ref: ColorXYZa = ColorXYZa.NEUTRAL) : ColorModel<ColorLABa> , ReferenceWhitePoint, ShadableColor<ColorLABa> , LuminosityColor<ColorLABa> , AlgebraicColor<ColorLABa>

The CIELAB color space, more commonly known as Lab.

ColorLCHABa

@Serializable

data class ColorLCHABa(val l: Double, val c: Double, val h: Double, val alpha: Double = 1.0, val ref: ColorXYZa = ColorXYZa.NEUTRAL) : ColorModel<ColorLCHABa> , ReferenceWhitePoint, ShadableColor<ColorLCHABa> , ChromaColor<ColorLCHABa> , HueShiftableColor<ColorLCHABa> , LuminosityColor<ColorLCHABa> , AlgebraicColor<ColorLCHABa>

The CIELChAB color space is the cylindrical representation of the CIELAB color space.

ColorLCHUVa

@Serializable

data class ColorLCHUVa(val l: Double, val c: Double, val h: Double, val alpha: Double = 1.0, val ref: ColorXYZa = ColorXYZa.NEUTRAL) : ColorModel<ColorLCHUVa> , ReferenceWhitePoint, ShadableColor<ColorLCHUVa> , ChromaColor<ColorLCHUVa> , HueShiftableColor<ColorLCHUVa> , LuminosityColor<ColorLCHUVa> , AlgebraicColor<ColorLCHUVa>

The CIELChUV color space is the cylindrical representation of the CIELUV color space.

ColorLSHABa

@Serializable

data class ColorLSHABa(val l: Double, val s: Double, val h: Double, val alpha: Double = 1.0, val ref: ColorXYZa = ColorXYZa.NEUTRAL) : ColorModel<ColorLSHABa> , ReferenceWhitePoint, HueShiftableColor<ColorLSHABa> , SaturatableColor<ColorLSHABa> , LuminosityColor<ColorLSHABa> , AlgebraicColor<ColorLSHABa>

Based on ColorLCHABa, but instead tries to use a normalized chroma.

ColorLSHUVa

@Serializable

data class ColorLSHUVa(val l: Double, val s: Double, val h: Double, val alpha: Double = 1.0, val ref: ColorXYZa = ColorXYZa.NEUTRAL) : ColorModel<ColorLSHUVa> , ReferenceWhitePoint, HueShiftableColor<ColorLSHUVa> , SaturatableColor<ColorLSHUVa> , LuminosityColor<ColorLSHUVa> , AlgebraicColor<ColorLSHUVa>

Based on ColorLCHUVa, but instead tries to use a normalized chroma.

ColorLUVa

@Serializable

data class ColorLUVa(val l: Double, val u: Double, val v: Double, val alpha: Double = 1.0, val ref: ColorXYZa) : ColorModel<ColorLUVa> , ReferenceWhitePoint, ShadableColor<ColorLUVa> , LuminosityColor<ColorLUVa> , AlgebraicColor<ColorLUVa>

The CIELUV color space

ColorModel

interface ColorModel<T : ColorModel<T>> : OpacifiableColor<T> , ConvertibleToColorRGBa, CastableToVector4

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>

A generic RGB color space capable of representing both the linear and the sRGB color spaces.

ColorXSLa

@Serializable

data class ColorXSLa(val x: Double, val s: Double, val l: Double, val alpha: Double = 1.0) : ColorModel<ColorXSLa> , ShadableColor<ColorXSLa> , HueShiftableColor<ColorXSLa> , SaturatableColor<ColorXSLa> , AlgebraicColor<ColorXSLa>

Practically identical to ColorHSLa, but for mapping colors to classical painter's scheme of complementary colors.

ColorXSVa

@Serializable

data class ColorXSVa(val x: Double, val s: Double, val v: Double, val alpha: Double = 1.0) : ColorModel<ColorXSVa> , ShadableColor<ColorXSVa> , HueShiftableColor<ColorXSVa> , SaturatableColor<ColorXSVa> , AlgebraicColor<ColorXSVa>

Practically identical to ColorHSVa, but for mapping colors to classical painter's scheme of complementary colors.

ColorXYZa

@Serializable

data class ColorXYZa(val x: Double, val y: Double, val z: Double, val alpha: Double = 1.0) : ColorModel<ColorXYZa> , AlgebraicColor<ColorXYZa>

The CIE XYZ color space.

ColorYxya

@Serializable

@JvmRecord

data class ColorYxya(val yy: Double, val x: Double, val y: Double, val alpha: Double = 1.0) : ColorModel<ColorYxya>

The Yxy color space, also known as the xyY color space.

ConvertibleToColorRGBa

interface ConvertibleToColorRGBa

HueShiftableColor

interface HueShiftableColor<T>

Linearity

@Serializable

enum Linearity : Enum<Linearity>

LuminosityColor

interface LuminosityColor<T>

OpacifiableColor

interface OpacifiableColor<T>

ReferenceWhitePoint

interface ReferenceWhitePoint

SaturatableColor

interface SaturatableColor<T>

ShadableColor

interface ShadableColor<T>

Functions

findHue

fun findHue(id: Int): Hue?

hsl

fun hsl(h: Double, s: Double, l: Double, a: Double = 1.0): ColorHSLa

hsv

fun hsv(h: Double, s: Double, v: Double, a: Double = 1.0): ColorHSVa

mix

fun mix(left: ColorHSLa, right: ColorHSLa, x: Double): ColorHSLa

Weighted mix between two colors in the HSL color space.

fun mix(left: ColorHSVa, right: ColorHSVa, x: Double): ColorHSVa

Weighted mix between two colors in the HSVa color space.

fun mix(left: ColorLCHABa, right: ColorLCHABa, x: Double): ColorLCHABa

Weighted mix between two colors in the LChAB color space.

fun mix(left: ColorLCHUVa, right: ColorLCHUVa, x: Double): ColorLCHUVa

Weighted mix between two colors in the LChUV color space.

fun mix(left: ColorRGBa, right: ColorRGBa, x: Double): ColorRGBa

Weighted mix between two colors in the generic RGB color space.

fun mix(left: ColorXSLa, right: ColorXSLa, x: Double): ColorXSLa

Weighted mix between two colors in the XSL color space.

fun mix(left: ColorXSVa, right: ColorXSVa, x: Double): ColorXSVa

Weighted mix between two colors in the XSV color space.

fun mix(a: ColorYxya, b: ColorYxya, x: Double): ColorYxya

rgb

fun rgb(hex: String): ColorRGBa

Shorthand for calling ColorRGBa.fromHex. Creates a ColorRGBa from a hex string.

fun rgb(gray: Double, a: Double = 1.0): ColorRGBa

Shorthand for calling ColorRGBa.

fun rgb(r: Double, g: Double, b: Double, a: Double = 1.0): ColorRGBa

Shorthand for calling ColorRGBa. Specify only one value to obtain a shade of gray.

times

operator fun Matrix55.times(color: ColorRGBa): ColorRGBa

Properties

hues

val hues: List<Hue>