Class LightingParams

Lighting parameters, allow configuration of the global lighting parameters. For details see Clustered Lighting.

Index

Properties

_areaLightsEnabled _cells _cookieAtlasResolution _cookiesEnabled _maxLightsPerCell _shadowAtlasResolution _shadowType _shadowsEnabled atlasSplit debugLayer

Accessors

areaLightsEnabled cells cookieAtlasResolution cookiesEnabled maxLightsPerCell shadowAtlasResolution shadowType shadowsEnabled

Properties

`Private` _areaLightsEnabled

_areaLightsEnabled: boolean = false

`Private` _cells

_cells: Vec3 = ...

`Private` _cookieAtlasResolution

_cookieAtlasResolution: number = 2048

`Private` _cookiesEnabled

_cookiesEnabled: boolean = false

`Private` _maxLightsPerCell

_maxLightsPerCell: number = 255

`Private` _shadowAtlasResolution

_shadowAtlasResolution: number = 2048

`Private` _shadowType

_shadowType: number = SHADOW_PCF3

`Private` _shadowsEnabled

_shadowsEnabled: boolean = true

atlasSplit

atlasSplit: number[] = null

Atlas textures split description, which applies to both the shadow and cookie texture atlas. Defaults to null, which enables to automatic split mode. For details see Configuring Atlas Split.

debugLayer

debugLayer: number

Layer ID of a layer to contain the debug rendering of clustered lighting. Defaults to undefined, which disables the debug rendering. Debug rendering is only included in the debug version of the engine.

Accessors

areaLightsEnabled

get areaLightsEnabled(): boolean
Returns boolean
- Defined in engine/src/scene/lighting/lighting-params.js:194
set areaLightsEnabled(value): void
If set to true, the clustered lighting will support area lights. Defaults to false.
Parameters
- value: boolean
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:181

cells

get cells(): Vec3
Returns Vec3
- Defined in engine/src/scene/lighting/lighting-params.js:87
set cells(value): void
Number of cells along each world-space axis the space containing lights is subdivided into. Defaults to Vec(10, 3, 10).
Parameters
- value: Vec3
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:83

cookieAtlasResolution

get cookieAtlasResolution(): number
Returns number
- Defined in engine/src/scene/lighting/lighting-params.js:114
set cookieAtlasResolution(value): void
Resolution of the atlas texture storing all non-directional cookie textures. Defaults to 2048.
Parameters
- value: number
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:110

cookiesEnabled

get cookiesEnabled(): boolean
Returns boolean
- Defined in engine/src/scene/lighting/lighting-params.js:171
set cookiesEnabled(value): void
If set to true, the clustered lighting will support cookie textures. Defaults to false.
Parameters
- value: boolean
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:162

maxLightsPerCell

get maxLightsPerCell(): number
Returns number
- Defined in engine/src/scene/lighting/lighting-params.js:100
set maxLightsPerCell(value): void
Maximum number of lights a cell can store. Defaults to 255.
Parameters
- value: number
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:96

shadowAtlasResolution

get shadowAtlasResolution(): number
Returns number
- Defined in engine/src/scene/lighting/lighting-params.js:128
set shadowAtlasResolution(value): void
Resolution of the atlas texture storing all non-directional shadow textures. Defaults to 2048.
Parameters
- value: number
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:124

shadowType

get shadowType(): number
Returns number
- Defined in engine/src/scene/lighting/lighting-params.js:152
set shadowType(value): void
The type of shadow filtering used by all shadows. Can be:
- SHADOW_PCF1: PCF 1x1 sampling.
- SHADOW_PCF3: PCF 3x3 sampling.
- SHADOW_PCF5: PCF 5x5 sampling. Falls back to SHADOW_PCF3 on WebGL 1.0.
Defaults to SHADOW_PCF3
Parameters
- value: number
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:143

shadowsEnabled

get shadowsEnabled(): boolean
Returns boolean
- Defined in engine/src/scene/lighting/lighting-params.js:213
set shadowsEnabled(value): void
If set to true, the clustered lighting will support shadows. Defaults to true.
Parameters
- value: boolean
Returns void
- Defined in engine/src/scene/lighting/lighting-params.js:204

Class LightingParams

Index

Properties

Accessors

Properties

Private _areaLightsEnabled

Private _cells

Private _cookieAtlasResolution

Private _cookiesEnabled

Private _maxLightsPerCell

Private _shadowAtlasResolution

Private _shadowType

Private _shadowsEnabled

atlasSplit

debugLayer

Accessors

areaLightsEnabled

Returns boolean

Parameters

Returns void

cells

Returns Vec3

Parameters

Returns void

cookieAtlasResolution

Returns number

Parameters

Returns void

cookiesEnabled

Returns boolean

Parameters

Returns void

maxLightsPerCell

Returns number

Parameters

Returns void

shadowAtlasResolution

Returns number

Parameters

Returns void

shadowType

Returns number

Parameters

Returns void

shadowsEnabled

Returns boolean

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` _areaLightsEnabled

`Private` _cells

`Private` _cookieAtlasResolution

`Private` _cookiesEnabled

`Private` _maxLightsPerCell

`Private` _shadowAtlasResolution

`Private` _shadowType

`Private` _shadowsEnabled