API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CascadedShadowGenerator

A CSM implementation allowing casting shadows on large scenes. Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates a Cascaded Shadow Generator object. A ShadowGenerator is the required tool to use the shadows. Each directional light casting shadows needs to use its own ShadowGenerator. Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows

    Parameters

    • mapSize: number

      The size of the texture what stores the shadows. Example : 1024.

    • light: DirectionalLight

      The directional light object generating the shadows.

    • Optional usefulFloatFirst: boolean

      By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.

    • Optional camera: Nullable<Camera>

      Camera associated with this shadow generator (default: null). If null, takes the scene active camera at the time we need to access it

    • Optional useRedTextureType: boolean

      Forces the generator to use a Red instead of a RGBA type for the shadow map texture format (default: true)

    Returns CascadedShadowGenerator

Properties

customAllowRenderingSearch playground for customAllowRendering

customAllowRendering: ((subMesh: SubMesh) => boolean)

Gets or sets a custom function to allow/disallow rendering a sub mesh in the shadow map

Type declaration

    • Gets or sets a custom function to allow/disallow rendering a sub mesh in the shadow map

      Parameters

      Returns boolean

customShaderOptionsSearch playground for customShaderOptions

customShaderOptions: ICustomShaderOptions

Gets or sets the custom shader name to use

enableSoftTransparentShadowSearch playground for enableSoftTransparentShadow

enableSoftTransparentShadow: boolean

Enables or disables shadows with varying strength based on the transparency When it is enabled, the strength of the shadow is taken equal to mesh.visibility If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength: mesh.visibility * alphaTexture.a The texture used is the diffuse by default, but it can be set to the opacity by setting useOpacityTextureForTransparentShadow Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!

forceBackFacesOnlySearch playground for forceBackFacesOnly

forceBackFacesOnly: boolean

If true the shadow map is generated by rendering the back face of the mesh instead of the front face. This can help with self-shadowing as the geometry making up the back of objects is slightly offset. It might on the other hand introduce peter panning.

frustumEdgeFalloffSearch playground for frustumEdgeFalloff

frustumEdgeFalloff: number

Controls the extent to which the shadows fade out at the edge of the frustum

idSearch playground for id

id: string

Gets or set the id of the shadow generator. It will be the one from the light if not defined

onAfterShadowMapRenderMeshObservableSearch playground for onAfterShadowMapRenderMeshObservable

onAfterShadowMapRenderMeshObservable: Observable<Mesh>

Observable triggered after a mesh is rendered in the shadow map. Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)

onAfterShadowMapRenderObservableSearch playground for onAfterShadowMapRenderObservable

onAfterShadowMapRenderObservable: Observable<Effect>

Observable triggered after the shadow is rendered. Can be used to restore internal effect state

onBeforeShadowMapRenderMeshObservableSearch playground for onBeforeShadowMapRenderMeshObservable

onBeforeShadowMapRenderMeshObservable: Observable<Mesh>

Observable triggered before a mesh is rendered in the shadow map. Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)

onBeforeShadowMapRenderObservableSearch playground for onBeforeShadowMapRenderObservable

onBeforeShadowMapRenderObservable: Observable<Effect>

Observable triggered before the shadow is rendered. Can be used to update internal effect state

penumbraDarknessSearch playground for penumbraDarkness

penumbraDarkness: number

Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)

stabilizeCascadesSearch playground for stabilizeCascades

stabilizeCascades: boolean

Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera. The trade off is that you lose some precision in the shadow rendering when enabling this setting.

useOpacityTextureForTransparentShadowSearch playground for useOpacityTextureForTransparentShadow

useOpacityTextureForTransparentShadow: boolean

If this is true, use the opacity texture's alpha channel for transparent shadows instead of the diffuse one

Static CLASSNAMESearch playground for CLASSNAME

CLASSNAME: string

Name of the CSM class

Static DEFAULT_ALPHA_CUTOFFSearch playground for DEFAULT_ALPHA_CUTOFF

DEFAULT_ALPHA_CUTOFF: number

Defines the default alpha cutoff value used for transparent alpha tested materials.

Static Readonly DEFAULT_CASCADES_COUNTSearch playground for DEFAULT_CASCADES_COUNT

DEFAULT_CASCADES_COUNT: 4 = 4

Defines the default number of cascades used by the CSM.

