Class LightShadow<TCamera>

Serves as a base class for the other shadow classes.

See

Type Parameters

Constructors

constructor

Properties

camera bias normalBias radius blurSamples mapSize map mapPass matrix autoUpdate needsUpdate

Methods

getViewportCount copy clone toJSON getFrustum updateMatrices getViewport getFrameExtents dispose

Constructors

constructor

Properties

camera

camera: TCamera

The light's view of the world.

Remark

This is used to generate a depth map of the scene; objects behind other objects from the light's perspective will be in shadow.

bias

bias: number

Shadow map bias, how much to add or subtract from the normalized depth when deciding whether a surface is in shadow.

Remark

The Very tiny adjustments here (in the order of 0.0001) may help reduce artifacts in shadows.

Remarks

Expects a Float

Default Value

0

normalBias

normalBias: number

Defines how much the position used to query the shadow map is offset along the object normal.

Remark

The Increasing this value can be used to reduce shadow acne especially in large scenes where light shines onto geometry at a shallow angle.

Remark

The cost is that shadows may appear distorted.

Remarks

Expects a Float

Default Value

0

radius

radius: number

Setting this to values greater than 1 will blur the edges of the shadow.toi

Remark

High values will cause unwanted banding effects in the shadows - a greater mapSize will allow for a higher value to be used here before these effects become visible. @remark If {@link THREE.WebGLRenderer.shadowMap.type | WebGLRenderer.shadowMap.type is set to PCFSoftShadowMap,
radius has no effect and it is recommended to increase softness by decreasing mapSize instead.

Remark

Note that this has no effect if the THREE.WebGLRenderer.shadowMap | WebGLRenderer.shadowMap.THREE.WebGLShadowMap.type | type
is set to THREE.BasicShadowMap | BasicShadowMap.

Remarks

Expects a Float

Default Value

1

blurSamples

blurSamples: number

The amount of samples to use when blurring a VSM shadow map.

Remarks

Expects a Integer

Default Value

8

mapSize

mapSize: Vector2

A THREE.Vector2 | Vector2 defining the width and height of the shadow map.

Remarks

Higher values give better quality shadows at the cost of computation time.

Default Value

new THREE.Vector2(512, 512)

map

map: null | WebGLRenderTarget<Texture>

The depth map generated using the internal camera; a location beyond a pixel's depth is in shadow. Computed internally during rendering.

Default Value

null

mapPass

mapPass: null | WebGLRenderTarget<Texture>

The distribution map generated using the internal camera; an occlusion is calculated based on the distribution of depths. Computed internally during rendering.

Default Value

null

matrix

matrix: Matrix4

Model to shadow camera space, to compute location and depth in shadow map.
Stored in a Matrix4.

Remarks

This is computed internally during rendering.

Default Value

new THREE.Matrix4()

autoUpdate

autoUpdate: boolean

Enables automatic updates of the light's shadow. If you do not require dynamic lighting / shadows, you may set this to false.

Default Value

true

needsUpdate

needsUpdate: boolean

When set to true, shadow maps will be updated in the next render call.
If you have set autoUpdate to false, you will need to set this property to true and then make a render call to update the light's shadow.

Default Value

false

Methods

getViewportCount

  • getViewportCount(): number

  • Used internally by the renderer to get the number of viewports that need to be rendered for this shadow.

    Returns number

copy

  • copy(source): this

  • Copies value of all the properties from the {@link LightShadow | source} to this Light.

    Parameters

    Returns this

clone

  • clone(recursive?): this

  • Creates a new LightShadow with the same properties as this one.

    Parameters

    • Optionalrecursive: boolean

    Returns this

toJSON

  • toJSON(): {}

  • Serialize this LightShadow.

    Returns {}

    getFrustum

    • getFrustum(): Frustum

    • Gets the shadow cameras frustum

      Returns Frustum

      Remarks

      Used internally by the renderer to cull objects.

    updateMatrices

    • updateMatrices(light): void

    • Update the matrices for the camera and shadow, used internally by the renderer.

      Parameters

      Returns void

    getViewport

    • getViewport(viewportIndex): Vector4

    • Parameters

      • viewportIndex: number

      Returns Vector4

    getFrameExtents

    • getFrameExtents(): Vector2

    • Used internally by the renderer to extend the shadow map to contain all viewports

      Returns Vector2

    dispose

    • dispose(): void

    • Frees the GPU-related resources allocated by this instance

      Returns void

      Remarks

      Call this method whenever this instance is no longer used in your app.

    Settings

    Member Visibility

    On This Page

    constructorcamerabiasnormalBiasradiusblurSamplesmapSizemapmapPassmatrixautoUpdateneedsUpdategetViewportCountcopyclonetoJSONgetFrustumupdateMatricesgetViewportgetFrameExtentsdispose