org.cesiumjs.cs.scene

Class PostProcessStageComposite

java.lang.Object

org.cesiumjs.cs.scene.PostProcessStageComposite

All Implemented Interfaces:

PostProcess

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

A collection of PostProcessStage or other post-process composite stages that execute together logically. All stages are executed in the order of the array. The input texture changes based on the value of inputPreviousStageTexture. If inputPreviousStageTexture is true, the input to each stage is the output texture rendered to by the scene or of the stage that executed before it. If inputPreviousStageTexture is false, the input texture is the same for each stage in the composite. The input texture is the texture rendered to by the scene or the output texture of the previous stage.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enabled Whether or not to execute this post-process stage when ready.
JsObject	uniforms An alias to the uniform values of the post-process stages.

Constructor Summary

Constructors

Constructor and Description
PostProcessStageComposite(PostProcessStageCompositeOptions options)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the WebGL resources held by this object.
PostProcess	getPostProcessStage(int index) Gets the post-process stage at index
boolean	inputPreviousStageTexture() All post-process stages are executed in the order of the array.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
int	length() The number of post-process stages in this composite.
String	name() The unique name of this post-process stage for reference by other stages in a PostProcessStageComposite.
boolean	ready() Determines if this post-process stage is ready to be executed.

Methods inherited from class java.lang.Object

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

Field Detail

enabled

@JsProperty
public boolean enabled

Whether or not to execute this post-process stage when ready.

uniforms

@JsProperty
public JsObject uniforms

An alias to the uniform values of the post-process stages. May be undefined; in which case, get each stage to set uniform values.

Constructor Detail

PostProcessStageComposite

@JsConstructor
public PostProcessStageComposite(PostProcessStageCompositeOptions options)

Method Detail

inputPreviousStageTexture

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

All post-process stages are executed in the order of the array. The input texture changes based on the value of inputPreviousStageTexture. If inputPreviousStageTexture is true, the input to each stage is the output texture rendered to by the scene or of the stage that executed before it. If inputPreviousStageTexture is false, the input texture is the same for each stage in the composite. The input texture is the texture rendered to by the scene or the output texture of the previous stage.

length

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

The number of post-process stages in this composite.

name

@JsProperty(name="name")
public String name()

The unique name of this post-process stage for reference by other stages in a PostProcessStageComposite.

ready

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

Determines if this post-process stage is ready to be executed.

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.

getPostProcessStage

public PostProcess getPostProcessStage(int index)

Gets the post-process stage at index

Parameters:

index - The index of the post-process stage or composite.

Returns:

The post-process stage or composite 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.