Skip to main content

Interface: LocalLightsOptions

Properties​

analyticRadius​

• analyticRadius: number

Blocks from the camera within which lights become analytic.

csmFarCascadeUnits​

• csmFarCascadeUnits: number

Ledger cost of one CSM far cascade, in face units.

csmNearCascadeUnits​

• csmNearCascadeUnits: number

Ledger cost of the CSM near cascade, in face units.

fluidSpecularStrength​

• fluidSpecularStrength: number

Strength of local specular on fluids; 0 disables.

gridCellSize​

• gridCellSize: number

Grid cell size in blocks.

gridDims​

• gridDims: [number, number, number]

Grid cells per axis [x, y, z]; the window scrolls with the camera.

localShadowBias​

• localShadowBias: number

Constant occluder-side depth bias in blocks (linear light space).

localShadowNormalBiasTexels​

• localShadowNormalBiasTexels: number

Receiver offset along the surface normal, in shadow texels.

localShadowPcfRadius​

• localShadowPcfRadius: number

PCF tap spread, in shadow texels.

localShadowStrength​

• localShadowStrength: number

1 = an occluded fragment loses the light entirely.

maskKnee​

• maskKnee: number

Flood-mask knee: flood level (0..1) at which masked lights reach full.

maxClusteredLights​

• maxClusteredLights: number

Lights the clustered layer may select per pass; capped at 255.

maxLightsPerCell​

• maxLightsPerCell: number

Grid slots filled per cell; the shader loop is compiled for 8.

maxRegisteredLights​

• maxRegisteredLights: number

Pool capacity for registered lights (static emitters + dynamic sources).

maxSectionScansPerFrame​

• maxSectionScansPerFrame: number

Sections scanned for emitters per frame at most.

maxShadowedLights​

• maxShadowedLights: number

Shadowed local lights at once; each owns a fixed atlas region.

qualityTier​

• qualityTier: LightQualityTier

Initial quality tier.

selectionHysteresis​

• selectionHysteresis: number

Multiplier a light's score gets while selected, against churn.

shadowAtlasSize​

• shadowAtlasSize: number

Edge length of the shared depth atlas, in pixels.

shadowEvictionHysteresis​

• shadowEvictionHysteresis: Object

A challenger light must out-score a shadow holder by ratio for frames consecutive frames before evicting it from the atlas.

Type declaration​

NameType
framesnumber
rationumber

shadowLedgerUnitsPerFrame​

• shadowLedgerUnitsPerFrame: number

Face units the shadow ledger may spend per frame (CSM + local).

shadowSlotSize​

• shadowSlotSize: number

Edge length of one atlas cell (one cube face render), in pixels.