Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EffectComposer

The EffectComposer may be used in place of a normal WebGLRenderer.

The auto clear behaviour of the provided renderer will be disabled to prevent unnecessary clear operations.

It is common practice to use a {@link RenderPass} as the first pass to automatically clear the buffers and render a scene for further processing.

implements

{Resizable}

implements

{Disposable}

Hierarchy

  • EffectComposer

Implements

  • Resizable
  • Disposable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new EffectComposer(renderer?: WebGLRenderer, [options]?: { alpha?: boolean; depthBuffer?: boolean; frameBufferType?: number; multisampling?: number; stencilBuffer?: boolean }): EffectComposer

  • Constructs a new effect composer.

    Parameters

    • Optional renderer: WebGLRenderer

      The renderer that should be used.

    • Optional [options]: { alpha?: boolean; depthBuffer?: boolean; frameBufferType?: number; multisampling?: number; stencilBuffer?: boolean }

      The options.

      • Optional alpha?: boolean
      • Optional depthBuffer?: boolean
      • Optional frameBufferType?: number
      • Optional multisampling?: number
      • Optional stencilBuffer?: boolean

    Returns EffectComposer

Properties

autoRenderToScreen

autoRenderToScreen: boolean

Determines whether the last pass automatically renders to screen.

inputBuffer

inputBuffer: WebGLRenderTarget<Texture>

The input buffer.

Two identical buffers are used to avoid reading from and writing to the same render target.

outputBuffer

outputBuffer: WebGLRenderTarget<Texture>

The output buffer.

passes

passes: Pass[]

The passes.

Accessors

multisampling

  • get multisampling(): number
  • set multisampling(arg: number): void

  • The current amount of samples used for multisample anti-aliasing.

    Requires WebGL 2. Set to zero to disable multisampling.

    Returns number

  • Sets the amount of MSAA samples.

    Requires WebGL 2. Set to zero to disable multisampling.

    Parameters

    • arg: number

    Returns void

Methods

addPass

  • addPass(pass: Pass, index?: number): void

  • Adds a pass, optionally at a specific index.

    Parameters

    • pass: Pass

      A new pass.

    • Optional index: number

    Returns void

createBuffer

  • createBuffer(depthBuffer: boolean, stencilBuffer: boolean, type: number, multisampling: number): WebGLRenderTarget<Texture>

  • Creates a new render target.

    deprecated

    Create buffers manually via WebGLRenderTarget instead.

    Parameters

    • depthBuffer: boolean

      Whether the render target should have a depth buffer.

    • stencilBuffer: boolean

      Whether the render target should have a stencil buffer.

    • type: number

      The frame buffer type.

    • multisampling: number

      The number of samples to use for antialiasing.

    Returns WebGLRenderTarget<Texture>

    A new render target that equals the renderer's canvas.

dispose

  • dispose(): void

  • Disposes this composer and all passes.

    Returns void

getRenderer

  • getRenderer(): WebGLRenderer

  • Returns the renderer.

    Returns WebGLRenderer

    The renderer.

getTimer

  • getTimer(): Timer

  • Returns the internal timer.

    Returns Timer

    The timer.

removeAllPasses

  • removeAllPasses(): void

  • Removes all passes.

    Returns void

removePass

  • removePass(pass: Pass): void

  • Removes a pass.

    Parameters

    • pass: Pass

      The pass.

    Returns void

render

  • render(deltaTime?: number): void

  • Renders all enabled passes in the order in which they were added.

    Parameters

    • Optional deltaTime: number

    Returns void

replaceRenderer

  • replaceRenderer(renderer: WebGLRenderer, updateDOM?: boolean): WebGLRenderer

  • Replaces the current renderer with the given one.

    The auto clear mechanism of the provided renderer will be disabled. If the new render size differs from the previous one, all passes will be updated.

    By default, the DOM element of the current renderer will automatically be removed from its parent node and the DOM element of the new renderer will take its place.

    deprecated

    Use setRenderer instead.

    Parameters

    • renderer: WebGLRenderer

      The new renderer.

    • Optional updateDOM: boolean

      Indicates whether the old canvas should be replaced by the new one in the DOM.

    Returns WebGLRenderer

    The old renderer.

reset

  • reset(): void

  • Resets this composer by deleting all passes and creating new buffers.

    Returns void

setMainCamera

  • setMainCamera(camera: Camera): void

  • Can be used to change the main camera for all registered passes and effects.

    Parameters

    • camera: Camera

      The camera.

    Returns void

setMainScene

  • setMainScene(scene: Scene): void

  • Can be used to change the main scene for all registered passes and effects.

    Parameters

    • scene: Scene

      The scene.

    Returns void

setRenderer

  • setRenderer(renderer: WebGLRenderer): void

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

setSize

  • setSize(width: number, height: number, updateStyle?: boolean): void

  • Sets the size of the buffers, passes and the renderer.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    • Optional updateStyle: boolean

    Returns void