Class ClearPass

A clear pass.

Hierarchy (View Summary)

Pass
- ClearPass

Constructors

constructor

new ClearPass(color?: boolean, depth?: boolean, stencil?: boolean): ClearPass
Constructs a new clear pass.
Parameters
- color: boolean = true
  The color clear flag.
- depth: boolean = true
  The depth clear flag.
- stencil: boolean = true
  The stencil clear flag.
Returns ClearPass
Overrides Pass.constructor
- Defined in src/passes/ClearPass.ts:60

Properties

`Readonly`clearFlags

clearFlags: ClearFlags

The clear flags.

`Readonly`clearValues

clearValues: ClearValues

The clear values.

If an override clear color is set, the scene background will be ignored.
The override alpha setting has no effect when a scene background is used.

`Protected` `Readonly`disposables

disposables: Set<Disposable>

A collection of objects that will be disposed when this pass is disposed.

IO resources, materials and subpasses will be disposed separately and don't need to be added.

`Readonly`id

id: number

An identifier.

`Readonly`input

input: Input

The input resources of this pass.

`Protected` `Readonly`materials

materials: Set<null>

A collection of fullscreen materials that are used by this pass.

This only needs to be filled if multiple fullscreen materials are used. The initial fullscreenMaterial will automatically be added.

`Readonly`output

output: Output

The output resources of this pass.

`Readonly`resolution

resolution: Resolution

The current resolution.

`Readonly`scissor

scissor: Scissor

A rectangular area inside the viewport. Fragments that are outside the area will not be rendered.

See

Scissor.enabled to enable the scissor.

`Readonly`viewport

viewport: Viewport

The viewport.

See

Viewport.enabled to enable the viewport.

Accessors

attached

get attached(): boolean
Indicates whether this pass is currently attached to another pass or a render pipeline.

