Class Shadows

Readonlyview

applied

• get applied(): boolean

  Gets whether shadows are currently applied.

  This is true when the component enabled state is in the component enabled state.

  Returns boolean

autoFit

• get autoFit(): boolean

  Whether the shadow frustum is auto-fitted to the camera view each frame. Default true.

  Returns boolean
• set autoFit(value: boolean): void

  Parameters

  • value: boolean

  Returns void

bias

• get bias(): number

  Depth-compare bias used to avoid shadow acne. Default 0.003.

  Returns number
• set bias(value: number): void

  Parameters

  • value: number

  Returns void

cascadeCount

• get cascadeCount(): number

  Number of shadow cascades. Range [1, 4]. Default 1.

  Returns number
• set cascadeCount(value: number): void

  Parameters

  • value: number

  Returns void

cascadeSplitLambda

• get cascadeSplitLambda(): number

  Blend between uniform and logarithmic cascade splits. Range [0, 1]. Default 0.5.

  Returns number
• set cascadeSplitLambda(value: number): void

  Parameters

  • value: number

  Returns void

direction

• get direction(): Float32Array<any>

  Direction the shadow-casting light points in. Stored normalized. Default [-0.5,-1,-0.3].

  Returns Float32Array<any>
• set direction(value: FloatArrayParam): void

  Parameters

  • value: FloatArrayParam

  Returns void

enabled

• get enabled(): boolean

  Returns boolean

• set enabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

intensity

• get intensity(): number

  How dark a fully-occluded fragment becomes. Range [0..1]. Default 0.45.

  Returns number
• set intensity(value: number): void

  Parameters

  • value: number

  Returns void

lightDistance

• get lightDistance(): number

  Distance from scene center at which the virtual light is placed along direction. Default 50.

  Returns number
• set lightDistance(value: number): void

  Parameters

  • value: number

  Returns void

maxDistance

• get maxDistance(): number

  When autoFit is true, the shadow far-plane distance from the camera is clamped to this value. Default 200.

  Returns number
• set maxDistance(value: number): void

  Parameters

  • value: number

  Returns void

normalOffsetBias

• get normalOffsetBias(): number

  View-space normal-offset bias applied when sampling the shadow map. Default 0.02.

  Returns number
• set normalOffsetBias(value: number): void

  Parameters

  • value: number

  Returns void

padding

• get padding(): number

  Padding multiplier for the auto-fitted shadow frustum. Default 1.1.

  Returns number
• set padding(value: number): void

  Parameters

  • value: number

  Returns void

pcfKernelSize

• get pcfKernelSize(): number

  PCF kernel size in texels (odd integer, range [1, 7]). Default 3.

  Returns number
• set pcfKernelSize(value: number): void

  Parameters

  • value: number

  Returns void

projectionSize

• get projectionSize(): number

  Half-size (world units) of the shadow map's orthographic projection. Default 30.

  Returns number
• set projectionSize(value: number): void

  Parameters

  • value: number

  Returns void

resolution

• get resolution(): number

  Pixel resolution of the square shadow map. Default 2048.

  Changing this causes the shadow-map FBO to be reallocated on the next frame.

  Returns number
• set resolution(value: number): void

  Parameters

  • value: number

  Returns void

slopeBias

• get slopeBias(): number

  Slope-scaled depth bias. Default 0.004.

  Returns number
• set slopeBias(value: number): void

  Parameters

  • value: number

  Returns void

fromParams

• fromParams(params: ShadowsParams): SDKResult<any>

  Configures this Shadows component.

  Parameters

  • params: ShadowsParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<ShadowsParams>

  Gets the current configuration of this Shadows component.

  Returns SDKResult<ShadowsParams>