Last updated

API / geotoolkit3d / postprocessing / ShaderPass / ShaderPass

Class: ShaderPass

postprocessing.ShaderPass.ShaderPass

This class uses shader program as a renderpass.

Deprecated

since 4.1, this class is not meant to be public.

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new ShaderPass(options)

new ShaderPass(options)

Parameters

Name Type Description
optionsObject
options.shaderShaderMaterial | ShaderThe Shader to use for this pass.

Overrides

AbstractPass.constructor

Methods

dispose

dispose(): void

Dispose resources in this pass

Returns

void

Inherited from

AbstractPass.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

AbstractPass.getClassName


getType

getType(): string

Get the type of the class

Deprecated

since 4.1. Use getClassName() instead.

Returns

string

Inherited from

AbstractPass.getType


isDisposed

isDisposed(): boolean

Return whether this pass has been disposed or not.

Returns

boolean

Inherited from

AbstractPass.isDisposed


isEnabled

isEnabled(): boolean

Return true if this pass is enabled.

Returns

boolean

Inherited from

AbstractPass.isEnabled


render

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

Overrides

AbstractPass.render


setOptions

setOptions(options?): ShaderPass

Parameters

Name Type
Optional optionsBaseOptions

Returns

ShaderPass

Overrides

AbstractPass.setOptions


setSize

setSize(width, height): ShaderPass

Set size for render target

Parameters

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

Returns

ShaderPass

Overrides

AbstractPass.setSize


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractPass.getClassName