Class NormalPass

A pass that renders the normals of a given scene.

Hierarchy (view full)

Constructors

  • Constructs a new normal pass.

    Parameters

    • Optional scene: Scene

      The scene to render.

    • Optional camera: Camera

      The camera to use to render the scene.

    • Optional options: {
          height?: number;
          renderTarget?: WebGLRenderTarget<Texture>;
          resolutionScale?: number;
          resolutionX?: number;
          resolutionY?: number;
          width?: number;
      }

      The options.

      • Optional height?: number

        Deprecated. Use resolutionY instead.

      • Optional renderTarget?: WebGLRenderTarget<Texture>

        A custom render target.

      • Optional resolutionScale?: number

        The resolution scale.

      • Optional resolutionX?: number

        The horizontal resolution.

      • Optional resolutionY?: number

        The vertical resolution.

      • Optional width?: number

        Deprecated. Use resolutionX instead.

    Returns NormalPass

Properties

camera: Camera

The camera.

enabled: boolean

Indicates whether this pass is enabled.

name: string

The name of this pass.

needsDepthTexture: boolean

Only relevant for subclassing.

Indicates whether the EffectComposer should prepare a depth texture for this pass. Set this to true if this pass relies on depth information from a preceding RenderPass.

needsSwap: boolean

Only relevant for subclassing.

Indicates whether the EffectComposer should swap the frame buffers after this pass has finished rendering. Set this to false if this pass doesn't render to the output buffer or the screen. Otherwise, the contents of the input buffer will be lost.

renderer: WebGLRenderer

The renderer.

Deprecated

resolution: Resolution
scene: Scene

The scene to render.

Accessors

  • get fullscreenMaterial(): Material
  • The fullscreen material.

    Returns Material

  • set fullscreenMaterial(arg): void
  • Parameters

    • arg: Material

    Returns void

  • set mainCamera(arg): void
  • Sets the main camera.

    Parameters

    • arg: Camera

    Returns void

  • set mainScene(arg): void
  • Sets the main scene.

    Parameters

    • arg: Scene

    Returns void

  • 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

  • get texture(): Texture
  • The normal texture.

    Returns Texture

Methods

  • 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

  • Returns the current depth texture.

    Returns Texture

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

  • Returns the current fullscreen material.

    Returns Material

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

    Deprecated

    Use fullscreenMaterial instead.

  • Returns the resolution settings.

    Returns Resolution

    The resolution.

    Deprecated

    Use resolution instead.

  • Returns the current resolution scale.

    Returns number

    The resolution scale.

    Deprecated

    Use resolution.preferredWidth or resolution.preferredHeight instead.

  • The normal texture.

    Returns Texture

    The texture.

    Deprecated

    Use texture instead.

  • 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

  • Indicates whether this pass is enabled.

    Returns boolean

    Whether this pass is enabled.

    Deprecated

    Use enabled instead.

  • Renders the scene normals.

    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.

    • Optional deltaTime: number

      The time between the last frame and the current one in seconds.

    • Optional stencilTest: boolean

      Indicates whether a stencil mask is active.

    Returns 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.

    • Optional depthPacking: DepthPackingStrategies

      The depth packing.

    Returns void

  • Enables or disables this pass.

    Parameters

    • value: boolean

      Whether the pass should be enabled.

    Returns void

    Deprecated

    Use enabled instead.

  • Protected

    Sets the fullscreen material.

    Parameters

    • value: Material

      A fullscreen material.

    Returns void

    Deprecated

    Use fullscreenMaterial instead.

  • Sets the renderer

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

  • Sets the resolution scale.

    Parameters

    • scale: number

      The new resolution scale.

    Returns void

    Deprecated

    Use resolution.preferredWidth or resolution.preferredHeight instead.

  • 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