Home Reference Source
import {SavePass} from 'postprocessing'
public class | source

SavePass

Extends:

Pass → SavePass

Indirect Implements:

A pass that renders the result from a previous pass to another render target.

Constructor Summary

Public Constructor
public

constructor(renderTarget: WebGLRenderTarget, resize: Boolean)

Constructs a new save pass.

Member Summary

Public Members
public
public

renderTarget: WebGLRenderTarget

The render target.

public

Indicates whether the render target should be resized automatically.

public get

texture: Texture

The saved texture.

Method Summary

Public Methods
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

setSize(width: Number, height: Number)

Updates the size of this pass.

Inherited Summary

From class Pass
public get

Indicates whether this pass should render to screen.

public set

Sets the render to screen flag.

public
this member was deprecated. Use isEnabled() and setEnabled() instead.

Indicates whether this pass is enabled.

public

The name of this pass.

public

Only relevant for subclassing.

public

Only relevant for subclassing.

protected

camera: Camera

The camera.

protected

scene: Scene

The scene to render.

public

Performs a shallow search for disposable properties and deletes them.

public

getDepthTexture(): Texture

Returns the current depth texture.

public

getFullscreenMaterial(): Material

Returns the current fullscreen material.

public

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

Performs initialization tasks.

public

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: Number)

Sets the depth texture.

public

setEnabled(enabled: Boolean)

Enables or disables this pass.

public

setSize(width: Number, height: Number)

Updates this pass with the renderer's size.

You may override this method in case you want to be informed about the size of the main frame buffer.

The EffectComposer calls this method before this pass is initialized and every time its own size is updated.

protected

setFullscreenMaterial(material: Material)

Sets the fullscreen material.

Public Constructors

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

Constructs a new save pass.

Override:

Pass#constructor

Params:

NameTypeAttributeDescription
renderTarget WebGLRenderTarget
  • optional

A render target.

resize Boolean
  • optional
  • default: true

Whether the render target should adjust to the size of the input buffer.

Public Members

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 renderTarget: WebGLRenderTarget source

The render target.

public resize: Boolean source

Indicates whether the render target should be resized automatically.

public get texture: Texture source

The saved texture.

Public Methods

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

Performs initialization tasks.

Override:

Pass#initialize

Params:

NameTypeAttributeDescription
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:

NameTypeAttributeDescription
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:

Pass#setSize

Params:

NameTypeAttributeDescription
width Number

The width.

height Number

The height.