Skip to content

Documentation / scene / Environment

Class: Environment

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

Environment of scene

Extends

  • Disposable

Accessors

disposed

Get Signature

get disposed(): boolean

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

Returns

boolean

Inherited from

Disposable.disposed


sky

Get Signature

get sky(): SkyRenderer

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

The sky renderer

Returns

SkyRenderer


light

Get Signature

get light(): EnvLightWrapper

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

The environment lighting renderer

Returns

EnvLightWrapper

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

Disposes the environment object

Returns

void

Overrides

Disposable.onDispose

Released under the MIT License.