Class: NormalPass

Re-exported types from postprocessing

Hierarchy

• Pass

  ↳ NormalPass

Table of contents

Constructors

• constructor

Properties

• camera
• enabled
• name
• needsDepthTexture
• needsSwap
• renderTarget
• renderToScreen
• resolution
• scene

Methods

• dispose
• getDepthTexture
• getFullscreenMaterial
• getResolutionScale
• initialize
• render
• setDepthTexture
• setFullscreenMaterial
• setResolutionScale
• setSize

Constructors

constructor

• new NormalPass(scene, camera, options?)

Parameters

Overrides

Pass.constructor

Defined in

packages/three/types/postprocessing.d.ts:1459

Properties

camera

• Protected camera: Camera

The camera.

Inherited from

Pass.camera

Defined in

packages/three/types/postprocessing.d.ts:612

enabled

• enabled: boolean

Indicates whether this pass should be executed.

Inherited from

Pass.enabled

Defined in

packages/three/types/postprocessing.d.ts:637

name

• name: string

The name of this pass.

Inherited from

Pass.name

Defined in

packages/three/types/postprocessing.d.ts:602

needsDepthTexture

• needsDepthTexture: boolean

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.

Inherited from

Pass.needsDepthTexture

Defined in

packages/three/types/postprocessing.d.ts:632

needsSwap

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

Inherited from

Pass.needsSwap

Defined in

packages/three/types/postprocessing.d.ts:623

renderTarget

• renderTarget: WebGLRenderTarget

A render target that contains the scene normals.

Defined in

packages/three/types/postprocessing.d.ts:1472

renderToScreen

• renderToScreen: boolean

Indicates whether this pass should render to screen.

Inherited from

Pass.renderToScreen

Defined in

packages/three/types/postprocessing.d.ts:642

resolution

• resolution: Resizer

The desired render resolution.

Use {@link Resizer.AUTO_SIZE} for the width or height to automatically calculate it based on its counterpart and the original aspect ratio.

Defined in

packages/three/types/postprocessing.d.ts:1480

scene

• Protected scene: Scene

The scene to render.

Inherited from

Pass.scene

Defined in

packages/three/types/postprocessing.d.ts:607

Methods

dispose

▸ dispose(): void

Performs a shallow search for disposable properties and deletes them. The pass will be inoperative after this method was called!

Disposable objects:

• WebGLRenderTarget
• Material
• Texture

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

Returns

void

Inherited from

Pass.dispose

Defined in

packages/three/types/postprocessing.d.ts:745

getDepthTexture

▸ getDepthTexture(): Texture

Returns the current depth texture.

Returns

Texture

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

Inherited from

Pass.getDepthTexture

Defined in

packages/three/types/postprocessing.d.ts:663

getFullscreenMaterial

▸ getFullscreenMaterial(): Material

Returns the current fullscreen material.

Returns

Material

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

Inherited from

Pass.getFullscreenMaterial

Defined in

packages/three/types/postprocessing.d.ts:648

getResolutionScale

▸ getResolutionScale(): number

Returns the current resolution scale.

Returns

number

The resolution scale.

Defined in

packages/three/types/postprocessing.d.ts:1486

initialize

▸ initialize(renderer, alpha, frameBufferType): void

Performs initialization tasks.

By overriding this method you gain access to the renderer. You'll also be able to configure your custom render targets to use the appropriate format (RGB or RGBA).

The provided renderer can be used to warm up special off-screen render targets by performing a preliminary render operation.

The EffectComposer calls this method when this pass is added to its queue, but not before its size has been set.

example if(!alpha && frameBufferType === UnsignedByteType) { this.myRenderTarget.texture.format = RGBFormat; }

Parameters

Returns

void

Inherited from

Pass.initialize

Defined in

packages/three/types/postprocessing.d.ts:726

render

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

Renders the scene normals.

Parameters

Returns

void

Overrides

Pass.render

Defined in

packages/three/types/postprocessing.d.ts:1502

setDepthTexture

▸ setDepthTexture(depthTexture, depthPacking?): void

Sets the depth texture.

You may override this method if your pass relies on the depth information of a preceding RenderPass.

Parameters

Returns

void

Inherited from

Pass.setDepthTexture

Defined in

packages/three/types/postprocessing.d.ts:673

setFullscreenMaterial

▸ Protected setFullscreenMaterial(material): void

Sets the fullscreen material.

The material will be assigned to a mesh that fills the screen. The mesh will be created once a material is assigned via this method.

Parameters

Returns

void

Inherited from

Pass.setFullscreenMaterial

Defined in

packages/three/types/postprocessing.d.ts:657

setResolutionScale

▸ setResolutionScale(scale): void

Sets the resolution scale.

Parameters

Returns

void

Defined in

packages/three/types/postprocessing.d.ts:1492

setSize

▸ setSize(width, height): void

Updates the size of this pass.

Parameters

Returns

void

Overrides

Pass.setSize

Defined in

packages/three/types/postprocessing.d.ts:1515