Pass Class

Module: Postprocessing

A render Pass is used to render something in the graphics pipeline.

Can be used to render a scene, apply post processing effects, merge buffers, etc.

Constructor

Pass

()

Item Index

Methods

dispose

()

Dispose this render pass.

render

(
  • renderer
  • writeBuffer
  • readBuffer
  • delta
  • maskActive
  • scene
)

Render the scene using this render pass.

Parameters:

  • renderer WebGLRenderer
  • writeBuffer WebGLRenderTarget

    Buffer to write output.

  • readBuffer WebGLRenderTarget

    Input buffer.

  • delta Number

    Delta time in milliseconds.

  • maskActive Boolean

    Not used in this pass.

  • scene Scene

    Scene to render.

setSize

(
  • width
  • height
)

Set resolution of this render pass.

Parameters:

  • width Number
  • height Number

toJSON

(
  • meta
)

Serialize pass to json.

Parameters:

  • meta Object

    Metadata object.

Properties

clear

Boolean

If set to true, the pass clears its buffer before rendering.

enabled

Boolean

If set to true, the pass is processed by the composer.

enabled

Boolean

If set to true, the result of the pass is rendered to screen.

needsSwap

Boolean

If set to true, the pass indicates to swap read and write buffer after rendering.