Renderer · class

WorldLightField

Explained in Hello world.

class WorldLightField implements DriftLightVolumes
import { WorldLightField } from '@driftengine/core';

Constructor

new

constructor(volume: DenseLightVolume, options?: WorldLightFieldOptions)
ParameterTypeDescription
volumeDenseLightVolume
options?WorldLightFieldOptions

Properties

NameTypeDescription
indexDimsreadonlyreadonly [number, number, number]
indexreadonlyUint32Array<ArrayBuffer>
atlasSizereadonlyreadonly [number, number, number]
atlasreadonlyUint16Array
bandreadonlynumber
sampleOriginreadonlyreadonly [number, number, number]
signedSpacingreadonlynumber
scalenumberThe summed light's brightness, for a scene that dims all its lamps at once.

Accessors

NameTypeDescription
radiusgetnumber
presencegetnumber
centregetFloat32Array

Methods

follow

follow(complete: number, x: number, y: number, z: number, dtSec: number): void

Follow the frame's choice, as LightField.follow does.

ParameterTypeDescription
completenumber
xnumber
ynumber
znumber
dtSecnumber

Signatures

ready = truereadonly

readonly ready = true

empty = falsereadonly

readonly empty = false