---

title: StereoCompositePassNode category: Addons layout: docs

StereoCompositePassNode

A special (abstract) render pass node that renders the scene as a stereoscopic image. Unlike StereoPassNode, this node merges the image for the left and right eye into a single one. That is required for effects like anaglyph or parallax barrier.

Import

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

import { StereoCompositePassNode } from 'three/addons/tsl/display/StereoCompositePassNode.js';

Constructor

new StereoCompositePassNode( scene : Scene, camera : Camera ) (abstract)

Constructs a new stereo composite pass node.

scene | The scene to render.
---|---
camera | The camera to render the scene with.

Properties

.isStereoCompositePassNode : boolean (readonly)

This flag can be used for type testing.

Default is true.

.stereo : StereoCamera

The internal stereo camera that is used to render the scene.

Methods

.dispose()

Frees internal resources. This method should be called when the pass is no longer required.

Overrides: PassNode#dispose

.setSize( width : number, height : number )

Sets the size of the pass.

width | The width of the pass.
---|---
height | The height of the pass.

Overrides: PassNode#setSize

.updateBefore( frame : NodeFrame )

This method is used to render the effect once per frame.

frame | The current node frame.
---|---

Overrides: PassNode#updateBefore

.updateStereoCamera( coordinateSystem : number )

Updates the internal stereo camera.

coordinateSystem | The current coordinate system.
---|---

Source

examples/jsm/tsl/display/StereoCompositePassNode.js