org.cesiumjs.cs.scene

Class PostProcessStage

java.lang.Object

org.cesiumjs.cs.scene.PostProcessStage

All Implemented Interfaces:

PostProcess

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

Runs a post-process stage on either the texture rendered by the scene or the output of a previous post-process 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.

Constructor Summary

Constructors

Constructor and Description
PostProcessStage(PostProcessStageOptions options)

Method Summary

Modifier and Type	Method and Description
Color	clearColor() The color to clear the output texture to.
static PostProcessStage	create(String fragmentShader) Simple create instance of PostProcessStage.
void	destroy() Destroys the WebGL resources held by this object.
double	forcePowerOfTwo() Whether or not to force the output texture dimensions to be both equal powers of two.
String	fragmentShader() The fragment shader to use when execute this post-process stage.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
String	name() The unique name of this post-process stage for reference by other stages in a PostProcessStageComposite.
PixelDatatype	pixelDatatype() The pixel data type of the output texture.
PixelFormat	pixelFormat() The color pixel format of the output texture.
boolean	ready() Determines if this post-process stage is ready to be executed.
PostProcessStageSampleMode	sampleMode() How to sample the input color texture.
BoundingRectangle	scissorRectangle() The BoundingRectangle to use for the scissor test.
double	textureScale() A number in the range (0.0, 1.0] used to scale the output texture dimensions.
JsObject	uniforms() An object whose properties are used to set the uniforms of the fragment shader.

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.

Constructor Detail

PostProcessStage

@JsConstructor
public PostProcessStage(PostProcessStageOptions options)

Method Detail

clearColor

@JsProperty(name="clearColor")
public Color clearColor()

The color to clear the output texture to.

forcePowerOfTwo

@JsProperty(name="forcePowerOfTwo")
public double forcePowerOfTwo()

Whether or not to force the output texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions.

fragmentShader

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

The fragment shader to use when execute this post-process stage. The shader must contain a sampler uniform declaration for colorTexture, depthTexture, or both. The shader must contain a vec2 varying declaration for v_textureCoordinates for sampling the texture uniforms.

name

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

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

pixelDatatype

@JsProperty(name="pixelDatatype")
public PixelDatatype pixelDatatype()

The pixel data type of the output texture.

pixelFormat

@JsProperty(name="pixelFormat")
public PixelFormat pixelFormat()

The color pixel format of the output texture.

ready

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

Determines if this post-process stage is ready to be executed. A stage is only executed when both ready and PostProcessStage#enabled are true. A stage will not be ready while it is waiting on textures to load.

sampleMode

@JsProperty(name="sampleMode")
public PostProcessStageSampleMode sampleMode()

How to sample the input color texture.

scissorRectangle

@JsProperty(name="scissorRectangle")
public BoundingRectangle scissorRectangle()

The BoundingRectangle to use for the scissor test. A default bounding rectangle will disable the scissor test.

textureScale

@JsProperty(name="textureScale")
public double textureScale()

A number in the range (0.0, 1.0] used to scale the output texture dimensions. A scale of 1.0 will render this post-process stage to a texture the size of the viewport.

uniforms

@JsProperty(name="uniforms")
public JsObject uniforms()

An object whose properties are used to set the uniforms of the fragment shader. The object property values can be either a constant or a function. The function will be called each frame before the post-process stage is executed. A constant value can also be a URI to an image, a data URI, or an HTML element that can be used as a texture, such as HTMLImageElement or HTMLCanvasElement. If this post-process stage is part of a PostProcessStageComposite that does not execute in series, the constant value can also be the name of another stage in a composite. This will set the uniform to the output texture the stage with that name.

create

@JsOverlay
public static PostProcessStage create(String fragmentShader)

Simple create instance of PostProcessStage.

Parameters:

fragmentShader - The fragment shader to use

Returns:

new instance of PostProcessStage.

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.

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.