Documentation / scene / EnvConstantAmbient

Class: EnvConstantAmbient

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

Constant ambient light

Extends

• EnvironmentLighting

Constructors

Constructor

new EnvConstantAmbient(ambientColor?): EnvConstantAmbient

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

Creates an instance of EnvConstantAmbient

Parameters

ambientColor?

Vector4

The ambient color

Returns

EnvConstantAmbient

Overrides

EnvironmentLighting.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

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

Returns

boolean

Inherited from

EnvironmentLighting.disposed

---

ambientColor

Get Signature

get ambientColor(): Immutable<Vector4>

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

The ambient color

Returns

Immutable<Vector4>

Set Signature

set ambientColor(ambientColor): void

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

Parameters

ambientColor

Immutable<Vector4>

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

EnvironmentLighting.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

EnvironmentLighting.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

EnvironmentLighting.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

EnvironmentLighting.dispatchEvent

---

dispose()

dispose(): void

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

Returns

void

Inherited from

EnvironmentLighting.dispose

---

onDispose()

protected onDispose(): void

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

Returns

void

Inherited from

EnvironmentLighting.onDispose

---

getType()

getType(): "constant"

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

The environment light type

Returns

"constant"

Overrides

EnvironmentLighting.getType

---

initShaderBindings()

initShaderBindings(pb): void

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

Initialize shader bindings

Parameters

pb

ProgramBuilder

The program builder

Returns

void

Overrides

EnvironmentLighting.initShaderBindings

---

updateBindGroup()

updateBindGroup(bg): void

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

Updates the uniform values

Parameters

bg

BindGroup

The bind group to be updated

Returns

void

Overrides

EnvironmentLighting.updateBindGroup

---

getRadiance()

getRadiance(_scope, _refl, _roughness): any

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

Get radiance for a fragment

Parameters

_scope

PBInsideFunctionScope

The shader scope

_refl

PBShaderExp

Reflection vector

_roughness

PBShaderExp

Surface roughness

Returns

any

The radiance for the fragment

Overrides

EnvironmentLighting.getRadiance

---

getSheenRadiance()

getSheenRadiance(_scope, _refl, _roughness): any

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

Get Charlie-filtered sheen radiance for a fragment

Parameters

_scope

PBInsideFunctionScope

The shader scope

_refl

PBShaderExp

Reflection vector

_roughness

PBShaderExp

Sheen roughness

Returns

any

The sheen radiance for the fragment

Overrides

EnvironmentLighting.getSheenRadiance

---

getIrradiance()

getIrradiance(scope, _normal): PBShaderExp

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

Get irradiance for a fragment

Parameters

scope

PBInsideFunctionScope

The shader scope

_normal

PBShaderExp

surface normal

Returns

PBShaderExp

The radiance for the fragment

Overrides

EnvironmentLighting.getIrradiance

---

hasRadiance()

hasRadiance(): boolean

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

Returns whether this environment lighting supports reflective light

Returns

boolean

Overrides

EnvironmentLighting.hasRadiance

---

hasSheenRadiance()

hasSheenRadiance(): boolean

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

Returns whether this environment lighting supports sheen reflective light

Returns

boolean

Overrides

EnvironmentLighting.hasSheenRadiance

---

hasIrradiance()

hasIrradiance(): boolean

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

Returns whether this environment lighting supports diffuse light

Returns

boolean

Overrides

EnvironmentLighting.hasIrradiance