-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
PostProcessStageComposite.js
360 lines (341 loc) · 11.8 KB
/
PostProcessStageComposite.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
import Check from "../Core/Check.js";
import createGuid from "../Core/createGuid.js";
import defaultValue from "../Core/defaultValue.js";
import defined from "../Core/defined.js";
import destroyObject from "../Core/destroyObject.js";
/**
* A collection of {@link PostProcessStage}s or other post-process composite stages that execute together logically.
* <p>
* All stages are executed in the order of the array. The input texture changes based on the value of <code>inputPreviousStageTexture</code>.
* If <code>inputPreviousStageTexture</code> is <code>true</code>, the input to each stage is the output texture rendered to by the scene or of the stage that executed before it.
* If <code>inputPreviousStageTexture</code> is <code>false</code>, 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.
* </p>
*
* @alias PostProcessStageComposite
* @constructor
*
* @param {Object} options An object with the following properties:
* @param {Array} options.stages An array of {@link PostProcessStage}s or composites to be executed in order.
* @param {Boolean} [options.inputPreviousStageTexture=true] 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.
* @param {String} [options.name=createGuid()] The unique name of this post-process stage for reference by other composites. If a name is not supplied, a GUID will be generated.
* @param {Object} [options.uniforms] An alias to the uniforms of post-process stages.
*
* @exception {DeveloperError} options.stages.length must be greater than 0.0.
*
* @see PostProcessStage
*
* @example
* // 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
* // 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
* // Example 3: create a uniform alias
* var 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
* }));
*/
function PostProcessStageComposite(options) {
options = defaultValue(options, defaultValue.EMPTY_OBJECT);
//>>includeStart('debug', pragmas.debug);
Check.defined("options.stages", options.stages);
Check.typeOf.number.greaterThan(
"options.stages.length",
options.stages.length,
0
);
//>>includeEnd('debug');
this._stages = options.stages;
this._inputPreviousStageTexture = defaultValue(
options.inputPreviousStageTexture,
true
);
var name = options.name;
if (!defined(name)) {
name = createGuid();
}
this._name = name;
this._uniforms = options.uniforms;
// used by PostProcessStageCollection
this._textureCache = undefined;
this._index = undefined;
this._selected = undefined;
this._selectedShadow = undefined;
this._parentSelected = undefined;
this._parentSelectedShadow = undefined;
this._combinedSelected = undefined;
this._combinedSelectedShadow = undefined;
this._selectedLength = 0;
this._parentSelectedLength = 0;
this._selectedDirty = true;
}
Object.defineProperties(PostProcessStageComposite.prototype, {
/**
* Determines if this post-process stage is ready to be executed.
*
* @memberof PostProcessStageComposite.prototype
* @type {Boolean}
* @readonly
*/
ready: {
get: function () {
var stages = this._stages;
var length = stages.length;
for (var i = 0; i < length; ++i) {
if (!stages[i].ready) {
return false;
}
}
return true;
},
},
/**
* The unique name of this post-process stage for reference by other stages in a PostProcessStageComposite.
*
* @memberof PostProcessStageComposite.prototype
* @type {String}
* @readonly
*/
name: {
get: function () {
return this._name;
},
},
/**
* Whether or not to execute this post-process stage when ready.
*
* @memberof PostProcessStageComposite.prototype
* @type {Boolean}
*/
enabled: {
get: function () {
return this._stages[0].enabled;
},
set: function (value) {
var stages = this._stages;
var length = stages.length;
for (var i = 0; i < length; ++i) {
stages[i].enabled = value;
}
},
},
/**
* An alias to the uniform values of the post-process stages. May be <code>undefined</code>; in which case, get each stage to set uniform values.
* @memberof PostProcessStageComposite.prototype
* @type {Object}
*/
uniforms: {
get: function () {
return this._uniforms;
},
},
/**
* All post-process stages are executed in the order of the array. The input texture changes based on the value of <code>inputPreviousStageTexture</code>.
* If <code>inputPreviousStageTexture</code> is <code>true</code>, the input to each stage is the output texture rendered to by the scene or of the stage that executed before it.
* If <code>inputPreviousStageTexture</code> is <code>false</code>, 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.
*
* @memberof PostProcessStageComposite.prototype
* @type {Boolean}
* @readonly
*/
inputPreviousStageTexture: {
get: function () {
return this._inputPreviousStageTexture;
},
},
/**
* The number of post-process stages in this composite.
*
* @memberof PostProcessStageComposite.prototype
* @type {Number}
* @readonly
*/
length: {
get: function () {
return this._stages.length;
},
},
/**
* The features selected for applying the post-process.
*
* @memberof PostProcessStageComposite.prototype
* @type {Array}
*/
selected: {
get: function () {
return this._selected;
},
set: function (value) {
this._selected = value;
},
},
/**
* @private
*/
parentSelected: {
get: function () {
return this._parentSelected;
},
set: function (value) {
this._parentSelected = value;
},
},
});
/**
* @private
*/
PostProcessStageComposite.prototype._isSupported = function (context) {
var stages = this._stages;
var length = stages.length;
for (var i = 0; i < length; ++i) {
if (!stages[i]._isSupported(context)) {
return false;
}
}
return true;
};
/**
* Gets the post-process stage at <code>index</code>
*
* @param {Number} index The index of the post-process stage or composite.
* @return {PostProcessStage|PostProcessStageComposite} The post-process stage or composite at index.
*
* @exception {DeveloperError} index must be greater than or equal to 0.
* @exception {DeveloperError} index must be less than {@link PostProcessStageComposite#length}.
*/
PostProcessStageComposite.prototype.get = function (index) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.number.greaterThanOrEquals("index", index, 0);
Check.typeOf.number.lessThan("index", index, this.length);
//>>includeEnd('debug');
return this._stages[index];
};
function isSelectedTextureDirty(stage) {
var length = defined(stage._selected) ? stage._selected.length : 0;
var parentLength = defined(stage._parentSelected) ? stage._parentSelected : 0;
var dirty =
stage._selected !== stage._selectedShadow ||
length !== stage._selectedLength;
dirty =
dirty ||
stage._parentSelected !== stage._parentSelectedShadow ||
parentLength !== stage._parentSelectedLength;
if (defined(stage._selected) && defined(stage._parentSelected)) {
stage._combinedSelected = stage._selected.concat(stage._parentSelected);
} else if (defined(stage._parentSelected)) {
stage._combinedSelected = stage._parentSelected;
} else {
stage._combinedSelected = stage._selected;
}
if (!dirty && defined(stage._combinedSelected)) {
if (!defined(stage._combinedSelectedShadow)) {
return true;
}
length = stage._combinedSelected.length;
for (var i = 0; i < length; ++i) {
if (stage._combinedSelected[i] !== stage._combinedSelectedShadow[i]) {
return true;
}
}
}
return dirty;
}
/**
* A function that will be called before execute. Updates each post-process stage in the composite.
* @param {Context} context The context.
* @param {Boolean} useLogDepth Whether the scene uses a logarithmic depth buffer.
* @private
*/
PostProcessStageComposite.prototype.update = function (context, useLogDepth) {
this._selectedDirty = isSelectedTextureDirty(this);
this._selectedShadow = this._selected;
this._parentSelectedShadow = this._parentSelected;
this._combinedSelectedShadow = this._combinedSelected;
this._selectedLength = defined(this._selected) ? this._selected.length : 0;
this._parentSelectedLength = defined(this._parentSelected)
? this._parentSelected.length
: 0;
var stages = this._stages;
var length = stages.length;
for (var i = 0; i < length; ++i) {
var stage = stages[i];
if (this._selectedDirty) {
stage.parentSelected = this._combinedSelected;
}
stage.update(context, useLogDepth);
}
};
/**
* Returns true if this object was destroyed; otherwise, false.
* <p>
* If this object was destroyed, it should not be used; calling any function other than
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
* </p>
*
* @returns {Boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
*
* @see PostProcessStageComposite#destroy
*/
PostProcessStageComposite.prototype.isDestroyed = function () {
return false;
};
/**
* 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.
* <p>
* Once an object is destroyed, it should not be used; calling any function other than
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
* assign the return value (<code>undefined</code>) to the object as done in the example.
* </p>
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @see PostProcessStageComposite#isDestroyed
*/
PostProcessStageComposite.prototype.destroy = function () {
var stages = this._stages;
var length = stages.length;
for (var i = 0; i < length; ++i) {
stages[i].destroy();
}
return destroyObject(this);
};
export default PostProcessStageComposite;