Chapter 126: LightProbeHelper

Core Idea

Renders a sphere to visualize a light probe in the scene.

This helper can only be used with WebGLRenderer. When using WebGPURenderer, import from LightProbeHelperGPU.js.

Key Concepts

• lightProbe : LightProbe: The light probe to visualize.
• size : number: The size of the helper.

Code Examples

const helper = new LightProbeHelper( lightProbe );
scene.add( helper );

• What it demonstrates: Typical usage of LightProbeHelper.

Reference Tables

Constructor

Signature
new LightProbeHelper( lightProbe : LightProbe, size : number )

Properties

Property	Description
.lightProbe : LightProbe	The light probe to visualize.
.size : number	The size of the helper.

Methods

Method	Description
.dispose()	Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Key Takeaways

1. LightProbeHelper extends: EventDispatcher → Object3D → Mesh
2. Most relevant properties: lightProbe, size.
3. Key methods: dispose.

Connects To

• EventDispatcher: parent class
• Object3D: parent class
• Mesh: parent class
• Source: examples/jsm/helpers/LightProbeHelper.js