Class ShadowSettingsPerLight

Settings that control shadow map rendering on a per-light level.

Index

Constructors

constructor

new ShadowSettingsPerLight(
    isEnabled?: boolean,
    updateRate?: EnumValue<ShadowMapUpdateRate>,
    updateCountPerSecond?: number,
    resolutionMode?: EnumValue<ShadowMapResolutionMode>,
    fixedShadowMapResolution?: number,
    shadowMapScaling?: number,
): ShadowSettingsPerLight
Parameters
- OptionalisEnabled: boolean
- OptionalupdateRate: EnumValue<ShadowMapUpdateRate>
- OptionalupdateCountPerSecond: number
- OptionalresolutionMode: EnumValue<ShadowMapResolutionMode>
- OptionalfixedShadowMapResolution: number
- OptionalshadowMapScaling: number
Returns ShadowSettingsPerLight

Properties

`Protected`_fixedShadowMapResolution

_fixedShadowMapResolution: number

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_resolutionMode

_resolutionMode: EnumValue<ShadowMapResolutionMode>

`Protected`_shadowMapScaling

_shadowMapScaling: number

`Protected`_updateCountPerSecond

_updateCountPerSecond: number

`Protected`_updateRate

_updateRate: EnumValue<ShadowMapUpdateRate>

Accessors

fixedShadowMapResolution

get fixedShadowMapResolution(): number

Shadow map resolution in pixels for both shadow map width and height. Only relevant if using the fixed shadow resolution mode.

Returns number
set fixedShadowMapResolution(value: number): void
Parameters
- value: number
Returns void

isEnabled

get isEnabled(): boolean

Determines if shadows are enabled or not.

Returns boolean
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

resolutionMode

get resolutionMode(): EnumValue<ShadowMapResolutionMode>

Controls how is shadow map resolution determined.

Returns EnumValue<ShadowMapResolutionMode>
set resolutionMode(value: EnumValue<ShadowMapResolutionMode>): void
Parameters
- value: EnumValue<ShadowMapResolutionMode>
Returns void

shadowMapScaling

get shadowMapScaling(): number

Scale the shadow map resolution using the provided factor. Only relevant if using dynamic shadow map resolution. Multiplied with the global shadow map scale.

Returns number
set shadowMapScaling(value: number): void
Parameters
- value: number
Returns void

updateCountPerSecond

get updateCountPerSecond(): number

How many times to update the shadow map per second, if using the manual interval shadow map mode.

Returns number
set updateCountPerSecond(value: number): void
Parameters
- value: number
Returns void

updateRate

get updateRate(): EnumValue<ShadowMapUpdateRate>

Determines how often to rebuild the shadow map. Ignored for cascaded shadow maps which are updated every frame.

Returns EnumValue<ShadowMapUpdateRate>
set updateRate(value: EnumValue<ShadowMapUpdateRate>): void
Parameters
- value: EnumValue<ShadowMapUpdateRate>
Returns void

Methods

assign

assign(other: Immutable<ShadowSettingsPerLight>): ShadowSettingsPerLight
Copies all properties defined by the prototype of ShadowSettingsPerLight from other to this instance.
Parameters
- other: Immutable<ShadowSettingsPerLight>
Returns ShadowSettingsPerLight

clone

clone(): ShadowSettingsPerLight

Clones this instance and returns a new ShadowSettingsPerLight with identical values.

Returns ShadowSettingsPerLight

isEqual

isEqual(
this: Immutable<ShadowSettingsPerLight>,
other: Immutable<ShadowSettingsPerLight>,
): boolean
Determines if this ShadowSettingsPerLight instance is equal to the other instance.
Parameters
- this: Immutable<ShadowSettingsPerLight>
- other: Immutable<ShadowSettingsPerLight>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<ShadowSettingsPerLight>,
rhs: Immutable<ShadowSettingsPerLight>,
): boolean
Determines if both ShadowSettingsPerLight instances are equal.
Parameters
- lhs: Immutable<ShadowSettingsPerLight>
- rhs: Immutable<ShadowSettingsPerLight>
Returns boolean

Class ShadowSettingsPerLight

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ShadowSettingsPerLight

Properties

Protected_fixedShadowMapResolution

Protected_isEnabled

Protected_resolutionMode

Protected_shadowMapScaling

Protected_updateCountPerSecond

Protected_updateRate

Accessors

fixedShadowMapResolution

Returns number

Parameters

Returns void

isEnabled

Returns boolean

Parameters

Returns void

resolutionMode

Returns EnumValue<ShadowMapResolutionMode>

Parameters

Returns void

shadowMapScaling

Returns number

Parameters

Returns void

updateCountPerSecond

Returns number

Parameters

Returns void

updateRate

Returns EnumValue<ShadowMapUpdateRate>

Parameters

Returns void

Methods

assign

Parameters

Returns ShadowSettingsPerLight

clone

Returns ShadowSettingsPerLight

isEqual

Parameters

Returns boolean

StaticisEqual

Parameters

Returns boolean

Settings

On This Page

`Protected`_fixedShadowMapResolution

`Protected`_isEnabled

`Protected`_resolutionMode

`Protected`_shadowMapScaling

`Protected`_updateCountPerSecond

`Protected`_updateRate

`Static`isEqual