Static Readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAPSearch playground for FILTER_BLURCLOSEEXPONENTIALSHADOWMAP

FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: 5 = 5

Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing edge artifacts on steep falloff. (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)

Static Readonly FILTER_BLUREXPONENTIALSHADOWMAPSearch playground for FILTER_BLUREXPONENTIALSHADOWMAP

FILTER_BLUREXPONENTIALSHADOWMAP: 3 = 3

Shadow generator mode ESM: Blurred Exponential Shadow Mapping. (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)

Static Readonly FILTER_CLOSEEXPONENTIALSHADOWMAPSearch playground for FILTER_CLOSEEXPONENTIALSHADOWMAP

FILTER_CLOSEEXPONENTIALSHADOWMAP: 4 = 4

Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing edge artifacts on steep falloff. (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)

Static Readonly FILTER_EXPONENTIALSHADOWMAPSearch playground for FILTER_EXPONENTIALSHADOWMAP

FILTER_EXPONENTIALSHADOWMAP: 1 = 1

Shadow generator mode ESM: Exponential Shadow Mapping. (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)

Static Readonly FILTER_NONESearch playground for FILTER_NONE

FILTER_NONE: 0 = 0

Shadow generator mode None: no filtering applied.

Static Readonly FILTER_PCFSearch playground for FILTER_PCF

FILTER_PCF: 6 = 6

Shadow generator mode PCF: Percentage Closer Filtering benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1 (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)

Static Readonly FILTER_PCSSSearch playground for FILTER_PCSS

FILTER_PCSS: 7 = 7

Shadow generator mode PCSS: Percentage Closering Soft Shadow. benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1 Contact Hardening

Static Readonly FILTER_POISSONSAMPLINGSearch playground for FILTER_POISSONSAMPLING

FILTER_POISSONSAMPLING: 2 = 2

Shadow generator mode Poisson Sampling: Percentage Closer Filtering. (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)

Static MAX_CASCADES_COUNTSearch playground for MAX_CASCADES_COUNT

MAX_CASCADES_COUNT: number

Defines the maximum number of cascades used by the CSM.

Static MIN_CASCADES_COUNTSearch playground for MIN_CASCADES_COUNT

MIN_CASCADES_COUNT: number

Defines the minimum number of cascades used by the CSM.

Static Readonly QUALITY_HIGHSearch playground for QUALITY_HIGH

QUALITY_HIGH: 0 = 0

Reserved for PCF and PCSS Highest Quality.

Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.

Execute PCSS with 32 taps blocker search and 64 taps PCF.

Static Readonly QUALITY_LOWSearch playground for QUALITY_LOW

QUALITY_LOW: 2 = 2

Reserved for PCF and PCSS The lowest quality but the fastest.

Execute PCF on a 1*1 kernel.

Execute PCSS with 16 taps blocker search and 16 taps PCF.

Static Readonly QUALITY_MEDIUMSearch playground for QUALITY_MEDIUM

QUALITY_MEDIUM: 1 = 1

Reserved for PCF and PCSS Good tradeoff for quality/perf cross devices

Execute PCF on a 3*3 kernel.

Execute PCSS with 16 taps blocker search and 32 taps PCF.

Accessors

autoCalcDepthBounds

  • get autoCalcDepthBounds(): boolean
  • set autoCalcDepthBounds(value: boolean): void

  • Gets or sets the autoCalcDepthBounds property.

    When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function. It can greatly enhance the shadow quality, at the expense of more GPU works. When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.

    Returns boolean

  • Gets or sets the autoCalcDepthBounds property.

    When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function. It can greatly enhance the shadow quality, at the expense of more GPU works. When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.

    Parameters

    • value: boolean

    Returns void

autoCalcDepthBoundsRefreshRate

  • get autoCalcDepthBoundsRefreshRate(): number
  • set autoCalcDepthBoundsRefreshRate(value: number): void

  • Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on... Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible for setting the refresh rate on the renderer yourself!

    Returns number

  • Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on... Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible for setting the refresh rate on the renderer yourself!

    Parameters

    • value: number

    Returns void

bias

  • get bias(): number
  • set bias(bias: number): void

  • Gets the bias: offset applied on the depth preventing acnea (in light direction).

    Returns number

  • Sets the bias: offset applied on the depth preventing acnea (in light direction).

    Parameters

    • bias: number

    Returns void

