import {CopyPass} from 'postprocessing'

public class | source

CopyPass

Extends:

Pass → CopyPass

Indirect Implements:

A pass that copies the contents of an input buffer to another render target.

Constructor Summary

Public Constructor
public	constructor(renderTarget: WebGLRenderTarget, autoResize: Boolean) Constructs a new save pass.

Member Summary

Public Members
public	autoResize: Boolean Enables or disables auto resizing of the render target.
public	fullscreenMaterial: *
public	needsSwap: boolean
public get	resize: Boolean this get was deprecated. Use autoResize instead. Enables or disables auto resizing of the render target.
public set	resize
public get	texture: Texture The output texture.

Method Summary

Public Methods
public	getTexture(): Texture this method was deprecated. Use texture instead. Returns the output texture.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Saves the input buffer.
public	setAutoResizeEnabled(value: Boolean) this method was deprecated. Use autoResize instead. Enables or disables auto resizing of the render target.
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.

Public Constructors

public constructor(renderTarget: WebGLRenderTarget, autoResize: Boolean) source

Constructs a new save pass.

Override:

Pass#constructor

Params:

Name	Type	Attribute	Description
renderTarget	WebGLRenderTarget	optional	A render target.
autoResize	Boolean	optional default: true	Whether the render target size should be updated automatically.

Public Members

public autoResize: Boolean source

Enables or disables auto resizing of the render target.

public fullscreenMaterial: * source

The fullscreen material.

Override:

Pass#fullscreenMaterial

public needsSwap: boolean source

Only relevant for subclassing.

Indicates whether the EffectComposer should swap the frame buffers after this pass has finished rendering. Set this to false if this pass doesn't render to the output buffer or the screen. Otherwise, the contents of the input buffer will be lost.

Override:

Pass#needsSwap

public get resize: Boolean source

this get was deprecated. Use autoResize instead.

Enables or disables auto resizing of the render target.

public set resize source

public get texture: Texture source

The output texture.

Public Methods

public getTexture(): Texture source

this method was deprecated. Use texture instead.

Returns the output texture.

Return:

Texture

The texture.

public initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) source

Performs initialization tasks.

Override:

Pass#initialize

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		A renderer.
alpha	Boolean		Whether the renderer uses the alpha channel.
frameBufferType	Number		The type of the main frame buffers.

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

Saves the input buffer.

Override:

Pass#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 setAutoResizeEnabled(value: Boolean) source

this method was deprecated. Use autoResize instead.

Enables or disables auto resizing of the render target.

Params:

Name	Type	Attribute	Description
value	Boolean		Whether the render target size should be updated automatically.

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

Updates the size of this pass.

Override:

Pass#setSize

Params:

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