@babylonjs/core|

ClusteredLightingSceneComponent

Class ClusteredLightingSceneComponent

A scene component required for running the clustering step in clustered lights

Implements

WebXRSpatialLayerType

Index

Constructors

Properties

Methods

dispose isReady rebuild register

Constructors

constructor

new ClusteredLightingSceneComponent(
scene: Scene,
): ClusteredLightingSceneComponent
Creates a new scene component.
Parameters
- scene: Scene
  The scene the component belongs to
Returns ClusteredLightingSceneComponent
- Defined in packages/dev/core/src/Lights/Clustered/clusteredLightingSceneComponent.pure.ts:26

Properties

name

name: any = SceneComponentConstants.NAME_CLUSTEREDLIGHTING

The name of the component. Each component must have a unique name.

scene

scene: Scene

The scene the component belongs to.

Methods

dispose

dispose(): void
Disposes the component and the associated resources.

Returns void
- Defined in packages/dev/core/src/Lights/Clustered/clusteredLightingSceneComponent.pure.ts:35

isReady

isReady(): boolean
Checks that enabled clustered lights have prepared their proxy shaders.

Returns boolean
true when every supported, enabled container is ready
- Defined in packages/dev/core/src/Lights/Clustered/clusteredLightingSceneComponent.pure.ts:60

rebuild

rebuild(): void
Rebuilds the elements related to this component in case of context lost for instance.

Returns void
- Defined in packages/dev/core/src/Lights/Clustered/clusteredLightingSceneComponent.pure.ts:43

register

register(): void
Register the component to one instance of a scene.

Returns void
- Defined in packages/dev/core/src/Lights/Clustered/clusteredLightingSceneComponent.pure.ts:48