Renderer · interface

LightFieldOptions

Explained in Hello world.

interface LightFieldOptions
import type { LightFieldOptions } from '@driftengine/core';

Properties

NameTypeDescription
falloffreadonlyPointLightFalloffHow the renderer shades a point light, which the sum has to match.
spacingreadonlyoptionalnumberMetres between samples; a third of a metre by default, so a brick spans a metre.
fieldsreadonlyoptionalreadonly GlobalFieldInstance[]The scene's placed distance fields, which occlude the light. None leaves it unoccluded.
bandreadonlyoptionalnumberMetres over which exact and summed light crossfade at the shading radius. Two by default.
fadeSecreadonlyoptionalnumberSeconds the summed light fades in over once the field is whole, FIELD_FADE_SEC by default. Zero for a field baked behind a loading screen, which has nothing on screen to pop and may be stepped by a clock that has stopped.