blurBoxOffset

  • get blurBoxOffset(): number
  • set blurBoxOffset(value: number): void

  • Gets the blur box offset: offset applied during the blur pass. Only useful if useKernelBlur = false

    Returns number

  • Sets the blur box offset: offset applied during the blur pass. Only useful if useKernelBlur = false

    Parameters

    • value: number

    Returns void

blurKernel

  • get blurKernel(): number
  • set blurKernel(value: number): void

  • Gets the blur kernel: kernel size of the blur pass. Only useful if useKernelBlur = true

    Returns number

  • Sets the blur kernel: kernel size of the blur pass. Only useful if useKernelBlur = true

    Parameters

    • value: number

    Returns void

blurScale

  • get blurScale(): number
  • set blurScale(value: number): void

  • Gets the blur scale: scale of the blurred texture compared to the main shadow map. 2 means half of the size.

    Returns number

  • Sets the blur scale: scale of the blurred texture compared to the main shadow map. 2 means half of the size.

    Parameters

    • value: number

    Returns void

cascadeBlendPercentage

  • get cascadeBlendPercentage(): number
  • set cascadeBlendPercentage(value: number): void

  • Gets or sets the percentage of blending between two cascades (value between 0. and 1.). It defaults to 0.1 (10% blending).

    Returns number

  • Gets or sets the percentage of blending between two cascades (value between 0. and 1.). It defaults to 0.1 (10% blending).

    Parameters

    • value: number

    Returns void

contactHardeningLightSizeUVRatio

  • get contactHardeningLightSizeUVRatio(): number
  • set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number): void

  • Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size. Using a ratio helps keeping shape stability independently of the map size.

    It does not account for the light projection as it was having too much instability during the light setup or during light position changes.

    Only valid if useContactHardeningShadow is true.

    Returns number

  • Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size. Using a ratio helps keeping shape stability independently of the map size.

    It does not account for the light projection as it was having too much instability during the light setup or during light position changes.

    Only valid if useContactHardeningShadow is true.

    Parameters

    • contactHardeningLightSizeUVRatio: number

    Returns void

darkness

  • get darkness(): number
  • set darkness(value: number): void

  • Gets or sets the actual darkness of a shadow

    Returns number

  • Gets or sets the actual darkness of a shadow

    Parameters

    • value: number

    Returns void

debug

  • get debug(): boolean
  • set debug(dbg: boolean): void

  • Gets or sets the debug flag. When enabled, the cascades are materialized by different colors on the screen.

    Returns boolean

  • Gets or sets the debug flag. When enabled, the cascades are materialized by different colors on the screen.

    Parameters

    • dbg: boolean

    Returns void

depthClamp

  • get depthClamp(): boolean
  • set depthClamp(value: boolean): void

  • Gets or sets the depth clamping value.

    When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted to account for the shadow casters far away.

    Note that this property is incompatible with PCSS filtering, so it won't be used in that case.

    Returns boolean

  • Gets or sets the depth clamping value.

    When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted to account for the shadow casters far away.

    Note that this property is incompatible with PCSS filtering, so it won't be used in that case.

    Parameters

    • value: boolean

    Returns void

depthScale

  • get depthScale(): number
  • set depthScale(value: number): void

  • Gets the depth scale used in ESM mode.

    Returns number

  • Sets the depth scale used in ESM mode. This can override the scale stored on the light.

    Parameters

    • value: number

    Returns void

filter

  • get filter(): number
  • set filter(value: number): void

  • Gets the current mode of the shadow generator (normal, PCF, ESM...). The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE

    Returns number

  • Sets the current mode of the shadow generator (normal, PCF, ESM...). The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE

    Parameters

    • value: number

    Returns void

filteringQuality

  • get filteringQuality(): number
  • set filteringQuality(filteringQuality: number): void

  • Gets the PCF or PCSS Quality. Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.

    Returns number

  • Sets the PCF or PCSS Quality. Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.

    Parameters

    • filteringQuality: number

    Returns void

freezeShadowCastersBoundingInfo

  • get freezeShadowCastersBoundingInfo(): boolean
  • set freezeShadowCastersBoundingInfo(freeze: boolean): void

  • Enables or disables the shadow casters bounding info computation. If your shadow casters don't move, you can disable this feature. If it is enabled, the bounding box computation is done every frame.

    Returns boolean

  • Enables or disables the shadow casters bounding info computation. If your shadow casters don't move, you can disable this feature. If it is enabled, the bounding box computation is done every frame.

    Parameters

    • freeze: boolean

    Returns void

