Last updated

API / geotoolkit3d / postprocessing / SSAARenderPass / SSAARenderPass

Class: SSAARenderPass

postprocessing.SSAARenderPass.SSAARenderPass

This render pass class implements super-sampling anti-aliasing.
This solution perform multiple render to gather multiple sample on each pixel, each sample have a slight offset.
While this solution can produce the best result (at high sample count), it is also very costly and is not compatible with DepthPeeling rendering, forbidding accurate transparency rendering.

Deprecated

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

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new SSAARenderPass(options)

new SSAARenderPass(options)

Parameters

Name Type
optionsOptions

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?): SSAARenderPass

Parameters

Name Type
Optional optionsOptionsBase

Returns

SSAARenderPass

Overrides

AbstractPass.setOptions


setSize

setSize(width, height): SSAARenderPass

Set size for render target

Parameters

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

Returns

SSAARenderPass

Overrides

AbstractPass.setSize


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractPass.getClassName