import {DepthPickingPass} from 'postprocessing'

public class | source

DepthPickingPass

Extends:

Pass → DepthCopyPass → DepthPickingPass

Indirect Implements:

A depth picking pass.

Constructor Summary

Public Constructor
public	constructor(options: Object) Constructs a new depth picking pass.

Member Summary

Public Members
public	name: string

Method Summary

Public Methods
public	readDepth(ndc: Vector2 \| Vector3): Promise<Number> Reads depth at a specific screen position.
public	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Copies depth and resolves depth picking promises.
public	setSize(width: Number, height: Number) Updates the size of this pass.

Inherited Summary

From class Pass
public get	fullscreenMaterial: Material The fullscreen material.
public set	fullscreenMaterial
public set	mainCamera: Camera Sets the main camera.
public set	mainScene: Scene Sets the main scene.
public get	renderToScreen: Boolean Sets the render to screen flag.
public set	renderToScreen
public	enabled: Boolean Indicates whether this pass is enabled.
public	name: String The name of this pass.
public	needsDepthTexture: Boolean Only relevant for subclassing.
public	needsSwap: Boolean Only relevant for subclassing.
protected	camera: Camera The camera.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
protected	scene: Scene The scene to render.
public	dispose() Performs a shallow search for disposable properties and deletes them.
public	getDepthTexture(): Texture Returns the current depth texture.
public	getFullscreenMaterial(): Material this method was deprecated. Use fullscreenMaterial instead. Returns the current fullscreen material.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	isEnabled(): Boolean this method was deprecated. Use enabled instead. Indicates whether this pass is enabled.
public abstract	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders this pass.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategy) Sets the depth texture.
public	setEnabled(value: Boolean) this method was deprecated. Use enabled instead. Enables or disables this pass.
public	setRenderer(renderer: WebGLRenderer) this method was deprecated. Sets the renderer
public	setSize(width: Number, height: Number) Sets the size.
protected	setFullscreenMaterial(value: Material) this method was deprecated. Use fullscreenMaterial instead. Sets the fullscreen material.

From class DepthCopyPass
public get	depthPacking: DepthPackingStrategies The output depth packing.
public get	texture: Texture The output depth texture.
public	fullscreenMaterial: *
public	needsDepthTexture: boolean
public	needsSwap: boolean
public	renderTarget: WebGLRenderTarget The render target.
public	getDepthPacking(): DepthPackingStrategies this method was deprecated. Use depthPacking instead. Returns the output depth packing.
public	getTexture(): Texture this method was deprecated. Use texture instead. Returns the output depth texture.
public	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Copies depth from a depth texture.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) Sets the depth texture.
public	setSize(width: Number, height: Number) Updates the size of this pass.

Public Constructors

public constructor(options: Object) source

Constructs a new depth picking pass.

Override:

DepthCopyPass#constructor

Params:

Name	Type	Attribute	Description
options	Object	optional	The options.
options.depthPacking	DepthPackingStrategies	optional default: RGBADepthPacking	The depth packing.
options.mode	Number	optional default: DepthCopyMode.SINGLE	The depth copy mode.

Public Members

public name: string source

The name of this pass.

Override:

Pass#name

Public Methods

public readDepth(ndc: Vector2 | Vector3): Promise<Number> source

Reads depth at a specific screen position.

Only one depth value can be picked per frame. Calling this method multiple times per frame will overwrite the picking coordinates. Unresolved promises will be abandoned.

Params:

Name	Type	Attribute	Description
ndc	Vector2 \| Vector3		Normalized device coordinates. Only X and Y are relevant.

Return:

Promise<Number>

A promise that returns the depth on the next frame.

Example:

const ndc = new Vector3();
const clientRect = myViewport.getBoundingClientRect();
const clientX = pointerEvent.clientX - clientRect.left;
const clientY = pointerEvent.clientY - clientRect.top;
ndc.x = (clientX / myViewport.clientWidth) * 2.0 - 1.0;
ndc.y = -(clientY / myViewport.clientHeight) * 2.0 + 1.0;
const depth = await depthPickingPass.readDepth(ndc);
ndc.z = depth * 2.0 - 1.0;

const worldPosition = ndc.unproject(camera);

public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) source

Copies depth and resolves depth picking promises.

Override:

DepthCopyPass#render

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		The renderer.
inputBuffer	WebGLRenderTarget		A frame buffer that contains the result of the previous pass.
outputBuffer	WebGLRenderTarget		A frame buffer that serves as the output render target unless this pass renders to screen.
deltaTime	Number	optional	The time between the last frame and the current one in seconds.
stencilTest	Boolean	optional	Indicates whether a stencil mask is active.

public setSize(width: Number, height: Number) source

Updates the size of this pass.

Override:

DepthCopyPass#setSize

Params:

Name	Type	Attribute	Description
width	Number		The width.
height	Number		The height.