Skip to main content

Type Alias: LightingProps

LightingProps = object

Defined in: modules/lighting/lights/lighting.ts:81

Public JavaScript props accepted by the lighting shader module.

Properties​

ambientLight?​

optional ambientLight?: AmbientLight

Defined in: modules/lighting/lights/lighting.ts:92

Legacy ambient-light prop.

Deprecated​

Use lights with {type: 'ambient', ...} entries instead.

directionalLights?​

optional directionalLights?: DirectionalLight[]

Defined in: modules/lighting/lights/lighting.ts:107

Legacy directional-light prop.

Deprecated​

Use lights with {type: 'directional', ...} entries instead.

enabled?​

optional enabled?: boolean

Defined in: modules/lighting/lights/lighting.ts:83

Enables or disables lighting calculations for the module.

lights?​

optional lights?: Light[]

Defined in: modules/lighting/lights/lighting.ts:87

Preferred API for supplying mixed ambient, point, spot, directional, rectangle, and disk lights.

pointLights?​

optional pointLights?: PointLight[]

Defined in: modules/lighting/lights/lighting.ts:97

Legacy point-light prop.

Deprecated​

Use lights with {type: 'point', ...} entries instead.

spotLights?​

optional spotLights?: SpotLight[]

Defined in: modules/lighting/lights/lighting.ts:102

Legacy spot-light prop.

Deprecated​

Use lights with {type: 'spot', ...} entries instead.

useByteColors?​

optional useByteColors?: boolean

Defined in: modules/lighting/lights/lighting.ts:85

When true, light colors are interpreted as byte-style 0-255 values.