Class EffectComposer

constructor

• new EffectComposer(renderer?, options?): 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

      Deprecated. Buffers are always RGBA since three r137.

    • Optional depthBuffer?: boolean

      Whether the main render targets should have a depth buffer.

    • Optional frameBufferType?: number

      The type of the internal frame buffers. It's recommended to use HalfFloatType if possible.

    • Optional multisampling?: number

      The number of samples used for multisample antialiasing. Requires WebGL 2.

    • Optional stencilBuffer?: boolean

      Whether the main render targets should have a stencil buffer.

  Returns EffectComposer

autoRenderToScreen

inputBuffer

outputBuffer

passes

multisampling

• get multisampling(): number

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

  Returns number
• set multisampling(arg): void

• Sets the amount of MSAA samples.

  Requires WebGL 2. Set to zero to disable multisampling.

  Parameters

  • arg: number

  Returns void

addPass

• addPass(pass, index?): void

• Adds a pass, optionally at a specific index.

  Parameters

  • pass: Pass

    A new pass.

  • Optional index: number

    An index at which the pass should be inserted.

  Returns void

createBuffer

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

• Creates a new render target.

  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.

  Deprecated

  Create buffers manually via WebGLRenderTarget instead.

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

• Removes a pass.

  Parameters

  • pass: Pass

    The pass.

  Returns void

render

• render(deltaTime?): void

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

  Parameters

  • Optional deltaTime: number

    The time since the last frame in seconds.

  Returns void

replaceRenderer

• replaceRenderer(renderer, updateDOM?): 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.

  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.

  Deprecated

  Use setRenderer instead.

reset

• reset(): void

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

  Returns void

setMainCamera

• setMainCamera(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): 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): void

• Sets the renderer.

  Parameters

  • renderer: WebGLRenderer

    The renderer.

  Returns void

setSize

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

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

  Parameters

  • width: number

    The width.

  • height: number

    The height.

  • Optional updateStyle: boolean

    Determines whether the style of the canvas should be updated.

  Returns void