createScene#addLight¶

Summary¶

createScene#addLight appends a light instance to the scene lighting list when not already present. Ambient lights are combined separately; rendering uses at most the first eight enabled directional, point, and spot lights in scene order. Additional lights remain stored and queryable but do not affect rendering until an earlier non-ambient light is removed or disabled.

Syntax¶

Scene.addLight(light: Light): Scene
const result = scene.addLight(light);

Parameters¶

Name	Type	Required	Description
`light`	`Light`	Yes	Ambient, directional, point, or spot light instance to register with the scene.

Returns¶

Scene - The same scene instance after light registration.

Type Details¶

LightType¶

type LightType = "ambient" | "directional" | "point" | "spot";

Light¶

type Light = {
    readonly type: LightType;
    color: [number, number, number];
    intensity: number;
    enabled: boolean;
};

Example¶

const canvas = document.querySelector("canvas");
const wgpu = await WasmGPU.create(canvas);

const scene = wgpu.createScene();
scene.addLight(wgpu.createLight.ambient({ intensity: 0.15 }));
scene.addLight(wgpu.createLight.directional({ direction: [0.2, -1, 0.3], intensity: 1.1 }));
scene.addLight(wgpu.createLight.spot({ position: [1, 2, 0], direction: [0, -1, 0], range: 12 }));