Fix slow debug inspector #9004
+163
−125
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,136 @@ | ||||||
| import clone from "../Core/clone.js"; | ||||||
| import Color from "../Core/Color.js"; | ||||||
| import DrawCommand from "../Renderer/DrawCommand.js"; | ||||||
| import ShaderSource from "../Renderer/ShaderSource.js"; | ||||||
| import ShaderProgram from "../Renderer/ShaderProgram.js"; | ||||||
| import defined from "../Core/defined.js"; | ||||||
|
|
||||||
| /** | ||||||
| * @private | ||||||
| */ | ||||||
| function DebugInspector() { | ||||||
| this._cachedShowFrustumsShaders = {}; | ||||||
| } | ||||||
|
|
||||||
| function getAttributeLocations(shaderProgram) { | ||||||
| var attributeLocations = {}; | ||||||
| var attributes = shaderProgram.vertexAttributes; | ||||||
| for (var a in attributes) { | ||||||
| if (attributes.hasOwnProperty(a)) { | ||||||
| attributeLocations[a] = attributes[a].index; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| return attributeLocations; | ||||||
| } | ||||||
|
|
||||||
| function createDebugShowFrustumsShaderProgram(scene, shaderProgram) { | ||||||
| var context = scene.context; | ||||||
| var sp = shaderProgram; | ||||||
| var fs = sp.fragmentShaderSource.clone(); | ||||||
|
|
||||||
| var targets = []; | ||||||
| fs.sources = fs.sources.map(function (source) { | ||||||
| source = ShaderSource.replaceMain(source, "czm_Debug_main"); | ||||||
| var re = /gl_FragData\[(\d+)\]/g; | ||||||
| var match; | ||||||
| while ((match = re.exec(source)) !== null) { | ||||||
| if (targets.indexOf(match[1]) === -1) { | ||||||
| targets.push(match[1]); | ||||||
| } | ||||||
| } | ||||||
| return source; | ||||||
| }); | ||||||
| var length = targets.length; | ||||||
|
|
||||||
| var newMain = ""; | ||||||
| newMain += "uniform vec3 debugShowCommandsColor;\n"; | ||||||
| newMain += "uniform vec3 debugShowFrustumsColor;\n"; | ||||||
| newMain += "void main() \n" + "{ \n" + " czm_Debug_main(); \n"; | ||||||
|
|
||||||
| // set debugShowCommandsColor to Color(1.0, 1.0, 1.0, 1.0) to stop rendering scene.debugShowCommands | ||||||
| // set debugShowFrustumsColor to Color(1.0, 1.0, 1.0, 1.0) to stop rendering scene.debugShowFrustums | ||||||
| var i; | ||||||
| if (length > 0) { | ||||||
| for (i = 0; i < length; ++i) { | ||||||
| newMain += | ||||||
| " gl_FragData[" + targets[i] + "].rgb *= debugShowCommandsColor;\n"; | ||||||
| newMain += | ||||||
| " gl_FragData[" + targets[i] + "].rgb *= debugShowFrustumsColor;\n"; | ||||||
| } | ||||||
| } else { | ||||||
| newMain += " gl_FragColor.rgb *= debugShowCommandsColor;\n"; | ||||||
| newMain += " gl_FragColor.rgb *= debugShowFrustumsColor;\n"; | ||||||
| } | ||||||
| newMain += "}"; | ||||||
|
|
||||||
| fs.sources.push(newMain); | ||||||
|
|
||||||
| var attributeLocations = getAttributeLocations(sp); | ||||||
|
|
||||||
| return ShaderProgram.fromCache({ | ||||||
| context: context, | ||||||
| vertexShaderSource: sp.vertexShaderSource, | ||||||
| fragmentShaderSource: fs, | ||||||
| attributeLocations: attributeLocations, | ||||||
| }); | ||||||
| } | ||||||
|
|
||||||
| DebugInspector.prototype.createShowFrustumsCommand = function (scene, command) { | ||||||
| // create debug command | ||||||
| var debugCommand = DrawCommand.shallowClone(command); | ||||||
| var shaderProgramId = command.shaderProgram.id; | ||||||
| if (!defined(this._cachedShowFrustumsShaders[shaderProgramId])) { | ||||||
| debugCommand.shaderProgram = createDebugShowFrustumsShaderProgram( | ||||||
| scene, | ||||||
| command.shaderProgram | ||||||
| ); | ||||||
|
|
||||||
| this._cachedShowFrustumsShaders[shaderProgramId] = | ||||||
| debugCommand.shaderProgram; | ||||||
| } else { | ||||||
| debugCommand.shaderProgram = this._cachedShowFrustumsShaders[ | ||||||
| shaderProgramId | ||||||
| ]; | ||||||
| } | ||||||
|
|
||||||
| // setup uniform for the shader | ||||||
| if (!defined(command.uniformMap) || typeof command.uniformMap !== "object") { | ||||||
| debugCommand.uniformMap = {}; | ||||||
| } else { | ||||||
| debugCommand.uniformMap = clone(command.uniformMap); | ||||||
| } | ||||||
|
|
||||||
| if (scene.debugShowCommands) { | ||||||
| if (!defined(command._debugColor)) { | ||||||
| command._debugColor = Color.fromRandom(); | ||||||
| } | ||||||
|
|
||||||
| debugCommand.uniformMap.debugShowCommandsColor = function () { | ||||||
|
There was a problem hiding this comment. This is probably okay since this is debug code, but normally we wouldn't set the uniform function every frame since it allocates a new function object, creates a closure, etc, all of which can add garbage collection pressure. Instead we would add the uniform function on the command once. Maybe you could add |
||||||
| return command._debugColor; | ||||||
| }; | ||||||
| } else { | ||||||
| debugCommand.uniformMap.debugShowCommandsColor = function () { | ||||||
| return new Color(1.0, 1.0, 1.0, 1.0); | ||||||
|
There was a problem hiding this comment. More concise, and avoids the allocation when retrieving the uniform value every frame.
Suggested change
There was a problem hiding this comment. Same comment for |
||||||
| }; | ||||||
| } | ||||||
|
|
||||||
| if (scene.debugShowFrustums) { | ||||||
| // Support up to three frustums. If a command overlaps all | ||||||
| // three, it's code is not changed. | ||||||
| var r = command.debugOverlappingFrustums & (1 << 0) ? 1.0 : 0.0; | ||||||
| var g = command.debugOverlappingFrustums & (1 << 1) ? 1.0 : 0.0; | ||||||
| var b = command.debugOverlappingFrustums & (1 << 2) ? 1.0 : 0.0; | ||||||
|
|
||||||
| debugCommand.uniformMap.debugShowFrustumsColor = function () { | ||||||
| return new Color(r, g, b, 1.0); | ||||||
|
There was a problem hiding this comment. Similar comment to above. If you end up making a similar change here be sure use if (!defined(debugCommand.uniformMap.debugShowFrustumsColor)) {
debugCommand.uniformMap.debugShowFrustumsColor = function () {
var r = command.debugOverlappingFrustums & (1 << 0) ? 1.0 : 0.0;
var g = command.debugOverlappingFrustums & (1 << 1) ? 1.0 : 0.0;
var b = command.debugOverlappingFrustums & (1 << 2) ? 1.0 : 0.0;
return new Color(r, g, b, 1.0);
}
}Also instead of |
||||||
| }; | ||||||
| } else { | ||||||
| debugCommand.uniformMap.debugShowFrustumsColor = function () { | ||||||
| return new Color(1.0, 1.0, 1.0, 1.0); | ||||||
| }; | ||||||
| } | ||||||
|
|
||||||
| return debugCommand; | ||||||
| }; | ||||||
| export default DebugInspector; | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When is the uniform map defined but not an object?