Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 | 6132x 6132x 6132x 6132x 6132x 6132x 6132x 6132x 1x 3x 1x 30137x 30135x 30135x 30135x 12382x 30135x 11627x 30135x 29933x 1x 19835x 19833x 19831x 19829x 19829x 10789x 19829x 10901x 1x 20821x 20819x 20817x 20815x 1x 21548x 21546x 21544x 21542x 21542x 12524x 21542x 9018x 1x 13603x 13601x 2x 13599x 1x 12976x 12974x 12972x 12972x 12972x 4922x 12972x 12645x 1x 1793x 1791x 1789x 1x 1788x 1788x 1788x 1x 3708x 3706x 3704x 3704x 3704x 3704x 3704x 3704x 1x 13830x 13828x 13826x 13826x 13826x 13826x 1x 11392x 2x 11390x 11390x 1702x 9688x 1x 15605x 2x 15603x 15603x 1739x 13864x 1x 1845x 1844x 1844x 1844x 1844x 1844x 1844x 1844x 1844x 1x 4102x 1844x 1844x 1844x 1844x 10678x 10678x 10678x 10678x 1844x 1844x 10997x 10997x 10997x 10997x 1844x 3704x 1x 1x 3702x 1844x 1844x 1844x 1844x 12415x 12415x 12415x 12415x 1844x 1844x 9171x 9171x 9171x 9171x 1844x | import Check from "../Core/Check.js";
import clone from "../Core/clone.js";
import defined from "../Core/defined.js";
import DeveloperError from "../Core/DeveloperError.js";
import ShaderDestination from "./ShaderDestination.js";
import ShaderProgram from "./ShaderProgram.js";
import ShaderSource from "./ShaderSource.js";
import ShaderStruct from "./ShaderStruct.js";
import ShaderFunction from "./ShaderFunction.js";
import addAllToArray from "../Core/addAllToArray.js";
/**
* An object that makes it easier to build the text of a {@link ShaderProgram}. This tracks GLSL code for both the vertex shader and the fragment shader.
* <p>
* For vertex shaders, the shader builder tracks a list of <code>#defines</code>,
* a list of attributes, a list of uniforms, and a list of shader lines. It also
* tracks the location of each attribute so the caller can easily build the {@link VertexArray}
* </p>
* <p>
* For fragment shaders, the shader builder tracks a list of <code>#defines</code>,
* a list of attributes, a list of uniforms, and a list of shader lines.
* </p>
*
* @alias ShaderBuilder
* @constructor
*
* @example
* const shaderBuilder = new ShaderBuilder();
* shaderBuilder.addDefine("SOLID_COLOR", undefined, ShaderDestination.FRAGMENT);
* shaderBuilder.addUniform("vec3", "u_color", ShaderDestination.FRAGMENT);
* shaderBuilder.addVarying("vec3", v_color");
* // These locations can be used when creating the VertexArray
* const positionLocation = shaderBuilder.addPositionAttribute("vec3", "a_position");
* const colorLocation = shaderBuilder.addAttribute("vec3", "a_color");
* shaderBuilder.addVertexLines([
* "void main()",
* "{",
* " v_color = a_color;",
* " gl_Position = vec4(a_position, 1.0);",
* "}"
* ]);
* shaderBuilder.addFragmentLines([
* "void main()",
* "{",
* " #ifdef SOLID_COLOR",
* " out_FragColor = vec4(u_color, 1.0);",
* " #else",
* " out_FragColor = vec4(v_color, 1.0);",
* " #endif",
* "}"
* ]);
* const shaderProgram = shaderBuilder.build(context);
*
* @private
*/
function ShaderBuilder() {
// Some WebGL implementations require attribute 0 to always
// be active, so the position attribute is tracked separately
this._positionAttributeLine = undefined;
this._nextAttributeLocation = 1;
this._attributeLocations = {};
this._attributeLines = [];
// Dynamically-generated structs and functions
// these are dictionaries of id -> ShaderStruct or ShaderFunction respectively
this._structs = {};
this._functions = {};
this._vertexShaderParts = {
defineLines: [],
uniformLines: [],
shaderLines: [],
varyingLines: [],
// identifiers of structs/functions to include, listed in insertion order
structIds: [],
functionIds: [],
};
this._fragmentShaderParts = {
defineLines: [],
uniformLines: [],
shaderLines: [],
varyingLines: [],
// identifiers of structs/functions to include, listed in insertion order
structIds: [],
functionIds: [],
};
}
Object.defineProperties(ShaderBuilder.prototype, {
/**
* Get a dictionary of attribute names to the integer location in
* the vertex shader.
*
* @memberof ShaderBuilder.prototype
* @type {Object<string, number>}
* @readonly
* @private
*/
attributeLocations: {
get: function () {
return this._attributeLocations;
},
},
});
/**
* Add a <code>#define</code> macro to one or both of the shaders. These lines
* will appear at the top of the final shader source.
*
* @param {string} identifier An identifier for the macro. Identifiers must use uppercase letters with underscores to be consistent with Cesium's style guide.
* @param {string} [value] The value of the macro. If undefined, the define will not include a value. The value will be converted to GLSL code via <code>toString()</code>
* @param {ShaderDestination} [destination=ShaderDestination.BOTH] Whether the define appears in the vertex shader, the fragment shader, or both.
*
* @example
* // creates the line "#define ENABLE_LIGHTING" in both shaders
* shaderBuilder.addDefine("ENABLE_LIGHTING");
* // creates the line "#define PI 3.141592" in the fragment shader
* shaderBuilder.addDefine("PI", 3.141593, ShaderDestination.FRAGMENT);
*/
ShaderBuilder.prototype.addDefine = function (identifier, value, destination) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("identifier", identifier);
//>>includeEnd('debug');
destination = destination ?? ShaderDestination.BOTH;
// The ShaderSource created in build() will add the #define part
let line = identifier;
if (defined(value)) {
line += ` ${value.toString()}`;
}
if (ShaderDestination.includesVertexShader(destination)) {
this._vertexShaderParts.defineLines.push(line);
}
if (ShaderDestination.includesFragmentShader(destination)) {
this._fragmentShaderParts.defineLines.push(line);
}
};
/**
* Add a new dynamically-generated struct to the shader
* @param {string} structId A unique ID to identify this struct in {@link ShaderBuilder#addStructField}
* @param {string} structName The name of the struct as it will appear in the shader.
* @param {ShaderDestination} destination Whether the struct will appear in the vertex shader, the fragment shader, or both.
*
* @example
* // generates the following struct in the fragment shader
* // struct TestStruct
* // {
* // };
* shaderBuilder.addStruct("testStructId", "TestStruct", ShaderDestination.FRAGMENT);
*/
ShaderBuilder.prototype.addStruct = function (
structId,
structName,
destination,
) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("structId", structId);
Check.typeOf.string("structName", structName);
Check.typeOf.number("destination", destination);
//>>includeEnd('debug');
this._structs[structId] = new ShaderStruct(structName);
if (ShaderDestination.includesVertexShader(destination)) {
this._vertexShaderParts.structIds.push(structId);
}
if (ShaderDestination.includesFragmentShader(destination)) {
this._fragmentShaderParts.structIds.push(structId);
}
};
/**
* Add a field to a dynamically-generated struct.
* @param {string} structId The ID of the struct. This must be created first with {@link ShaderBuilder#addStruct}
* @param {string} type The GLSL type of the field
* @param {string} identifier The identifier of the field.
*
* @example
* // generates the following struct in the fragment shader
* // struct TestStruct
* // {
* // float minimum;
* // float maximum;
* // };
* shaderBuilder.addStruct("testStructId", "TestStruct", ShaderDestination.FRAGMENT);
* shaderBuilder.addStructField("testStructId", "float", "maximum");
* shaderBuilder.addStructField("testStructId", "float", "minimum");
*/
ShaderBuilder.prototype.addStructField = function (structId, type, identifier) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("structId", structId);
Check.typeOf.string("type", type);
Check.typeOf.string("identifier", identifier);
//>>includeEnd('debug');
this._structs[structId].addField(type, identifier);
};
/**
* Add a new dynamically-generated function to the shader.
* @param {string} functionName The name of the function. This will be used to identify the function in {@link ShaderBuilder#addFunctionLines}.
* @param {string} signature The full signature of the function as it will appear in the shader. Do not include the curly braces.
* @param {ShaderDestination} destination Whether the struct will appear in the vertex shader, the fragment shader, or both.
* @example
* // generates the following function in the vertex shader
* // vec3 testFunction(float parameter)
* // {
* // }
* shaderBuilder.addStruct("testFunction", "vec3 testFunction(float parameter)", ShaderDestination.VERTEX);
*/
ShaderBuilder.prototype.addFunction = function (
functionName,
signature,
destination,
) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("functionName", functionName);
Check.typeOf.string("signature", signature);
Check.typeOf.number("destination", destination);
//>>includeEnd('debug');
this._functions[functionName] = new ShaderFunction(signature);
if (ShaderDestination.includesVertexShader(destination)) {
this._vertexShaderParts.functionIds.push(functionName);
}
if (ShaderDestination.includesFragmentShader(destination)) {
this._fragmentShaderParts.functionIds.push(functionName);
}
};
/**
* Add lines to a dynamically-generated function
* @param {string} functionName The name of the function. This must be created beforehand using {@link ShaderBuilder#addFunction}
* @param {string|string[]} lines One or more lines of GLSL code to add to the function body. Do not include any preceding or ending whitespace, but do include the semicolon for each line.
*
* @example
* // generates the following function in the vertex shader
* // vec3 testFunction(float parameter)
* // {
* // float signed = 2.0 * parameter - 1.0;
* // return vec3(signed, 0.0, 0.0);
* // }
* shaderBuilder.addStruct("testFunction", "vec3 testFunction(float parameter)", ShaderDestination.VERTEX);
* shaderBuilder.addFunctionLines("testFunction", [
* "float signed = 2.0 * parameter - 1.0;",
* "return vec3(parameter);"
* ]);
*/
ShaderBuilder.prototype.addFunctionLines = function (functionName, lines) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("functionName", functionName);
if (typeof lines !== "string" && !Array.isArray(lines)) {
throw new DeveloperError(
`Expected lines to be a string or an array of strings, actual value was ${lines}`,
);
}
//>>includeEnd('debug');
this._functions[functionName].addLines(lines);
};
/**
* Add a uniform declaration to one or both of the shaders. These lines
* will appear grouped near the top of the final shader source.
*
* @param {string} type The GLSL type of the uniform.
* @param {string} identifier An identifier for the uniform. Identifiers must begin with <code>u_</code> to be consistent with Cesium's style guide.
* @param {ShaderDestination} [destination=ShaderDestination.BOTH] Whether the uniform appears in the vertex shader, the fragment shader, or both.
*
* @example
* // creates the line "uniform vec3 u_resolution;"
* shaderBuilder.addUniform("vec3", "u_resolution", ShaderDestination.FRAGMENT);
* // creates the line "uniform float u_time;" in both shaders
* shaderBuilder.addUniform("float", "u_time", ShaderDestination.BOTH);
*/
ShaderBuilder.prototype.addUniform = function (type, identifier, destination) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("type", type);
Check.typeOf.string("identifier", identifier);
//>>includeEnd('debug');
destination = destination ?? ShaderDestination.BOTH;
const line = `uniform ${type} ${identifier};`;
if (ShaderDestination.includesVertexShader(destination)) {
this._vertexShaderParts.uniformLines.push(line);
}
if (ShaderDestination.includesFragmentShader(destination)) {
this._fragmentShaderParts.uniformLines.push(line);
}
};
/**
* Add a position attribute declaration to the vertex shader. These lines
* will appear grouped near the top of the final shader source.
* <p>
* Some WebGL implementations require attribute 0 to be enabled, so this is
* reserved for the position attribute. For all other attributes, see
* {@link ShaderBuilder#addAttribute}
* </p>
*
* @param {string} type The GLSL type of the attribute
* @param {string} identifier An identifier for the attribute. Identifiers must begin with <code>a_</code> to be consistent with Cesium's style guide.
* @return {number} The integer location of the attribute. This location can be used when creating attributes for a {@link VertexArray}. This will always be 0.
*
* @example
* // creates the line "in vec3 a_position;"
* shaderBuilder.setPositionAttribute("vec3", "a_position");
*/
ShaderBuilder.prototype.setPositionAttribute = function (type, identifier) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("type", type);
Check.typeOf.string("identifier", identifier);
if (defined(this._positionAttributeLine)) {
throw new DeveloperError(
"setPositionAttribute() must be called exactly once for the attribute used for gl_Position. For other attributes, use addAttribute()",
);
}
//>>includeEnd('debug');
this._positionAttributeLine = `in ${type} ${identifier};`;
// Some WebGL implementations require attribute 0 to always be active, so
// this builder assumes the position will always go in location 0
this._attributeLocations[identifier] = 0;
return 0;
};
/**
* Add an attribute declaration to the vertex shader. These lines
* will appear grouped near the top of the final shader source.
* <p>
* Some WebGL implementations require attribute 0 to be enabled, so this is
* reserved for the position attribute. See {@link ShaderBuilder#setPositionAttribute}
* </p>
*
* @param {string} type The GLSL type of the attribute
* @param {string} identifier An identifier for the attribute. Identifiers must begin with <code>a_</code> to be consistent with Cesium's style guide.
* @return {number} The integer location of the attribute. This location can be used when creating attributes for a {@link VertexArray}
*
* @example
* // creates the line "in vec2 a_texCoord0;" in the vertex shader
* shaderBuilder.addAttribute("vec2", "a_texCoord0");
*/
ShaderBuilder.prototype.addAttribute = function (type, identifier) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("type", type);
Check.typeOf.string("identifier", identifier);
//>>includeEnd('debug');
const line = `in ${type} ${identifier};`;
this._attributeLines.push(line);
const location = this._nextAttributeLocation;
this._attributeLocations[identifier] = location;
// Most attributes only require a single attribute location, but matrices
// require more.
this._nextAttributeLocation += getAttributeLocationCount(type);
return location;
};
/**
* Add a varying declaration to both the vertex and fragment shaders.
*
* @param {string} type The GLSL type of the varying
* @param {string} identifier An identifier for the varying. Identifiers must begin with <code>v_</code> to be consistent with Cesium's style guide.
* @param {string} [qualifier] A qualifier for the varying, such as <code>flat</code>.
*
* @example
* // creates the line "in vec3 v_color;" in the vertex shader
* // creates the line "out vec3 v_color;" in the fragment shader
* shaderBuilder.addVarying("vec3", "v_color");
*/
ShaderBuilder.prototype.addVarying = function (type, identifier, qualifier) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("type", type);
Check.typeOf.string("identifier", identifier);
//>>includeEnd('debug');
qualifier = defined(qualifier) ? `${qualifier} ` : "";
const line = `${type} ${identifier};`;
this._vertexShaderParts.varyingLines.push(`${qualifier}out ${line}`);
this._fragmentShaderParts.varyingLines.push(`${qualifier}in ${line}`);
};
/**
* Appends lines of GLSL code to the vertex shader
*
* @param {string|string[]} lines One or more lines to add to the end of the vertex shader source
*
* @example
* shaderBuilder.addVertexLines([
* "void main()",
* "{",
* " v_color = a_color;",
* " gl_Position = vec4(a_position, 1.0);",
* "}"
* ]);
*/
ShaderBuilder.prototype.addVertexLines = function (lines) {
//>>includeStart('debug', pragmas.debug);
if (typeof lines !== "string" && !Array.isArray(lines)) {
throw new DeveloperError(
`Expected lines to be a string or an array of strings, actual value was ${lines}`,
);
}
//>>includeEnd('debug');
const vertexLines = this._vertexShaderParts.shaderLines;
if (Array.isArray(lines)) {
addAllToArray(vertexLines, lines);
} else {
// Single string case
vertexLines.push(lines);
}
};
/**
* Appends lines of GLSL code to the fragment shader
*
* @param {string[]} lines The lines to add to the end of the fragment shader source
*
* @example
* shaderBuilder.addFragmentLines([
* "void main()",
* "{",
* " #ifdef SOLID_COLOR",
* " out_FragColor = vec4(u_color, 1.0);",
* " #else",
* " out_FragColor = vec4(v_color, 1.0);",
* " #endif",
* "}"
* ]);
*/
ShaderBuilder.prototype.addFragmentLines = function (lines) {
//>>includeStart('debug', pragmas.debug);
if (typeof lines !== "string" && !Array.isArray(lines)) {
throw new DeveloperError(
`Expected lines to be a string or an array of strings, actual value was ${lines}`,
);
}
//>>includeEnd('debug');
const fragmentLines = this._fragmentShaderParts.shaderLines;
if (Array.isArray(lines)) {
addAllToArray(fragmentLines, lines);
} else {
// Single string case
fragmentLines.push(lines);
}
};
/**
* Builds the {@link ShaderProgram} from the pieces added by the other methods.
* Call this one time at the end of modifying the shader through the other
* methods in this class.
*
* @param {Context} context The context to use for creating the shader.
* @return {ShaderProgram} A shader program to use for rendering.
*
* @example
* const shaderProgram = shaderBuilder.buildShaderProgram(context);
*/
ShaderBuilder.prototype.buildShaderProgram = function (context) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.object("context", context);
//>>includeEnd('debug');
const positionAttribute = defined(this._positionAttributeLine)
? [this._positionAttributeLine]
: [];
const structLines = generateStructLines(this);
const functionLines = generateFunctionLines(this);
// Lines are joined here so the ShaderSource
// generates a single #line 0 directive
const vertexLines = positionAttribute
.concat(
this._attributeLines,
this._vertexShaderParts.uniformLines,
this._vertexShaderParts.varyingLines,
structLines.vertexLines,
functionLines.vertexLines,
this._vertexShaderParts.shaderLines,
)
.join("\n");
const vertexShaderSource = new ShaderSource({
defines: this._vertexShaderParts.defineLines,
sources: [vertexLines],
});
const fragmentLines = this._fragmentShaderParts.uniformLines
.concat(
this._fragmentShaderParts.varyingLines,
structLines.fragmentLines,
functionLines.fragmentLines,
this._fragmentShaderParts.shaderLines,
)
.join("\n");
const fragmentShaderSource = new ShaderSource({
defines: this._fragmentShaderParts.defineLines,
sources: [fragmentLines],
});
return ShaderProgram.fromCache({
context: context,
vertexShaderSource: vertexShaderSource,
fragmentShaderSource: fragmentShaderSource,
attributeLocations: this._attributeLocations,
});
};
ShaderBuilder.prototype.clone = function () {
return clone(this, true);
};
function generateStructLines(shaderBuilder) {
const vertexLines = [];
const fragmentLines = [];
let i;
let structIds = shaderBuilder._vertexShaderParts.structIds;
let structId;
let struct;
let structLines;
for (i = 0; i < structIds.length; i++) {
structId = structIds[i];
struct = shaderBuilder._structs[structId];
structLines = struct.generateGlslLines();
addAllToArray(vertexLines, structLines);
}
structIds = shaderBuilder._fragmentShaderParts.structIds;
for (i = 0; i < structIds.length; i++) {
structId = structIds[i];
struct = shaderBuilder._structs[structId];
structLines = struct.generateGlslLines();
addAllToArray(fragmentLines, structLines);
}
return {
vertexLines: vertexLines,
fragmentLines: fragmentLines,
};
}
function getAttributeLocationCount(glslType) {
switch (glslType) {
case "mat2":
return 2;
case "mat3":
return 3;
case "mat4":
return 4;
default:
return 1;
}
}
function generateFunctionLines(shaderBuilder) {
const vertexLines = [];
const fragmentLines = [];
let i;
let functionIds = shaderBuilder._vertexShaderParts.functionIds;
let functionId;
let func;
let functionLines;
for (i = 0; i < functionIds.length; i++) {
functionId = functionIds[i];
func = shaderBuilder._functions[functionId];
functionLines = func.generateGlslLines();
addAllToArray(vertexLines, functionLines);
}
functionIds = shaderBuilder._fragmentShaderParts.functionIds;
for (i = 0; i < functionIds.length; i++) {
functionId = functionIds[i];
func = shaderBuilder._functions[functionId];
functionLines = func.generateGlslLines();
addAllToArray(fragmentLines, functionLines);
}
return {
vertexLines: vertexLines,
fragmentLines: fragmentLines,
};
}
export default ShaderBuilder;
|