---

title: ShadowNode category: Core layout: docs

ShadowNode

Represents the default shadow implementation for lighting nodes.

Constructor

new ShadowNode( light : Light, shadow : LightShadow )

Constructs a new shadow node.

light | The shadow casting light.
---|---
shadow | An optional light shadow. Default is null.

Properties

.depthLayer : number (readonly)

This index can be used when overriding setupRenderTarget with a RenderTarget Array to specify the depth layer.

Default is true.

.isShadowNode : boolean (readonly)

This flag can be used for type testing.

Default is true.

.shadow : LightShadow

The light shadow which defines the properties light's shadow.

Default is null.

.shadowMap : RenderTarget

A reference to the shadow map which is a render target.

Default is null.

.vsmMaterialHorizontal : NodeMaterial

Only relevant for VSM shadows. Node material which is used to render the second VSM pass.

Default is null.

.vsmMaterialVertical : NodeMaterial

Only relevant for VSM shadows. Node material which is used to render the first VSM pass.

Default is null.

.vsmShadowMapHorizontal : RenderTarget

Only relevant for VSM shadows. Render target for the second VSM render pass.

Default is null.

.vsmShadowMapVertical : RenderTarget

Only relevant for VSM shadows. Render target for the first VSM render pass.

Default is null.

Methods

.dispose()

Frees the internal resources of this shadow node.

Overrides: ShadowBaseNode#dispose

.getShadowFilterFn( type : number ) : function

Returns the shadow filtering function for the given shadow type.

type | The shadow type.
---|---

Returns: The filtering function.

.renderShadow( frame : NodeFrame )

Renders the shadow. The logic of this function could be included into ShadowNode#updateShadow however more specialized shadow nodes might require a custom shadow map rendering. By having a dedicated method, it's easier to overwrite the default behavior.

frame | A reference to the current node frame.
---|---

.setup( builder : NodeBuilder ) : ShaderCallNodeInternal

The implementation performs the setup of the output node. An output is only produces if shadow mapping is globally enabled in the renderer.

builder | A reference to the current node builder.
---|---

Overrides: ShadowBaseNode#setup

Returns: The output node.

.setupShadow( builder : NodeBuilder ) : Node.<vec3>

Setups the shadow output node.

builder | A reference to the current node builder.
---|---

Returns: The shadow output node.

.setupShadowCoord( builder : NodeBuilder, shadowPosition : Node.<vec3> ) : Node.<vec3>

Setups the shadow coordinates.

builder | A reference to the current node builder.
---|---
shadowPosition | A node representing the shadow position.

Returns: The shadow coordinates.

.setupShadowFilter( builder : NodeBuilder, inputs : Object ) : Node.<float>

Setups the shadow filtering.

builder | A reference to the current node builder.
---|---
inputs | A configuration object that defines the shadow filtering. | filterFn | This function defines the filtering type of the shadow map e.g. PCF.
---|---
depthTexture | A reference to the shadow map's texture data.
shadowCoord | Shadow coordinates which are used to sample from the shadow map.
shadow | The light shadow.

Returns: The result node of the shadow filtering.

.updateBefore( frame : NodeFrame )

The implementation performs the update of the shadow map if necessary.

frame | A reference to the current node frame.
---|---

Overrides: ShadowBaseNode#updateBefore

.updateShadow( frame : NodeFrame )

Updates the shadow.

frame | A reference to the current node frame.
---|---

.vsmPass( renderer : Renderer )

For VSM additional render passes are required.

renderer | A reference to the current renderer.
---|---

Source

src/nodes/lighting/ShadowNode.js