lambda

  • get lambda(): number
  • set lambda(value: number): void

  • Gets or set the lambda parameter. This parameter is used to split the camera frustum and create the cascades. It's a value between 0. and 1.: If 0, the split is a uniform split of the frustum, if 1 it is a logarithmic split. For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.

    Returns number

  • Gets or set the lambda parameter. This parameter is used to split the camera frustum and create the cascades. It's a value between 0. and 1.: If 0, the split is a uniform split of the frustum, if 1 it is a logarithmic split. For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.

    Parameters

    • value: number

    Returns void

mapSize

  • get mapSize(): number
  • set mapSize(size: number): void

  • Gets or sets the size of the texture what stores the shadows

    Returns number

  • Gets or sets the size of the texture what stores the shadows

    Parameters

    • size: number

    Returns void

maxDistance

  • get maxDistance(): number

  • Gets the maximal distance used in the cascade break computation

    Returns number

minDistance

  • get minDistance(): number

  • Gets the minimal distance used in the cascade break computation

    Returns number

normalBias

  • get normalBias(): number
  • set normalBias(normalBias: number): void

  • Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportional to the light/normal angle).

    Returns number

  • Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportional to the light/normal angle).

    Parameters

    • normalBias: number

    Returns void

numCascades

  • get numCascades(): number
  • set numCascades(value: number): void

  • Gets or set the number of cascades used by the CSM.

    Returns number

  • Gets or set the number of cascades used by the CSM.

    Parameters

    • value: number

    Returns void

shadowCastersBoundingInfo

  • Gets or sets the shadow casters bounding info. If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo so that the system won't overwrite the bounds you provide

    Returns BoundingInfo

  • Gets or sets the shadow casters bounding info. If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo so that the system won't overwrite the bounds you provide

    Parameters

    Returns void

shadowMaxZ

  • get shadowMaxZ(): number
  • set shadowMaxZ(value: number): void

  • Gets the shadow max z distance. It's the limit beyond which shadows are not displayed. It defaults to camera.maxZ

    Returns number

  • Sets the shadow max z distance.

    Parameters

    • value: number

    Returns void

transparencyShadow

  • get transparencyShadow(): boolean
  • set transparencyShadow(value: boolean): void

  • Gets or sets the ability to have transparent shadow

    Returns boolean

  • Gets or sets the ability to have transparent shadow

    Parameters

    • value: boolean

    Returns void

useBlurCloseExponentialShadowMap

  • get useBlurCloseExponentialShadowMap(): boolean
  • set useBlurCloseExponentialShadowMap(value: boolean): void

  • Gets if the current filter is set to filtered "close ESM" (using the inverse of the exponential to prevent steep falloff artifacts).

    Returns boolean

  • Sets the current filter to filtered "close ESM" (using the inverse of the exponential to prevent steep falloff artifacts).

    Parameters

    • value: boolean

    Returns void

useBlurExponentialShadowMap

  • get useBlurExponentialShadowMap(): boolean
  • set useBlurExponentialShadowMap(value: boolean): void

  • Gets if the current filter is set to filtered ESM.

    Returns boolean

  • Gets if the current filter is set to filtered ESM.

    Parameters

    • value: boolean

    Returns void

useCloseExponentialShadowMap

  • get useCloseExponentialShadowMap(): boolean
  • set useCloseExponentialShadowMap(value: boolean): void

  • Gets if the current filter is set to "close ESM" (using the inverse of the exponential to prevent steep falloff artifacts).

    Returns boolean

  • Sets the current filter to "close ESM" (using the inverse of the exponential to prevent steep falloff artifacts).

    Parameters

    • value: boolean

    Returns void

useContactHardeningShadow

  • get useContactHardeningShadow(): boolean
  • set useContactHardeningShadow(value: boolean): void

  • Gets if the current filter is set to "PCSS" (contact hardening).

    Returns boolean

  • Sets the current filter to "PCSS" (contact hardening).

    Parameters

    • value: boolean

    Returns void

useExponentialShadowMap

  • get useExponentialShadowMap(): boolean
  • set useExponentialShadowMap(value: boolean): void

  • Gets if the current filter is set to ESM.

    Returns boolean

  • Sets the current filter is to ESM.

    Parameters

    • value: boolean

    Returns void

