Documentation / scene / EnvLightWrapper

Class: EnvLightWrapper

Defined in: libs/scene/src/scene/environment.ts:14

Wrapper for environmant lighting

Extends

• Disposable

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/dist/index.d.ts:6107

Returns

boolean

Inherited from

Disposable.disposed

---

strength

Get Signature

get strength(): number

Defined in: libs/scene/src/scene/environment.ts:103

Multiplier on environment lighting, in both lighting modes.

Remarks

In physical mode this is the per-frame dimmer for the IBL. The photometric intensity only reaches the image through the cached sky bake -- and a scatter sky ignores it entirely, taking its brightness from the sun -- so this is the control that always responds. 0 turns environment lighting off.

Returns

number

Set Signature

set strength(val): void

Defined in: libs/scene/src/scene/environment.ts:106

Parameters

val

number

Returns

void

---

intensity

Get Signature

get intensity(): number

Defined in: libs/scene/src/scene/environment.ts:122

Physical environment light intensity, in lux.

Remarks

Mirrors Filament's IndirectLight::Builder::intensity: the illuminance a unit (0..1) environment texture value represents. Applied when the sky is baked, so changing it re-bakes.

Only affects authored skies (skybox, image). A scatter sky derives its luminance from the sun's illuminance, so this value never enters its bake -- use strength to dim that.

Used only when the owning scene enables physical lighting; legacy uses strength. Default 30,000 lux matches Filament's default (roughly an overcast-to-hazy sky).

Returns

number

Set Signature

set intensity(val): void

Defined in: libs/scene/src/scene/environment.ts:125

Parameters

val

number

Returns

void

---

radianceScale

Get Signature

get radianceScale(): number

Defined in: libs/scene/src/scene/environment.ts:139

Physical environment light intensity in lux.

Deprecated

Renamed to intensity to match the photometric unit it carries.

Returns

number

Set Signature

set radianceScale(val): void

Defined in: libs/scene/src/scene/environment.ts:142

Parameters

val

number

Returns

void

---

specularStrength

Get Signature

get specularStrength(): number

Defined in: libs/scene/src/scene/environment.ts:146

The strength of environment specular lighting

Returns

number

Set Signature

set specularStrength(val): void

Defined in: libs/scene/src/scene/environment.ts:149

Parameters

val

number

Returns

void

---

ambientColor

Get Signature

get ambientColor(): Vector4

Defined in: libs/scene/src/scene/environment.ts:153

Ambient light color for environment light type constant

Returns

Vector4

Set Signature

set ambientColor(val): void

Defined in: libs/scene/src/scene/environment.ts:156

Parameters

val

Vector4

Returns

void

---

ambientUp

Get Signature

get ambientUp(): Vector4

Defined in: libs/scene/src/scene/environment.ts:160

Up color for environment light type hemisphere

Returns

Vector4

Set Signature

set ambientUp(val): void

Defined in: libs/scene/src/scene/environment.ts:163

Parameters

val

Vector4

Returns

void

---

ambientDown

Get Signature

get ambientDown(): Vector4

Defined in: libs/scene/src/scene/environment.ts:167

Down color for environment light type hemisphere

Returns

Vector4

Set Signature

set ambientDown(val): void

Defined in: libs/scene/src/scene/environment.ts:170

Parameters

val

Vector4

Returns

void

---

radianceMap

Get Signature

get radianceMap(): TextureCube<unknown>

Defined in: libs/scene/src/scene/environment.ts:174

Radiance map for environment light type ibl

Returns

TextureCube<unknown>

Set Signature

set radianceMap(tex): void

Defined in: libs/scene/src/scene/environment.ts:177

Parameters

tex

TextureCube<unknown>

Returns

void

---

sheenRadianceMap

Get Signature

get sheenRadianceMap(): TextureCube<unknown>

Defined in: libs/scene/src/scene/environment.ts:184

Charlie-filtered sheen radiance map for environment light type ibl

Returns

TextureCube<unknown>

Set Signature

set sheenRadianceMap(tex): void

Defined in: libs/scene/src/scene/environment.ts:187

Parameters

tex

TextureCube<unknown>

Returns

void

---

irradianceSH

Get Signature

get irradianceSH(): GPUDataBuffer<unknown>

Defined in: libs/scene/src/scene/environment.ts:194

Irradiance SH buffer for environment light type ibl

Returns

GPUDataBuffer<unknown>

Set Signature

set irradianceSH(value): void

Defined in: libs/scene/src/scene/environment.ts:197

Parameters

value

GPUDataBuffer<unknown>

Returns

void

---

irradianceSHFB

Get Signature

get irradianceSHFB(): FrameBuffer<unknown>

Defined in: libs/scene/src/scene/environment.ts:204

Irradiance SH texture for environment light type ibl

Returns

FrameBuffer<unknown>

Set Signature

set irradianceSHFB(value): void

Defined in: libs/scene/src/scene/environment.ts:207

Parameters

value

FrameBuffer<unknown>

Returns

void

---

irradianceWindow

Get Signature

get irradianceWindow(): Immutable<Vector3>

Defined in: libs/scene/src/scene/environment.ts:214

Irradiance SH window for environment light type ibl

Returns

Immutable<Vector3>

Set Signature

set irradianceWindow(value): void

Defined in: libs/scene/src/scene/environment.ts:217

Parameters

value

Immutable<Vector3>

Returns

void

---

type

Get Signature

get type(): EnvLightType

Defined in: libs/scene/src/scene/environment.ts:224

The environment light type

Returns

EnvLightType

Set Signature

set type(val): void

Defined in: libs/scene/src/scene/environment.ts:227

Parameters

val

EnvLightType

Returns

void

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:630

IEventTarget.on

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Disposable.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:634

IEventTarget.once

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Disposable.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:638

IEventTarget.off

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener?

EventListener<{ dispose: []; }>

context?

unknown

Returns

void

Inherited from

Disposable.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:642

IEventTarget.dispatchEvent

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

Inherited from

Disposable.dispatchEvent

---

dispose()

dispose(): void

Defined in: libs/base/dist/index.d.ts:6108

Returns

void

Inherited from

Disposable.dispose

---

onDispose()

protected onDispose(): void

Defined in: libs/scene/src/scene/environment.ts:262

Disposes the environment lighting wrapper

Returns

void

Overrides

Disposable.onDispose