Class ShadowSettingsPerLight

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

Index

Constructors

Properties

_fixedShadowMapResolution _isEnabled _resolutionMode _shadowMapScaling _updateCountPerSecond _updateRate

Accessors

fixedShadowMapResolution isEnabled resolutionMode shadowMapScaling updateCountPerSecond updateRate

Methods

assign clone isEqual isEqual

Constructors

constructor

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

Properties

`Protected`_fixedShadowMapResolution

_fixedShadowMapResolution: number

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_resolutionMode

_resolutionMode: EnumValue<ShadowMapResolutionMode, number>

`Protected`_shadowMapScaling

_shadowMapScaling: number

`Protected`_updateCountPerSecond

_updateCountPerSecond: number

`Protected`_updateRate

_updateRate: EnumValue<ShadowMapUpdateRate, number>

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): void
Parameters
- value: number
Returns void

isEnabled

get isEnabled(): boolean
Determines if shadows are enabled or not.

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

resolutionMode

get resolutionMode(): EnumValue<ShadowMapResolutionMode, number>
Controls how is shadow map resolution determined.

Returns EnumValue<ShadowMapResolutionMode, number>
set resolutionMode(value): void
Parameters
- value: EnumValue<ShadowMapResolutionMode, number>
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): 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): void
Parameters
- value: number
Returns void

updateRate

get updateRate(): EnumValue<ShadowMapUpdateRate, number>
Determines how often to rebuild the shadow map. Ignored for cascaded shadow maps which are updated every frame.

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

Methods

assign

assign(other): 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, other): 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, rhs): boolean
Determines if both ShadowSettingsPerLight instances are equal.
Parameters
- lhs: Immutable<ShadowSettingsPerLight>
- rhs: Immutable<ShadowSettingsPerLight>
Returns boolean