Last updated

API / geotoolkit3d / postprocessing / AbstractPass / AbstractPass

Class: AbstractPass

postprocessing.AbstractPass.AbstractPass

Abstract rendering pass class using the THREE.js Pass interface, from https://github.com/mrdoob/three.js/blob/dev/examples/jsm/postprocessing/Pass.js The passes added to the Plot must inherit from this class.
Check out three.js examples for more information at https://github.com/mrdoob/three.js/blob/dev/examples/jsm/postprocessing/

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new AbstractPass()

Protected new AbstractPass()

Methods

dispose

dispose(): void

Dispose resources in this pass

Returns

void


getClassName

getClassName(): string

Returns

string


getType

getType(): string

Get the type of the class

Deprecated

since 4.1. Use getClassName() instead.

Returns

string


isDisposed

isDisposed(): boolean

Return whether this pass has been disposed or not.

Returns

boolean


isEnabled

isEnabled(): boolean

Return true if this pass is enabled.

Returns

boolean


render

Abstract render(renderer, writeBuffer?, readBuffer?, deltaTime?, maskActive?): void

This render function will be called every time in animation loop

Parameters

Name Type Description
rendererWebGLRendererthe webGLrender
Optional writeBufferWebGLRenderTarget<Texture>the WebGL render target to write
Optional readBufferWebGLRenderTarget<Texture>the WebGL render target to read
Optional deltaTimenumberdelta time
Optional maskActivebooleanthe flag for stencil buffer in renderer

Returns

void


setOptions

setOptions(options?): AbstractPass

Parameters

Name Type
Optional optionsAnyRecord

Returns

AbstractPass


setSize

Abstract setSize(width, height): AbstractPass

Set size for render target

Parameters

Name Type Description
widthnumberthe width of render target
heightnumberthe height of render target

Returns

AbstractPass


getClassName

Static getClassName(): string

Returns

string