TSL Docs

getShadowRenderObjectFunction

Last modified: Dec 2, 2025

Creates a function to render shadow objects in a scene.

Parameter	Type	Default Value
renderer	`Renderer`	—
shadow	`LightShadow`	—
shadowType	`number`	—
useVelocity	`boolean`	—

Returns

shadowRenderObjectFunction

ShadowNode

Represents the default shadow implementation for lighting nodes.

Constructor

new ShadowNode(light, shadow?)

Parameter	Type	Default Value
light	`Light`	—
shadow?	`any`	`null`

Constructs a new shadow node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type
shadow	`any`	—
shadowMap	`any`	—
vsmShadowMapVertical	`any`	—
vsmShadowMapHorizontal	`any`	—
vsmMaterialVertical	`null \| NodeMaterial`	—
vsmMaterialHorizontal	`null \| NodeMaterial`	—
_node	`null \| Node`	—
_currentShadowType	`null \| number`	—
_cameraFrameId	`WeakMap<Camera, number>`	—
isShadowNode	`boolean`	—
depthLayer	`number`	—
_depthVersionCached	`any`	—

Method Type

setupShadowFilter (builder: NodeBuilder, { filterFn, depthTexture, shadowCoord, shadow, depthLayer }: { filterFn: Function; depthTexture: DepthTexture; shadowCoord: Node<…>; shadow: LightShadow; }) => any

Setups the shadow filtering.

Parameter	Type	Default Value
builder	`NodeBuilder`	—
{ filterFn, depthTexture, shadowCoord, shadow, depthLayer }	`{ filterFn: Function; depthTexture: DepthTexture; shadowCoord: Node<any>; shadow: LightShadow; }`	—

Returns

any

setupShadowCoord (builder: NodeBuilder, shadowPosition: Node<…>) => any

Setups the shadow coordinates.

Parameter	Type	Default Value
builder	`NodeBuilder`	—
shadowPosition	`Node<vec3>`	—

Returns

any

getShadowFilterFn (type: number) => Function

Returns the shadow filtering function for the given shadow type.

Parameter	Type	Default Value
type	`number`	—

Returns

Function

setupRenderTarget (shadow: any, builder: any) => { shadowMap: any; depthTexture: DepthTexture; }

Parameter	Type	Default Value
shadow	`any`	—
builder	`any`	—

Returns

Property	Type	Modifiers
shadowMap	`any`	`—`
depthTexture	`DepthTexture`	`—`

setupShadow (builder: NodeBuilder) => any

Setups the shadow output node.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

any

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.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

ShaderCallNodeInternal

renderShadow (frame: NodeFrame) => void

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.

Parameter	Type	Default Value
frame	`NodeFrame`	—

Returns

void

updateShadow (frame: NodeFrame) => void

Updates the shadow.

Parameter	Type	Default Value
frame	`NodeFrame`	—

Returns

void

vsmPass (renderer: Renderer) => void

For VSM additional render passes are required.

Parameter	Type	Default Value
renderer	`Renderer`	—

Returns

void

dispose () => void

Frees the internal resources of this shadow node.

Returns

void

_reset () => void

Resets the resouce state of this shadow node.

Returns

void

updateBefore (frame: NodeFrame) => void

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

Parameter	Type	Default Value
frame	`NodeFrame`	—

Returns

void

Extends

ShadowBaseNode

shadow

Shadow Render Object Function.

TSL function for creating an instance of ShadowNode.

Parameter	Type	Default Value
light	`Light`	—
shadow?	`any`	—

Returns

ShadowNode