Chevron Down
Table of Contents
Chevron DownGetting Started
Chevron DownAPI Reference

DirectionalLight

Create a directional light source which emits from a specific direction.A directional light can be considered "infinitely" far away (like the Sun) and does not attenuate with distance. At most 5 directional lights can be supported.

Usage

Create a directional light source with color, intensity and direction.

const directionalLight= new DirectionalLight({
  color: [128, 128, 0],
  intensity: 2.0,
  direction: [0, -100, -100]
});

Methods

constructor

The constructor for the DirectionalLight class. Use this to create a new DirectionalLight.

const directionalLight = new DirectionalLight({color, intensity, direction});
  • color - (array,) RGB color of directional light source, default value is [255, 255, 255].
  • intensity - (number) Strength of directional light source, default value is 1.0.
  • direction - (array,) 3D vector specifies the direction the light comes from, default value is [0, 0, -1].