Class: ShadowMap

ShadowMap

new ShadowMap(options)

Creates a shadow map from the provided light camera. The normalOffset bias pushes the shadows forward slightly, and may be disabled for applications that require ultra precise shadows.
Parameters:
Name Type Description
options Object An object containing the following properties:
Properties
Name Type Attributes Default Description
context Context The context in which to create the shadow map.
lightCamera Camera A camera representing the light source.
enabled Boolean <optional>
 true Whether the shadow map is enabled.
isPointLight Boolean <optional>
 false Whether the light source is a point light. Point light shadows do not use cascades.
pointLightRadius Boolean <optional>
 100.0 Radius of the point light.
cascadesEnabled Boolean <optional>
 true Use multiple shadow maps to cover different partitions of the view frustum.
numberOfCascades Number <optional>
 4 The number of cascades to use for the shadow map. Supported values are one and four.
maximumDistance Number <optional>
 5000.0 The maximum distance used for generating cascaded shadows. Lower values improve shadow quality.
size Number <optional>
 2048 The width and height, in pixels, of each shadow map.
softShadows Boolean <optional>
 false Whether percentage-closer-filtering is enabled for producing softer shadows.
darkness Number <optional>
 0.3 The shadow darkness.
Source:
Throws:
Only one or four cascades are supported.
Type
DeveloperError

Members

darkness :Number

Determines the darkness of the shadows.
Type:
  • Number
Default Value:
  • 0.3
Source:

enabled :Boolean

Determines if the shadow map will be shown.
Type:
  • Boolean
Default Value:
  • true
Source:

maximumDistance :Number

Determines the maximum distance of the shadow map. Only applicable for cascaded shadows. Larger distances may result in lower quality shadows.
Type:
  • Number
Default Value:
  • 5000.0
Source:

size :Number

The width and height, in pixels, of each shadow map.
Type:
  • Number
Default Value:
  • 2048
Source:

softShadows :Boolean

Determines if soft shadows are enabled. Uses pcf filtering which requires more texture reads and may hurt performance.
Type:
  • Boolean
Default Value:
  • false
Source: