filament-compose/io.github.erkko68.filament.compose.scene/LinearColor

LinearColor

data class LinearColor(val r: Float, val g: Float, val b: Float)

An RGB color (linear or sRGB depending on the consuming API). Distinct from the spatial vectors so a LinearColor can't be passed as a Position. Components are r/g/b.

Deliberately not called Color: androidx.compose.ui.graphics.Color is in scope in practically every file that uses this library, and two same-named colour types with different transfer functions is a trap.

Interop with Compose UI colours goes through fromComposeColor / toComposeColor, which apply the sRGB transfer function in each direction — Compose colours are gamma-encoded, so copying their components across raw would wash the result out. Alpha is dropped; scene colours are RGB.

val tint = LinearColor.fromComposeColor(MaterialTheme.colorScheme.primary)

Constructors

LinearColor

constructor(r: Float, g: Float, b: Float)

constructor(v: Float)

Uniform value on all channels (grey).

constructor(v: Float3)

From a filament-utils Float3 (x→r, y→g, z→b), assumed already linear.

Types

Companion

object Companion

Properties

val b: Float

val g: Float

val r: Float

Functions

plus

operator fun plus(o: LinearColor): LinearColor

times

operator fun times(s: Float): LinearColor

toComposeColor

fun toComposeColor(): Color

As a gamma-encoded Compose UI colour (alpha 1), for feeding a scene colour back into Compose UI. Channels are clamped to 0..1 — over-bright values lose their headroom.

toFloat3

fun toFloat3(): Float3