---

title: RectAreaLightHelper category: Addons layout: docs

RectAreaLightHelper

Creates a visual aid for rect area lights.

RectAreaLightHelper must be added as a child of the light.

Code Example

const light = new THREE.RectAreaLight( 0xffffbb, 1.0, 5, 5 );
const helper = new RectAreaLightHelper( light );
light.add( helper );

Import

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

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

Constructor

new RectAreaLightHelper( light : RectAreaLight, color : number | Color | string )

Constructs a new rect area light helper.

light | The light to visualize.
---|---
color | The helper's color. If this is not the set, the helper will take the color of the light.

Properties

.color : number | Color | string | undefined

The helper's color. If undefined, the helper will take the color of the light.

.light : RectAreaLight

The light to visualize.

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/RectAreaLightHelper.js