Back to Three Js

ShadowMapViewer

docs/pages/ShadowMapViewer.html

latest1.4 KB
Original Source

Import

ShadowMapViewer is an addon, and must be imported explicitly, see Installation#Addons.

import { ShadowMapViewer } from 'three/addons/utils/ShadowMapViewer.js';

Constructor

new ShadowMapViewer( light : Light )

Constructs a new shadow map viewer.

| light |

The shadow casting light.

|

Properties

.enabled : boolean

Whether to display the shadow map viewer or not.

Default is true.

.position : Object

The position of the viewer. When changing this property, make sure to call ShadowMapViewer#update.

Default is true.

.size : Object

The size of the viewer. When changing this property, make sure to call ShadowMapViewer#update.

Default is true.

Methods

.render( renderer : WebGLRenderer )

Renders the viewer. This method must be called in the app's animation loop.

| renderer |

The renderer.

|

.update()

Updates the viewer.

.updateForWindowResize()

Resizes the viewer. This method should be called whenever the app's window is resized.

Source

examples/jsm/utils/ShadowMapViewer.js