useKernelBlur

  • get useKernelBlur(): boolean
  • set useKernelBlur(value: boolean): void

  • Gets whether the blur pass is a kernel blur (if true) or box blur. Only useful in filtered mode (useBlurExponentialShadowMap...)

    Returns boolean

  • Sets whether the blur pass is a kernel blur (if true) or box blur. Only useful in filtered mode (useBlurExponentialShadowMap...)

    Parameters

    • value: boolean

    Returns void

usePercentageCloserFiltering

  • get usePercentageCloserFiltering(): boolean
  • set usePercentageCloserFiltering(value: boolean): void

  • Gets if the current filter is set to "PCF" (percentage closer filtering).

    Returns boolean

  • Sets the current filter to "PCF" (percentage closer filtering).

    Parameters

    • value: boolean

    Returns void

usePoissonSampling

  • get usePoissonSampling(): boolean
  • set usePoissonSampling(value: boolean): void

  • Gets if the current filter is set to Poisson Sampling.

    Returns boolean

  • Sets the current filter to Poisson Sampling.

    Parameters

    • value: boolean

    Returns void

Static IsSupported

  • get IsSupported(): boolean

  • Support test.

    Returns boolean

Methods

addShadowCasterSearch playground for addShadowCaster

  • Helper function to add a mesh and its descendants to the list of shadow casters.

    Parameters

    • mesh: AbstractMesh

      Mesh to add

    • Optional includeDescendants: boolean

      boolean indicating if the descendants should be added. Default to true

    Returns ShadowGenerator

    the Shadow Generator itself

bindShadowLightSearch playground for bindShadowLight

  • bindShadowLight(lightIndex: string, effect: Effect): void

  • Binds the shadow related information inside of an effect (information like near, far, darkness... defined in the generator but impacting the effect).

    Parameters

    • lightIndex: string

      Index of the light in the enabled light list of the material owning the effect

    • effect: Effect

      The effect we are binfing the information for

    Returns void

disposeSearch playground for dispose

  • dispose(): void

  • Disposes the ShadowGenerator. Returns nothing.

    Returns void

forceCompilationSearch playground for forceCompilation

  • forceCompilation(onCompiled?: ((generator: IShadowGenerator) => void), options?: Partial<{ useInstances: boolean }>): void

  • Forces all the attached effect to compile to enable rendering only once ready vs. lazily compiling effects.

    Parameters

    • Optional onCompiled: ((generator: IShadowGenerator) => void)

      Callback triggered at the and of the effects compilation

    • Optional options: Partial<{ useInstances: boolean }>

      Sets of optional options forcing the compilation with different modes

    Returns void

forceCompilationAsyncSearch playground for forceCompilationAsync

  • forceCompilationAsync(options?: Partial<{ useInstances: boolean }>): Promise<void>

  • Forces all the attached effect to compile to enable rendering only once ready vs. lazily compiling effects.

    Parameters

    • Optional options: Partial<{ useInstances: boolean }>

      Sets of optional options forcing the compilation with different modes

    Returns Promise<void>

    A promise that resolves when the compilation completes

getCascadeMaxExtentsSearch playground for getCascadeMaxExtents

  • Gets a cascade maximum extents

    Parameters

    • cascadeIndex: number

      index of the cascade

    Returns Nullable<Vector3>

    the maximum cascade extents

getCascadeMinExtentsSearch playground for getCascadeMinExtents

  • Gets a cascade minimum extents

    Parameters

    • cascadeIndex: number

      index of the cascade

    Returns Nullable<Vector3>

    the minimum cascade extents

getCascadeProjectionMatrixSearch playground for getCascadeProjectionMatrix

  • Gets the projection matrix corresponding to a given cascade

    Parameters

    • cascadeNum: number

      cascade to retrieve the projection matrix from

    Returns Nullable<Matrix>

    the cascade projection matrix

getCascadeTransformMatrixSearch playground for getCascadeTransformMatrix

  • Gets the transformation matrix corresponding to a given cascade

    Parameters

    • cascadeNum: number

      cascade to retrieve the transformation matrix from

    Returns Nullable<Matrix>

    the cascade transformation matrix

