Skip to main content

Class: LightingOptions

Defined in: src/lighting/LightingOptions.ts:7

Default options for controlling Lighting module features.

Constructors​

Constructor​

new LightingOptions(options?): LightingOptions

Defined in: src/lighting/LightingOptions.ts:23

Parameters​

options?​
castDirectionalLightShadow?​

boolean = false

Cast shadows using diretional light.

debugging?​

boolean = false

Enables debugging renders and logs.

enabled?​

boolean = false

Enables XR lighting.

useAmbientSH?​

boolean = false

Add ambient spherical harmonics to lighting.

useDirectionalLight?​

boolean = false

Add main diredtional light to lighting.

useDynamicSoftShadow?​

boolean = false

Adjust hardness of shadows according to relative brightness of main light.

Returns​

LightingOptions

Properties​

castDirectionalLightShadow​

castDirectionalLightShadow: boolean = false

Defined in: src/lighting/LightingOptions.ts:17

Cast shadows using diretional light.

debugging​

debugging: boolean = false

Defined in: src/lighting/LightingOptions.ts:9

Enables debugging renders and logs.

enabled​

enabled: boolean = false

Defined in: src/lighting/LightingOptions.ts:11

Enables XR lighting.

useAmbientSH​

useAmbientSH: boolean = false

Defined in: src/lighting/LightingOptions.ts:13

Add ambient spherical harmonics to lighting.

useDirectionalLight​

useDirectionalLight: boolean = false

Defined in: src/lighting/LightingOptions.ts:15

Add main diredtional light to lighting.

useDynamicSoftShadow​

useDynamicSoftShadow: boolean = false

Defined in: src/lighting/LightingOptions.ts:21

Adjust hardness of shadows according to relative brightness of main light.