UWAL / DirectionalLight

Classes

DirectionalLight

A light used to radiate in a specific direction. It is positioned infinitely far away, and its rays are parallel.

See

Primitives / Lights for reference.

Extends

• Light

Constructors

Constructor

new DirectionalLight(
   direction?, 
   color?, 
   label?): DirectionalLight;

Parameters

Parameter	Type	Default value	Description
direction?	Float32Array<ArrayBufferLike>	undefined	Light direction. Defaults to [0, -1, 0].
color?	ColorParam	undefined	Light color. Defaults to white.
label?	string	"DirectionalLight"	Light label.

Returns

DirectionalLight

Overrides

Light.constructor

Methods

SetRenderPipeline()

SetRenderPipeline(Pipeline, uniformName?): GPUBuffer;

Create and update an internal uniform buffer of this light's color and intensity values.

Parameters

Parameter	Type	Default value	Description
Pipeline	RenderPipelineInstance	undefined	Pipeline using this light.
uniformName?	string	"DirectionalLight"	Uniform buffer name.

Returns

GPUBuffer

Overrides

Light.SetRenderPipeline

SetDirectionFrom()

SetDirectionFrom(pitch, yaw): void;

Compute the light direction from angles in radians.

Parameters

Parameter	Type	Description
pitch	number	Light elevation.
yaw	number	Compass direction.

Returns

void

LookAt()

LookAt(target, position): void;

Set the light direction to point at the specified point in 3D space.

Parameters

Parameter	Type	Description
target	Float32Array<ArrayBufferLike>	Point in 3D space to look at.
position	Float32Array<ArrayBufferLike>	Approximate light position.

Returns

void

Accessors

Direction

Get Signature

get Direction(): Float32Array<ArrayBufferLike>;

Returns

Float32Array<ArrayBufferLike>

The direction of the light.

Set Signature

set Direction(direction): void;

Parameters

Parameter	Type	Description
direction	Float32Array<ArrayBufferLike>	Light direction.

Returns

void