Class EffectPass

constructor

• new EffectPass(camera?, ...effects): EffectPass

• Constructs a new effect pass.

  Parameters

  • Optionalcamera: Camera

    The main camera.
  • Rest...effects: Effect[]

    The effects that will be rendered by this pass.

  Returns EffectPass

enabled

maxTime

minTime

name

needsDepthTexture

needsSwap

dithering

• get dithering(): boolean

• Indicates whether dithering is enabled.

  Returns boolean
• set dithering(arg): void

• Parameters

  • arg: boolean

  Returns void

encodeOutput

• get encodeOutput(): boolean

• Indicates whether this pass encodes its output when rendering to screen.

  Returns boolean

  Deprecated

  Use fullscreenMaterial.encodeOutput instead.

• set encodeOutput(arg): void

• Parameters

  • arg: boolean

  Returns void

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

• Deletes disposable objects. This pass will be inoperative after this method was called!

  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.

handleEvent

• handleEvent(event): void

• Handles events.

  Parameters

  • event: Event

    An event.

  Returns void

initialize

• initialize(renderer, alpha, frameBufferType): void

• Performs initialization tasks.

  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.

recompile

• recompile(): void

• Rebuilds the shader material.

  Returns void

render

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

• Renders the effect.

  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

setDepthTexture

• setDepthTexture(depthTexture, depthPacking?): void

• Sets the depth texture.

  Parameters

  • depthTexture: Texture

    A depth texture.
  • OptionaldepthPacking: number

    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.

setRenderer

• setRenderer(renderer): void

• Sets the renderer

  Parameters

  • renderer: WebGLRenderer

    The renderer.

  Returns void

  Deprecated

setSize

• setSize(width, height): void

• Updates the size of this pass.

  Parameters

  • width: number

    The width.
  • height: number

    The height.

  Returns void