# PostProcessStageComposite

#### new Cesium.PostProcessStageComposite(options)
engine/Source/Scene/PostProcessStageComposite.js 76

A collection of `PostProcessStage`s 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.

Name | Type | Description
--- | --- | ---
`options` | object | An object with the following properties:
Name | Type | Default | Description
--- | --- | --- | ---
`stages` | Array |  | An array of `PostProcessStage`s or composites to be executed in order.
`inputPreviousStageTexture` | boolean | `true` | optional Whether to execute each post-process stage where the input to one stage is the output of the previous. Otherwise, the input to each contained stage is the output of the stage that executed before the composite.
`name` | string | `createGuid()` | optional The unique name of this post-process stage for reference by other composites. If a name is not supplied, a GUID will be generated.
`uniforms` | object |  | optional An alias to the uniforms of post-process stages.

##### Throws:

- DeveloperError : options.stages.length must be greater than 0.0.

##### Examples:

    // Example 1: separable blur filter
    // The input to blurXDirection is the texture rendered to by the scene or the output of the previous stage.
    // The input to blurYDirection is the texture rendered to by blurXDirection.
    scene.postProcessStages.add(new Cesium.PostProcessStageComposite({
        stages : [blurXDirection, blurYDirection]
    }));

    // Example 2: referencing the output of another post-process stage
    scene.postProcessStages.add(new Cesium.PostProcessStageComposite({
        inputPreviousStageTexture : false,
        stages : [
            // The same as Example 1.
            new Cesium.PostProcessStageComposite({
                inputPreviousStageTexture : true
                stages : [blurXDirection, blurYDirection],
                name : 'blur'
            }),
            // The input texture for this stage is the same input texture to blurXDirection since inputPreviousStageTexture is false
            new Cesium.PostProcessStage({
                fragmentShader : compositeShader,
                uniforms : {
                    blurTexture : 'blur' // The output of the composite with name 'blur' (the texture that blurYDirection rendered to).
                }
            })
        ]
    });

    // Example 3: create a uniform alias
    const uniforms = {};
    Cesium.defineProperties(uniforms, {
        filterSize : {
            get : function() {
                return blurXDirection.uniforms.filterSize;
            },
            set : function(value) {
                blurXDirection.uniforms.filterSize = blurYDirection.uniforms.filterSize = value;
            }
        }
    });
    scene.postProcessStages.add(new Cesium.PostProcessStageComposite({
        stages : [blurXDirection, blurYDirection],
        uniforms : uniforms
    }));

##### See:

- PostProcessStage

### Members

#### enabled : boolean
engine/Source/Scene/PostProcessStageComposite.js 152

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

#### readonly inputPreviousStageTexture : boolean
engine/Source/Scene/PostProcessStageComposite.js 184

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.

#### readonly length : number
engine/Source/Scene/PostProcessStageComposite.js 196

The number of post-process stages in this composite.

#### readonly name : string
engine/Source/Scene/PostProcessStageComposite.js 141

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

#### readonly ready : boolean
engine/Source/Scene/PostProcessStageComposite.js 122

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

#### selected : Array
engine/Source/Scene/PostProcessStageComposite.js 207

The features selected for applying the post-process.

#### uniforms : object
engine/Source/Scene/PostProcessStageComposite.js 169

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

### Methods

#### destroy()
engine/Source/Scene/PostProcessStageComposite.js 351

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.

##### Throws:

- DeveloperError : This object was destroyed, i.e., destroy() was called.

##### See:

- PostProcessStageComposite#isDestroyed

#### get(index) → PostProcessStage|PostProcessStageComposite
engine/Source/Scene/PostProcessStageComposite.js 251

Gets the post-process stage at `index`

Name | Type | Description
--- | --- | ---
`index` | number | The index of the post-process stage or composite.

##### Returns:

The post-process stage or composite at index.

##### Throws:

- DeveloperError : index must be greater than or equal to 0.
- DeveloperError : index must be less than `PostProcessStageComposite#length`.

#### isDestroyed() → boolean
engine/Source/Scene/PostProcessStageComposite.js 334

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`.

##### See:

- PostProcessStageComposite#destroy

Need help? The fastest way to get answers is from the community and team on the Cesium Forum.