org.cesiumjs.cs.scene

Class PostProcessStageCollection

java.lang.Object

org.cesiumjs.cs.scene.PostProcessStageCollection

@JsType(isNative=true,
        namespace="Cesium",
        name="PostProcessStageCollection")
public class PostProcessStageCollection
extends Object

A collection of PostProcessStages and/or PostProcessStageComposites. The input texture for each post-process stage is the texture rendered to by the scene or the texture rendered to by the previous stage in the collection. If the ambient occlusion or bloom stages are enabled, they will execute before all other stages. If the FXAA stage is enabled, it will execute after all other stages.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
PostProcessStageCollection()

Method Summary

Modifier and Type	Method and Description
PostProcessStage	add(PostProcessStage stage) Adds the post-process stage to the collection.
PostProcessStageComposite	add(PostProcessStageComposite stage) Adds the post-process stage to the collection.
PostProcessStageComposite	ambientOcclusion()
PostProcessStageComposite	bloom()
boolean	contains(PostProcess stage) Returns whether the collection contains a post-process stage.
void	destroy() Destroys the WebGL resources held by this object.
PostProcessStage	fxaa() A post-process stage for Fast Approximate Anti-aliasing.
PostProcess	get(int index) Gets the post-process stage at index.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
int	length() The number of post-process stages in this collection.
boolean	ready() Determines if all of the post-process stages in the collection are ready to be executed.
boolean	remove(PostProcess stage) Removes a post-process stage from the collection and destroys it.
void	removeAll() Removes all post-process stages from the collection and destroys them.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PostProcessStageCollection

@JsConstructor
public PostProcessStageCollection()

Method Detail

ambientOcclusion

@JsProperty(name="ambientOcclusion")
public PostProcessStageComposite ambientOcclusion()

bloom

@JsProperty(name="bloom")
public PostProcessStageComposite bloom()

fxaa

@JsProperty(name="fxaa")
public PostProcessStage fxaa()

A post-process stage for Fast Approximate Anti-aliasing. When enabled, this stage will execute after all others.

length

@JsProperty(name="length")
public int length()

The number of post-process stages in this collection.

ready

@JsProperty(name="ready")
public boolean ready()

Determines if all of the post-process stages in the collection are ready to be executed.

add

@JsMethod
public PostProcessStage add(PostProcessStage stage)

Adds the post-process stage to the collection.

Parameters:

stage - PostProcessStage The post-process stage to add to the collection.

Returns:

The post-process stage that was added to the collection.

add

@JsMethod
public PostProcessStageComposite add(PostProcessStageComposite stage)

Adds the post-process stage to the collection.

Parameters:

stage - PostProcessStageComposite The post-process stage to add to the collection.

Returns:

The post-process stage that was added to the collection.

contains

@JsMethod
public boolean contains(PostProcess stage)

Returns whether the collection contains a post-process stage.

Parameters:

stage - PostProcessStage | PostProcessStageComposite The post-process stage to add to the collection.

Returns:

Whether the collection contains the post-process stage.

destroy

@JsMethod
public void destroy()

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

get

@JsMethod
public PostProcess get(int index)

Gets the post-process stage at index.

Parameters:

index - The index of the post-process stage.

Returns:

PostProcessStage | PostProcessStageComposite The post-process stage at index.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

true if this object was destroyed; otherwise, false.

remove

@JsMethod
public boolean remove(PostProcess stage)

Removes a post-process stage from the collection and destroys it.

Parameters:

stage - PostProcessStage | PostProcessStageComposite The post-process stage to add to the collection.

Returns:

Whether the post-process stage was removed.

removeAll

@JsMethod
public void removeAll()

Removes all post-process stages from the collection and destroys them.