handle15 methods, 4 fields
An sRGB color. Construct with datumhue.color(...); read components via .r/.g/.b/.a.
datumhue.color, datumhue.time.tween (in its callback), datumhue.color.rgb, datumhue.color.rgba, datumhue.color.hex, datumhue.color.hsl, datumhue.color.oklab, datumhue.color.oklch and 18 moredatumhue.time.tween, datumhue.material.standard, datumhue.material.unlit, datumhue.particles.emitter, datumhue.shader.new, datumhue.draw.new, datumhue.draw.text_span, datumhue.chart.scale.color and 118 more| Field | Type | Access | Description |
|---|---|---|---|
r | number | read-only | Red channel (0..1). |
g | number | read-only | Green channel (0..1). |
b | number | read-only | Blue channel (0..1). |
a | number | read-only | Alpha channel (0..1). |
Perceptual interpolation toward o by t (clamped 0..1), blended in Oklab so midtones stay vivid. Use mix for a different space.
-- Blended in Oklab: halfway from black to white is the gray that
-- looks halfway, darker than sRGB 0.5.
local black = datumhue.color("#000000")
local white = datumhue.color("#ffffff")
print(string.format("%.2f", black:lerp(white, 0.5).r)) --> 0.39
-- t is clamped to 0..1.
print(black:lerp(white, 2) == black:lerp(white, 1)) --> trueColor:mix(o: Color, t: number, space: color.MixSpace) -> ColorInterpolate toward o by t (clamped 0..1) in the given color space.
local red = datumhue.color("#ff0000")
local blue = datumhue.color("#0000ff")
print(red:mix(blue, 0.5, "srgb")) --> color(0.5, 0.0, 0.5, 1.0)
-- Around the hue wheel: halfway from red to blue is magenta.
print(red:mix(blue, 0.5, "hsl")) --> color(1.0, 0.0, 1.0, 1.0)Color:darken(amount: number) -> ColorPerceptually darken by amount (subtracted from Oklab lightness, 0..1); alpha unchanged.
-- The amount comes off Oklab lightness, which runs 0 to 1.
local leaf = datumhue.color("#a7c080")
local before = leaf:to_oklch()
local after = leaf:darken(0.2):to_oklch()
print(string.format("%.2f", before - after)) --> 0.20Color:lighten(amount: number) -> ColorPerceptually lighten by amount (added to Oklab lightness, 0..1); alpha unchanged.
Color:with_a(alpha: number) -> ColorCopy with the alpha channel replaced (clamped 0..1).
Color:with_r(r: number) -> ColorCopy with the sRGB red channel replaced (clamped 0..1).
Color:with_g(g: number) -> ColorCopy with the sRGB green channel replaced (clamped 0..1).
Color:with_b(b: number) -> ColorCopy with the sRGB blue channel replaced (clamped 0..1).
Color:rotate_hue(degrees: number) -> ColorRotate the hue by degrees — hue is the API's one angle in degrees (the CSS convention), matching color.hsl; every other angle is radians.
-- Degrees. A color made from a hex string or r, g, b turns around
-- the perceptual (Oklch) hue wheel.
local leaf = datumhue.color("#a7c080")
local _, _, hue = leaf:to_oklch()
local _, _, turned = leaf:rotate_hue(120):to_oklch()
print(string.format("%.0f", turned - hue)) --> 120Color:saturate(amount: number) -> ColorIncrease saturation by amount (clamped 0..1).
Color:desaturate(amount: number) -> ColorDecrease saturation by amount (clamped 0..1).
Color:to_array() -> number[]Components as an {r, g, b, a} array (sRGB, 0..1).
Color:to_hsl() -> number, number, numberHue (degrees), saturation and lightness as three values.
-- Hue in degrees; saturation and lightness 0 to 1.
local h, s, l = datumhue.color("#00ff00"):to_hsl()
print(h, s, l) --> 120.0 1.0 0.5Color:to_oklch() -> number, number, numberOklch lightness, chroma and hue (degrees) as three values.
-- Lightness 0 to 1, chroma, and hue in degrees.
local l, c, h = datumhue.color("#ff0000"):to_oklch()
print(string.format("%.2f %.2f %.1f", l, c, h)) --> 0.63 0.26 29.2Color:unpack() -> number, number, number, numberReturn the r, g, b and a components as four values.
local r, g, b, a = datumhue.color(1, 0.5, 0, 0.25):unpack()
print(r, g, b, a) --> 1.0 0.5 0.0 0.25