Interface ShadowBaseParams

Base parameters used to create a Shadow.

interface ShadowBaseParams {
    intensity?: number;
    bias?: number;
    normalBias?: number;
    pcfSamples?: number;
    depthTextureSize?: Vec2;
    depthTextureFormat?: GPUTextureFormat;
    autoRender?: boolean;
    useRenderBundle?: boolean;
    light: ShadowCastingLights;
}

Hierarchy (View Summary)

Properties

intensity? bias? normalBias? pcfSamples? depthTextureSize? depthTextureFormat? autoRender? useRenderBundle? light

Properties

Optionalintensity

intensity?: number

Intensity of the shadow in the [0, 1] range. Default to 1.

Optionalbias

bias?: number

Shadow map bias. Default to 0.

OptionalnormalBias

normalBias?: number

Shadow map normal bias. Default to 0.

OptionalpcfSamples

pcfSamples?: number

Number of samples to use for Percentage Closer Filtering calculations in the shader. Increase for smoother shadows, at the cost of performance. Default to 1.

OptionaldepthTextureSize

depthTextureSize?: Vec2

Size of the depth Texture to use. Default to Vec2(512).

OptionaldepthTextureFormat

depthTextureFormat?: GPUTextureFormat

Format of the depth Texture to use. Default to depth24plus.

OptionalautoRender

autoRender?: boolean

Whether the shadow should be automatically rendered each frame or not. Should be set to false if the scene is static and be rendered manually instead. Default to true.

OptionaluseRenderBundle

useRenderBundle?: boolean

Whether the shadow casting meshes should be rendered using a RenderBundle. Default to true.

light

light: ShadowCastingLights

The light that will be used to cast shadows.

Settings

Member Visibility

On This Page

Properties