Skip to content

WasmGPU | Documentation

createLight.spot

createLight.spot¶

Summary¶

createLight.spot creates a SpotLight with position, direction, range, and cone-angle controls. Spot lights are useful for focused local illumination, inspection beams, and glTF punctual-light imports that need a bounded cone rather than omnidirectional falloff.

Syntax¶

WasmGPU.createLight.spot(options?: SpotLightOptions): SpotLight
const light = wgpu.createLight.spot(options);

Parameters¶

Name	Type	Required	Description
`options`	`SpotLightOptions`	No	Optional position, direction, color, intensity, range, and cone-angle configuration.

Returns¶

SpotLight - Spot light object ready for scene.addLight(light).

Type Details¶

Color¶

type Color = [number, number, number];

SpotLightOptions¶

type SpotLightOptions = {
    position?: [number, number, number];
    direction?: [number, number, number];
    color?: Color;
    intensity?: number;
    range?: number;
    innerCone?: number;
    outerCone?: number;
};

SpotLightOptions Fields¶

Name	Type	Required	Description
`position`	`[number, number, number]`	No	Finite world-space light origin; default `[0, 0, 0]`.
`direction`	`[number, number, number]`	No	Finite, nonzero world-space light direction; default `[0, -1, 0]` and normalized when set.
`color`	`Color`	No	Three finite, nonnegative RGB components; default `[1, 1, 1]`. Components above `1` are supported.
`intensity`	`number`	No	Finite nonnegative brightness multiplier; default `1`.
`range`	`number`	No	Finite nonnegative attenuation distance; default `10`. A value of `0` selects no finite cutoff.
`innerCone`	`number`	No	Finite inner cone angle in radians from `0` through `outerCone`; default `Math.PI / 8`.
`outerCone`	`number`	No	Finite outer cone angle in radians from `0` through `Math.PI`; default `Math.PI / 6`.

Example¶

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

const scene = wgpu.createScene();
const keySpot = wgpu.createLight.spot({
    position: [1.5, 2.5, 1.0],
    direction: [-0.3, -1.0, -0.2],
    color: [1.0, 0.96, 0.88],
    intensity: 2.0,
    range: 20,
    innerCone: Math.PI / 10,
    outerCone: Math.PI / 6
});
scene.addLight(keySpot);

See Also¶