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:6065

Returns

boolean

Inherited from

Disposable.disposed

---

strength

Get Signature

get strength(): number

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

The strength of environment lighting

Returns

number

Set Signature

set strength(val): void

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

Parameters

val

number

Returns

void

---

specularStrength

Get Signature

get specularStrength(): number

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

The strength of environment specular lighting

Returns

number

Set Signature

set specularStrength(val): void

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

Parameters

val

number

Returns

void

---

ambientColor

Get Signature

get ambientColor(): Vector4

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

Ambient light color for environment light type constant

Returns

Vector4

Set Signature

set ambientColor(val): void

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

Parameters

val

Vector4

Returns

void

---

ambientUp

Get Signature

get ambientUp(): Vector4

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

Up color for environment light type hemisphere

Returns

Vector4

Set Signature

set ambientUp(val): void

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

Parameters

val

Vector4

Returns

void

---

ambientDown

Get Signature

get ambientDown(): Vector4

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

Down color for environment light type hemisphere

Returns

Vector4

Set Signature

set ambientDown(val): void

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

Parameters

val

Vector4

Returns

void

---

radianceMap

Get Signature

get radianceMap(): TextureCube<unknown>

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

Radiance map for environment light type ibl

Returns

TextureCube<unknown>

Set Signature

set radianceMap(tex): void

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

Parameters

tex

TextureCube<unknown>

Returns

void

---

sheenRadianceMap

Get Signature

get sheenRadianceMap(): TextureCube<unknown>

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

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:124

Parameters

tex

TextureCube<unknown>

Returns

void

---

irradianceSH

Get Signature

get irradianceSH(): GPUDataBuffer<unknown>

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

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:134

Parameters

value

GPUDataBuffer<unknown>

Returns

void

---

irradianceSHFB

Get Signature

get irradianceSHFB(): FrameBuffer<unknown>

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

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:144

Parameters

value

FrameBuffer<unknown>

Returns

void

---

irradianceWindow

Get Signature

get irradianceWindow(): Immutable<Vector3>

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

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:154

Parameters

value

Immutable<Vector3>

Returns

void

---

type

Get Signature

get type(): EnvLightType

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

The environment light type

Returns

EnvLightType

Set Signature

set type(val): void

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

Parameters

val

EnvLightType

Returns

void

Methods

on()

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

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

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:598

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:602

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:606

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:6066

Returns

void

Inherited from

Disposable.dispose

---

onDispose()

protected onDispose(): void

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

Disposes the environment lighting wrapper

Returns

void

Overrides

Disposable.onDispose