Returns boolean
Inherited from Pass.attached
- Defined in src/core/Pass.ts:337
set attached(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Pass.attached
- Defined in src/core/Pass.ts:343

`Protected`autoSRGB

get autoSRGB(): boolean
Controls automatic sRGB encoding for low precision output buffers.

Returns boolean
Default Value
```
true
```
Inherited from Pass.autoSRGB
- Defined in src/core/Pass.ts:385
set autoSRGB(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Pass.autoSRGB
- Defined in src/core/Pass.ts:391

`Protected`autoSyncDefaultBuffers

get autoSyncDefaultBuffers(): boolean
Controls whether the settings of the input and output default buffers should be synchronized.

Returns boolean
Default Value
```
true
```
Inherited from Pass.autoSyncDefaultBuffers
- Defined in src/core/Pass.ts:362
set autoSyncDefaultBuffers(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Pass.autoSyncDefaultBuffers
- Defined in src/core/Pass.ts:368

camera

get camera(): OrthographicCamera | PerspectiveCamera | null
The main camera.

Returns OrthographicCamera | PerspectiveCamera | null
Inherited from Pass.camera
- Defined in src/core/Pass.ts:562
set camera(value: OrthographicCamera | PerspectiveCamera | null): void
Parameters
- value: OrthographicCamera | PerspectiveCamera | null
Returns void
Inherited from Pass.camera
- Defined in src/core/Pass.ts:568

enabled

get enabled(): boolean
Indicates whether this pass is enabled.

Returns boolean
Default Value
```
true
```
Inherited from Pass.enabled
- Defined in src/core/Pass.ts:316
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Pass.enabled
- Defined in src/core/Pass.ts:322

fullscreenMaterial

get fullscreenMaterial(): TMaterial
The current fullscreen material.

Returns TMaterial
Inherited from Pass.fullscreenMaterial
- Defined in src/core/Pass.ts:596
set fullscreenMaterial(value: TMaterial): void
Parameters
- value: TMaterial
Returns void
Inherited from Pass.fullscreenMaterial
- Defined in src/core/Pass.ts:602

name

get name(): string
The name of this pass.

Returns string
Inherited from LambdaPass.name
- Defined in src/core/Pass.ts:298
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from LambdaPass.name
- Defined in src/core/Pass.ts:304

renderer

get renderer(): WebGLRenderer | null
The current renderer.

Returns WebGLRenderer | null
Inherited from Pass.renderer
- Defined in src/core/Pass.ts:474
set renderer(value: WebGLRenderer | null): void
Parameters
- value: WebGLRenderer | null
Returns void
Inherited from Pass.renderer
- Defined in src/core/Pass.ts:480

scene

get scene(): Scene | null
The main scene.

Returns Scene | null
Inherited from Pass.scene
- Defined in src/core/Pass.ts:512
set scene(value: Scene | null): void
Parameters
- value: Scene | null
Returns void
Inherited from Pass.scene
- Defined in src/core/Pass.ts:518

subpasses

get subpasses(): readonly Pass<Material | null>[]
A list of subpasses.

Subpasses are included in automatic resource optimizations and will be disposed when the parent pass is disposed. The resolution, viewport and scissor of the subpasses are also kept in sync with the parent pass.

They also gain access to the following data:
- timer
- renderer
- scene
- camera
- attached
Returns readonly Pass<Material | null>[]
Inherited from ShaderPass.subpasses
- Defined in src/core/Pass.ts:416
set subpasses(value: Pass<Material | null>[]): void
Parameters
- value: Pass<Material | null>[]
Returns void
Inherited from ShaderPass.subpasses
- Defined in src/core/Pass.ts:422

timer

get timer(): ImmutableTimer | null
A timer.

Returns ImmutableTimer | null
Inherited from Pass.timer
- Defined in src/core/Pass.ts:452
set timer(value: ImmutableTimer | null): void
Parameters
- value: ImmutableTimer | null
Returns void
Inherited from Pass.timer
- Defined in src/core/Pass.ts:458

Methods

`Protected`applyScissor

applyScissor(
    renderTarget?:
        | WebGLRenderTarget<Texture<unknown>>
        | WebGLRenderTarget<Texture<unknown>[]>
        | null,
): void
Applies the scissor region of this pass to the given render target.

Note: viewport/scissor on render targets use absolute pixels whereas the renderer expects logical pixels.
Parameters
- renderTarget:
      | WebGLRenderTarget<Texture<unknown>>
      | WebGLRenderTarget<Texture<unknown>[]>
      | null = null
Returns void
Inherited from Pass.applyScissor
- Defined in src/core/Pass.ts:1109

`Protected`applyViewport

applyViewport(
    renderTarget?:
        | WebGLRenderTarget<Texture<unknown>>
        | WebGLRenderTarget<Texture<unknown>[]>
        | null,
): void
Applies the viewport of this pass to the given render target.

Note: viewport/scissor on render targets use absolute pixels whereas the renderer expects logical pixels.
Parameters
- renderTarget:
      | WebGLRenderTarget<Texture<unknown>>
      | WebGLRenderTarget<Texture<unknown>[]>
      | null = null
Returns void
Inherited from Pass.applyViewport
- Defined in src/core/Pass.ts:1061

checkRequirements

checkRequirements(): void
Checks if the current renderer supports all features that are required by this pass.

Override this method to check if the current device supports the necessary features. This method should throw an error if the requirements are not met.

Returns void
Throws
If the device doesn't meet the requirements.
Inherited from Pass.checkRequirements
- Defined in src/core/Pass.ts:931

compile

compile(): Promise<void>
Compiles the materials used by this pass.

Returns Promise<void>
A promise that resolves when the compilation has finished.
Overrides Pass.compile
- Defined in src/passes/ClearPass.ts:184

`Protected`createFramebuffer

createFramebuffer(): WebGLRenderTarget
Creates a standard render target with default settings and no depth.

Returns WebGLRenderTarget
The framebuffer.

See
https://threejs.org/docs/?q=rendert#api/en/renderers/WebGLRenderTarget
Inherited from Pass.createFramebuffer
- Defined in src/core/Pass.ts:1038

dispose

dispose(): void
Frees internal resources.

Returns void
Inherited from Pass.dispose
- Defined in src/core/Pass.ts:1352

isConvolutionPass

isConvolutionPass(recursive: boolean): boolean
Checks if this pass uses convolution shaders.

Only works on passes that use a FullscreenMaterial.
Parameters
- recursive: boolean
  Controls whether subpasses should be checked recursively.
Returns boolean
True if the pass uses convolution shaders.
Inherited from Pass.isConvolutionPass
- Defined in src/core/Pass.ts:892

`Protected`onInputChange

onInputChange(): void
Performs tasks when the input resources have changed.

Override this empty method to handle input changes.

Returns void
Inherited from Pass.onInputChange
- Defined in src/core/Pass.ts:939

`Protected`onOutputChange

onOutputChange(): void
Performs tasks when the output resources have changed.

Override this empty method to handle output changes.

Returns void
Overrides Pass.onOutputChange
- Defined in src/passes/ClearPass.ts:177

`Protected`onResolutionChange

onResolutionChange(): void
Performs tasks when the resolution has changed.

Override this empty method to handle resolution changes.

Returns void
Inherited from Pass.onResolutionChange
- Defined in src/core/Pass.ts:955

`Protected`onSceneChildAdded

onSceneChildAdded(object: Object3D): void
Performs tasks when a child node is added to the current scene.

Note: This method will only be called for child nodes and not for the scene itself.
Parameters
- object: Object3D
  The child node that was added.
Returns void
Inherited from Pass.onSceneChildAdded
- Defined in src/core/Pass.ts:981

`Protected`onSceneChildRemoved

onSceneChildRemoved(object: Object3D): void
Performs tasks when a child node is removed from the current scene.

Note: This method will only be called for child nodes and not for the scene itself.
Parameters
- object: Object3D
  The child node that was removed.
Returns void
Inherited from Pass.onSceneChildRemoved
- Defined in src/core/Pass.ts:991

`Protected`onScissorChange

onScissorChange(): void
Performs tasks when the scissor has changed.

Override this empty method to handle scissor changes.

Returns void
Inherited from Pass.onScissorChange
- Defined in src/core/Pass.ts:971

`Protected`onViewportChange

onViewportChange(): void
Performs tasks when the viewport has changed.

Override this empty method to handle viewport changes.

Returns void
Inherited from Pass.onViewportChange
- Defined in src/core/Pass.ts:963

render

render(): void
Performs render operations.

Returns void
Overrides Pass.render
- Defined in src/passes/ClearPass.ts:199

`Protected`renderFullscreen

renderFullscreen(): void
Renders the fullscreen material to the current render target.

Returns void
Inherited from Pass.renderFullscreen
- Defined in src/core/Pass.ts:1179

`Protected`setChanged

setChanged(): void
Dispatches a change event.

Returns void
Inherited from Pass.setChanged
- Defined in src/core/Pass.ts:1049

`Protected`setRenderTarget

setRenderTarget(
    renderTarget?:
        | WebGLRenderTarget<Texture<unknown>>
        | WebGLRenderTarget<Texture<unknown>[]>
        | null,
    activeCubeFace?: number,
    activeMipmapLevel?: number,
): void
Sets the active render target.

This method also calls applyViewport and applyScissor.
Parameters
- renderTarget:
      | WebGLRenderTarget<Texture<unknown>>
      | WebGLRenderTarget<Texture<unknown>[]>
      | null = null
  A render target. Use null to render to the canvas.
- OptionalactiveCubeFace: number
  The active cube side (PX 0, NX 1, PY 2, NY 3, PZ 4, NZ 5) of WebGLCubeRenderTarget.
- OptionalactiveMipmapLevel: number
  Specifies the active mipmap level.
Returns void
Inherited from Pass.setRenderTarget
- Defined in src/core/Pass.ts:1165

Class ClearPass

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ClearPass

Properties

ReadonlyclearFlags

ReadonlyclearValues

Protected Readonlydisposables

Readonlyid

Readonlyinput

Protected Readonlymaterials

Readonlyoutput

Readonlyresolution

Readonlyscissor

See

Readonlyviewport

See

Accessors

attached

Returns boolean

Parameters

Returns void

ProtectedautoSRGB

Returns boolean

Default Value

Parameters

Returns void

ProtectedautoSyncDefaultBuffers

Returns boolean

Default Value

Parameters

Returns void

camera

Returns OrthographicCamera | PerspectiveCamera | null

Parameters

Returns void

enabled

Returns boolean

Default Value

Parameters

Returns void

fullscreenMaterial

Returns TMaterial

Parameters

Returns void

name

Returns string

Parameters

Returns void

renderer

Returns WebGLRenderer | null

Parameters

Returns void

scene

Returns Scene | null

Parameters

Returns void

subpasses

Returns readonly Pass<Material | null>[]

Parameters

Returns void

timer

Returns ImmutableTimer | null

Parameters

Returns void

Methods

ProtectedapplyScissor

Parameters

Returns void

ProtectedapplyViewport

Parameters

Returns void

checkRequirements

`Readonly`clearFlags

`Readonly`clearValues

`Protected` `Readonly`disposables

`Readonly`id

`Readonly`input

`Protected` `Readonly`materials

`Readonly`output

`Readonly`resolution

`Readonly`scissor

`Readonly`viewport

`Protected`autoSRGB

`Protected`autoSyncDefaultBuffers

`Protected`applyScissor

`Protected`applyViewport

`Protected`createFramebuffer

`Protected`onInputChange

`Protected`onOutputChange

`Protected`onResolutionChange

`Protected`onSceneChildAdded

`Protected`onSceneChildRemoved

`Protected`onScissorChange

`Protected`onViewportChange

`Protected`renderFullscreen

`Protected`setChanged

`Protected`setRenderTarget