vgpu/scene8 symbolsView source ↗

Symbols in this topic

ambientLightfunctionAmbientLighttypeAmbientLightOptionsoptionsAmbientLightValuestypedirectionalLightfunctionDirectionalLighttypeDirectionalLightOptionsoptionsDirectionalLightValuestype

directionalLight

Creates a directional (sun-style) light node. Direction is explicit, not transform-derived.

Import

TypeScript
1
import { directionalLight } from "vgpu/scene";

Signature

TypeScript
1
declare function directionalLight(options?: import("vgpu/scene").DirectionalLightOptions): import("vgpu/scene").DirectionalLight;

Parameters

ParamTypeRequiredDefaultNotes
options.directionVec3Like✖[0, -1, 0]World-space direction the light travels toward.
options.colorVec3Like✖[1, 1, 1]Linear RGB.
options.intensitynumber✖1Must be >= 0.

Returns: DirectionalLight node with kind: "directional-light". Throws: VGPU-SCENE-VALUE-INVALID for malformed vectors or negative intensity.

Examples

TypeScript
1
2
3
4
5
import { directionalLight, scene } from "vgpu/scene";
 
const sun = directionalLight({ direction: [-1, -2, -1], intensity: 1.2 });
scene().add(sun);
sun.set({ intensity: 0.8 });

Notes

DirectionalLight

Class returned by directionalLight(). Extends SceneNode.

Import

TypeScript
1
import type { DirectionalLight } from "vgpu/scene";

Signature

TypeScript
1
2
3
4
5
6
declare class DirectionalLight {
  set(values: import("vgpu/scene").DirectionalLightValues): this;
  readonly direction: Float32Array;
  readonly color: Float32Array;
  readonly intensity: number;
}

Examples

TypeScript
1
2
3
import { directionalLight } from "vgpu/scene";
 
directionalLight().set({ direction: [1, -1, 0], color: [1, 0.9, 0.8] });

Notes

DirectionalLightOptions

Options accepted by directionalLight(): light parameters plus NodeOptions.

Import

TypeScript
1
import type { DirectionalLightOptions } from "vgpu/scene";

Signature

TypeScript
1
2
3
4
5
6
7
interface DirectionalLightOptions {
  readonly direction?: import("vgpu/scene").Vec3Like;
  readonly color?: import("vgpu/scene").Vec3Like;
  readonly intensity?: number;
  readonly label?: string;
  readonly children?: readonly import("vgpu/scene").SceneNode[];
}

Examples

TypeScript
1
2
3
import { directionalLight } from "vgpu/scene";
 
directionalLight({ direction: [0, -1, -1], intensity: 2, label: "key" });

Notes

DirectionalLightValues

Values accepted by DirectionalLight.set().

Import

TypeScript
1
import type { DirectionalLightValues } from "vgpu/scene";

Signature

TypeScript
1
2
3
4
5
interface DirectionalLightValues {
  readonly direction?: import("vgpu/scene").Vec3Like;
  readonly color?: import("vgpu/scene").Vec3Like;
  readonly intensity?: number;
}

Examples

TypeScript
1
2
3
import { directionalLight } from "vgpu/scene";
 
directionalLight().set({ intensity: 0.5 });

Notes

ambientLight

Creates an ambient fill light node applied uniformly to lit materials.

Import

TypeScript
1
import { ambientLight } from "vgpu/scene";

Signature

TypeScript
1
declare function ambientLight(options?: import("vgpu/scene").AmbientLightOptions): import("vgpu/scene").AmbientLight;

Examples

TypeScript
1
2
3
import { ambientLight, scene } from "vgpu/scene";
 
scene().add(ambientLight({ color: [0.4, 0.45, 0.6], intensity: 0.3 }));

Notes

AmbientLight

Class returned by ambientLight(). Extends SceneNode.

Import

TypeScript
1
import type { AmbientLight } from "vgpu/scene";

Signature

TypeScript
1
2
3
4
5
declare class AmbientLight {
  set(values: import("vgpu/scene").AmbientLightValues): this;
  readonly color: Float32Array;
  readonly intensity: number;
}

Examples

TypeScript
1
2
3
import { ambientLight } from "vgpu/scene";
 
ambientLight().set({ intensity: 0.2 });

Notes

AmbientLightOptions

Options accepted by ambientLight().

Import

TypeScript
1
import type { AmbientLightOptions } from "vgpu/scene";

Signature

TypeScript
1
2
3
4
5
interface AmbientLightOptions {
  readonly color?: import("vgpu/scene").Vec3Like;
  readonly intensity?: number;
  readonly label?: string;
}

Examples

TypeScript
1
2
3
import { ambientLight } from "vgpu/scene";
 
ambientLight({ intensity: 0.25 });

Notes

AmbientLightValues

Values accepted by AmbientLight.set().

Import

TypeScript
1
import type { AmbientLightValues } from "vgpu/scene";

Signature

TypeScript
1
2
3
4
interface AmbientLightValues {
  readonly color?: import("vgpu/scene").Vec3Like;
  readonly intensity?: number;
}

Examples

TypeScript
1
2
3
import { ambientLight } from "vgpu/scene";
 
ambientLight().set({ color: [1, 1, 1] });

Notes