getCascadeViewMatrixSearch playground for getCascadeViewMatrix

  • Gets the view matrix corresponding to a given cascade

    Parameters

    • cascadeNum: number

      cascade to retrieve the view matrix from

    Returns Nullable<Matrix>

    the cascade view matrix

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Gets the class name of that object

    Returns string

    "CascadedShadowGenerator"

getDarknessSearch playground for getDarkness

  • getDarkness(): number

  • Returns the darkness value (float). This can only decrease the actual darkness of a shadow. 0 means strongest and 1 would means no shadow.

    Returns number

    the darkness.

getLightSearch playground for getLight

getShadowMapSearch playground for getShadowMap

  • Gets the main RTT containing the shadow map (usually storing depth from the light point of view).

    Returns Nullable<RenderTargetTexture>

    The render target texture if present otherwise, null

getShadowMapForRenderingSearch playground for getShadowMapForRendering

getTransformMatrixSearch playground for getTransformMatrix

  • Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view. (eq to view projection * shadow projection matrices)

    Returns Matrix

    The transform matrix used to create the shadow map

isReadySearch playground for isReady

  • isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean

  • Determine whether the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).

    Parameters

    • subMesh: SubMesh

      The submesh we want to render in the shadow map

    • useInstances: boolean

      Defines whether will draw in the map using instances

    • isTransparent: boolean

      Indicates that isReady is called for a transparent subMesh

    Returns boolean

    true if ready otherwise, false

prepareDefinesSearch playground for prepareDefines

  • prepareDefines(defines: any, lightIndex: number): void

  • Prepare all the defines in a material relying on a shadow map at the specified light index.

    Parameters

    • defines: any

      Defines of the material we want to update

    • lightIndex: number

      Index of the light in the enabled light list of the material

    Returns void

recreateShadowMapSearch playground for recreateShadowMap

  • recreateShadowMap(): void

  • Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between Cube and 2D textures for instance.

    Returns void

removeShadowCasterSearch playground for removeShadowCaster

  • Helper function to remove a mesh and its descendants from the list of shadow casters

    Parameters

    • mesh: AbstractMesh

      Mesh to remove

    • Optional includeDescendants: boolean

      boolean indicating if the descendants should be removed. Default to true

    Returns ShadowGenerator

    the Shadow Generator itself

serializeSearch playground for serialize

  • serialize(): any

  • Serializes the shadow generator setup to a json object.

    Returns any

    The serialized JSON object

setDarknessSearch playground for setDarkness

  • Sets the darkness value (float). This can only decrease the actual darkness of a shadow.

    Parameters

    • darkness: number

      The darkness value 0 means strongest and 1 would means no shadow.

    Returns ShadowGenerator

    the shadow generator allowing fluent coding.

setDepthRendererSearch playground for setDepthRenderer

  • Sets the depth renderer to use when autoCalcDepthBounds is enabled.

    Note that if no depth renderer is set, a new one will be automatically created internally when necessary.

    You should call this function if you already have a depth renderer enabled in your scene, to avoid doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!

    Parameters

    • depthRenderer: Nullable<DepthRenderer>

      The depth renderer to use when autoCalcDepthBounds is enabled. If you pass null or don't call this function at all, a depth renderer will be automatically created

    Returns void

setMinMaxDistanceSearch playground for setMinMaxDistance

  • setMinMaxDistance(min: number, max: number): void

  • Sets the minimal and maximal distances to use when computing the cascade breaks.

    The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame. If you don't know these values, simply leave them to their defaults and don't call this function.

    Parameters

    • min: number

      minimal distance for the breaks (default to 0.)

    • max: number

      maximal distance for the breaks (default to 1.)

    Returns void

setTransparencyShadowSearch playground for setTransparencyShadow

  • Sets the ability to have transparent shadow (boolean).

    Parameters

    • transparent: boolean

      True if transparent else False

    Returns ShadowGenerator

    the shadow generator allowing fluent coding

splitFrustumSearch playground for splitFrustum

  • splitFrustum(): void

  • Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes. This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if you change the camera near/far planes!

    Returns void

Static ParseSearch playground for Parse

  • Parses a serialized ShadowGenerator and returns a new ShadowGenerator.

    Parameters

    • parsedShadowGenerator: any

      The JSON object to parse

    • scene: Scene

      The scene to create the shadow map for

    Returns ShadowGenerator

    The parsed shadow generator

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static property
  • Static method

Settings

Theme