Interface IPass

The interface for the Pass class.

Hierarchy

  • IPass

Implemented by

Properties

Methods

Properties

enabled: boolean

Whether the Pass instance is active or not.

Default

true.

renderToScreen: boolean

Whether the render method should target a WebGLRenderTarget instance, or the frame buffer.

Default

false.

Methods

  • The render method to extend in Pass implementations.

    Parameters

    • renderer: WebGLRenderer

      The WebGLRenderer instance in use.

    • scene: Scene

      The scene to render.

    • camera: Camera

      The camera to render the scene through.

    • writeBuffer: null | WebGLRenderTarget

      The optional WebGLRenderTarget instance to write to.

    • readBuffer: null | WebGLRenderTarget

      The optional WebGLRenderTarget instance of a previous pass to write onto.

    • Optional delta: number

      The time argument from the requestAnimationFrame.

    Returns void

    Remarks

    This is the place where the desired effects or render operations are executed.

  • The resize method to extend in Pass implementations.

    Parameters

    • width: number

      Width to resize to.

    • height: number

      Height to resize to.

    Returns void

    Remarks

    It resizes the render targets. Call on resize events.

Generated using TypeDoc