Skip to main content

Class: LocalLightAirlight

The few local lights the camera can see, for effects that light the air and the room rather than the surface next to each source (plan steps 5 and 8). Drawn from the clustered layer's selection, so it inherits that selection's stability; on top, a light keeps its place against a marginally stronger challenger (hysteresis), and every change — joining, leaving, losing or regaining line of sight, the day coming up — fades. All per-frame work runs on preallocated arrays.

Constructors​

constructor​

• new LocalLightAirlight(options?): LocalLightAirlight

Parameters​

NameType
optionsPartial<LocalLightAirlightOptions>

Returns​

LocalLightAirlight

Properties​

isEnabled​

• isEnabled: boolean = true

Off for A/B captures; the set empties through its fades.


options​

• Readonly options: LocalLightAirlightOptions


uniforms​

• Readonly uniforms: Object

Shared by every material that reads the set; updated in place.

Type declaration​

NameTypeDescription
airActiveValueUniform<0>1 when any member glows in the air (the effect's early out).
countValueUniform<0>-
fillCoreScaleValueUniform<0>-
fillFloodMaskValueUniform<0>-
fillRangeScaleValueUniform<0>-
fillStrengthValueUniform<0>-
maxAddedValueUniform<0>-
membersArrayUniform<Vector4, "vec4">Per member, two vec4: position and range (xyz, range), then (rgb x intensity x fade, scattering core radius).
seenArrayUniform<Vector4, "vec4">Per member, the air glow's share: line of sight from the camera x the daylight/open-sky/submersion dimmer, in x (yzw unused). Room fill ignores it: a surface's bounce light does not depend on where the camera stands.
strengthValueUniform<0>-

Accessors​

size​

• get size(): number

Lights in the set right now, fading ones included.

Returns​

number

Methods​

update​

▸ update(input): void

Parameters​

NameType
inputAirlightInput

Returns​

void