Documentation / scene / EnvironmentLighting

Abstract Class: EnvironmentLighting

Defined in: libs/scene/src/render/envlight.ts:26

Base class for any kind of environment light

Extends

• Disposable

Extended by

• EnvShIBL
• EnvConstantAmbient
• EnvHemisphericAmbient

Constructors

Constructor

new EnvironmentLighting(): EnvironmentLighting

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

Returns

EnvironmentLighting

Inherited from

Disposable.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

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

Returns

boolean

Inherited from

Disposable.disposed

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/base/dist/index.d.ts:6067

Returns

void

Inherited from

Disposable.onDispose

---

getType()

abstract getType(): EnvLightType

Defined in: libs/scene/src/render/envlight.ts:30

The environment light type

Returns

EnvLightType

---

initShaderBindings()

abstract initShaderBindings(pb): void

Defined in: libs/scene/src/render/envlight.ts:35

Initialize shader bindings

Parameters

pb

ProgramBuilder

The program builder

Returns

void

---

updateBindGroup()

abstract updateBindGroup(bg): void

Defined in: libs/scene/src/render/envlight.ts:40

Updates the uniform values

Parameters

bg

BindGroup

The bind group to be updated

Returns

void

---

getRadiance()

abstract getRadiance(scope, refl, roughness): PBShaderExp

Defined in: libs/scene/src/render/envlight.ts:50

Get radiance for a fragment

Parameters

scope

PBInsideFunctionScope

The shader scope

refl

PBShaderExp

Reflection vector

roughness

PBShaderExp

Surface roughness

Returns

PBShaderExp

The radiance for the fragment

---

getSheenRadiance()

abstract getSheenRadiance(scope, refl, roughness): PBShaderExp

Defined in: libs/scene/src/render/envlight.ts:64

Get Charlie-filtered sheen radiance for a fragment

Parameters

scope

PBInsideFunctionScope

The shader scope

refl

PBShaderExp

Reflection vector

roughness

PBShaderExp

Sheen roughness

Returns

PBShaderExp

The sheen radiance for the fragment

---

getIrradiance()

abstract getIrradiance(scope, normal): PBShaderExp

Defined in: libs/scene/src/render/envlight.ts:77

Get irradiance for a fragment

Parameters

scope

PBInsideFunctionScope

The shader scope

normal

PBShaderExp

surface normal

Returns

PBShaderExp

The radiance for the fragment

---

hasRadiance()

abstract hasRadiance(): boolean

Defined in: libs/scene/src/render/envlight.ts:81

Returns whether this environment lighting supports reflective light

Returns

boolean

---

hasSheenRadiance()

abstract hasSheenRadiance(): boolean

Defined in: libs/scene/src/render/envlight.ts:85

Returns whether this environment lighting supports sheen reflective light

Returns

boolean

---

hasIrradiance()

abstract hasIrradiance(): boolean

Defined in: libs/scene/src/render/envlight.ts:89

Returns whether this environment lighting supports diffuse light

Returns

boolean