---

title: LightProbeHelper category: Addons layout: docs

LightProbeHelper

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.

Code Example

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

Import

LightProbeHelper is an addon, and must be imported explicitly, see Installation#Addons.

import { LightProbeHelper } from 'three/addons/helpers/LightProbeHelper.js';

Constructor

new LightProbeHelper( lightProbe : LightProbe, size : number )

Constructs a new light probe helper.

lightProbe | The light probe to visualize.
---|---
size | The size of the helper. Default is 1.

Properties

.lightProbe : LightProbe

The light probe to visualize.

.size : number

The size of the helper.

Default is 1.

Methods

.dispose()

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

Source

examples/jsm/helpers/LightProbeHelper.js