Class ClearPass

constructor

• new ClearPass(color?, depth?, stencil?): ClearPass

• Constructs a new clear pass.

  Parameters

  • Optionalcolor: boolean

    Determines whether the color buffer should be cleared.
  • Optionaldepth: boolean

    Determines whether the depth buffer should be cleared.
  • Optionalstencil: boolean

    Determines whether the stencil buffer should be cleared.

  Returns ClearPass

color

depth

enabled

name

needsDepthTexture

needsSwap

overrideClearAlpha

overrideClearColor

stencil

fullscreenMaterial

• get fullscreenMaterial(): Material

• The fullscreen material.

  Returns Material
• set fullscreenMaterial(arg): void

• Parameters

  • arg: Material

  Returns void

mainCamera

• set mainCamera(arg): void

• Sets the main camera.

  Parameters

  • arg: Camera

  Returns void

mainScene

• set mainScene(arg): void

• Sets the main scene.

  Parameters

  • arg: Scene

  Returns void

renderToScreen

• get renderToScreen(): boolean

• Indicates whether this pass should render to screen.

  Returns boolean
• set renderToScreen(arg): void

• Sets the render to screen flag.

  If this flag is changed, the fullscreen material will be updated as well.

  Parameters

  • arg: boolean

  Returns void

dispose

• dispose(): void

• Performs a shallow search for disposable properties and deletes them.

  The EffectComposer calls this method when it is being destroyed. You can use it independently to free memory when you're certain that you don't need this pass anymore.

  Returns void

getDepthTexture

• getDepthTexture(): Texture

• Returns the current depth texture.

  Returns Texture

  The current depth texture, or null if there is none.

getFullscreenMaterial

• getFullscreenMaterial(): Material

• Returns the current fullscreen material.

  Returns Material

  The current fullscreen material, or null if there is none.

  Deprecated

  Use fullscreenMaterial instead.

getOverrideClearAlpha

• getOverrideClearAlpha(): number

• Returns the override clear alpha. Default is -1.

  Returns number

  The clear alpha.

  Deprecated

  Use overrideClearAlpha instead.

getOverrideClearColor

• getOverrideClearColor(): Color

• Returns the override clear color. Default is null.

  Returns Color

  The clear color.

  Deprecated

  Use overrideClearColor instead.

initialize

• initialize(renderer, alpha, frameBufferType): void

• Performs initialization tasks.

  This method is called when this pass is added to an EffectComposer.

  Parameters

  • renderer: WebGLRenderer

    The renderer.
  • alpha: boolean

    Whether the renderer uses the alpha channel or not.
  • frameBufferType: number

    The type of the main frame buffers.

  Returns void

isEnabled

• isEnabled(): boolean

• Indicates whether this pass is enabled.

  Returns boolean

  Whether this pass is enabled.

  Deprecated

  Use enabled instead.

render

• render(renderer, inputBuffer, outputBuffer, deltaTime?, stencilTest?): void

• Clears the input buffer or the screen.

  Parameters

  • renderer: WebGLRenderer

    The renderer.
  • inputBuffer: WebGLRenderTarget<Texture>

    A frame buffer that contains the result of the previous pass.
  • outputBuffer: WebGLRenderTarget<Texture>

    A frame buffer that serves as the output render target unless this pass renders to screen.
  • OptionaldeltaTime: number

    The time between the last frame and the current one in seconds.
  • OptionalstencilTest: boolean

    Indicates whether a stencil mask is active.

  Returns void

setClearFlags

• setClearFlags(color, depth, stencil): void

• Sets the clear flags.

  Parameters

  • color: boolean

    Whether the color buffer should be cleared.
  • depth: boolean

    Whether the depth buffer should be cleared.
  • stencil: boolean

    Whether the stencil buffer should be cleared.

  Returns void

setDepthTexture

• setDepthTexture(depthTexture, depthPacking?): void

• Sets the depth texture.

  This method will be called automatically by the EffectComposer. You may override this method if your pass relies on the depth information of a preceding RenderPass.

  Parameters

  • depthTexture: Texture

    A depth texture.
  • OptionaldepthPacking: DepthPackingStrategies

    The depth packing.

  Returns void

setEnabled

• setEnabled(value): void

• Enables or disables this pass.

  Parameters

  • value: boolean

    Whether the pass should be enabled.

  Returns void

  Deprecated

  Use enabled instead.

setOverrideClearAlpha

• setOverrideClearAlpha(value): void

• Sets the override clear alpha.

  Parameters

  • value: number

    The clear alpha.

  Returns void

  Deprecated

  Use overrideClearAlpha instead.

setOverrideClearColor

• setOverrideClearColor(value): void

• Sets the override clear color.

  Parameters

  • value: Color

    The clear color.

  Returns void

  Deprecated

  Use overrideClearColor instead.

setRenderer

• setRenderer(renderer): void

• Sets the renderer

  Parameters

  • renderer: WebGLRenderer

    The renderer.

  Returns void

  Deprecated

setSize

• setSize(width, height): void

• Sets the size.

  You may override this method if you want to be informed about the size of the backbuffer/canvas. This method is called before initialize and every time the size of the EffectComposer changes.

  Parameters

  • width: number

    The width.
  • height: number

    The height.

  Returns void