@cesium/engine 2.0.0 → 2.2.0

package/Source/Renderer/DrawCommand.js

@@ -93,7 +93,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * </p>
    *
    * @memberof DrawCommand.prototype
-   * @type {Object}
+   * @type {object}
    * @default undefined
    *
    * @see DrawCommand#debugShowBoundingVolume
@@ -137,7 +137,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * If the command was already culled, set this to <code>false</code> for a performance improvement.
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   cull: {
@@ -157,7 +157,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * {@link DrawCommand#cull} must also be <code>true</code> in order for the command to be culled.
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   occlude: {
@@ -236,7 +236,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * The number of vertices to draw in the vertex array.
    *
    * @memberof DrawCommand.prototype
-   * @type {Number}
+   * @type {number}
    * @default undefined
    */
   count: {
@@ -255,7 +255,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * The offset to start drawing in the vertex array.
    *
    * @memberof DrawCommand.prototype
-   * @type {Number}
+   * @type {number}
    * @default 0
    */
   offset: {
@@ -274,7 +274,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * The number of instances to draw.
    *
    * @memberof DrawCommand.prototype
-   * @type {Number}
+   * @type {number}
    * @default 0
    */
   instanceCount: {
@@ -312,7 +312,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * Whether this command should cast shadows when shadowing is enabled.
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   castShadows: {
@@ -331,7 +331,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * Whether this command should receive shadows when shadowing is enabled.
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   receiveShadows: {
@@ -351,7 +351,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * and return values to set those uniforms.
    *
    * @memberof DrawCommand.prototype
-   * @type {Object}
+   * @type {object}
    * @default undefined
    */
   uniformMap: {
@@ -428,7 +428,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * to the eye containing the bounding volume. Defaults to <code>false</code>.
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   executeInClosestFrustum: {
@@ -450,7 +450,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * with {@link Scene#debugCommandFilter}.
    *
    * @memberof DrawCommand.prototype
-   * @type {Object}
+   * @type {object}
    * @default undefined
    *
    * @see Scene#debugCommandFilter
@@ -474,7 +474,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * </p>
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    *
    * @see DrawCommand#boundingVolume
@@ -511,7 +511,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * during the pick pass.
    *
    * @memberof DrawCommand.prototype
-   * @type {String}
+   * @type {string}
    * @default undefined
    */
   pickId: {
@@ -529,7 +529,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * Whether this command should be executed in the pick pass only.
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   pickOnly: {
@@ -547,7 +547,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * Whether this command should be derived to draw depth for classification of translucent primitives.
    *
    * @memberof DrawCommand.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   depthForTranslucentClassification: {

package/Source/Renderer/Framebuffer.js

@@ -33,7 +33,7 @@ function attachRenderbuffer(framebuffer, attachment, renderbuffer) {
  * Framebuffers are used for render-to-texture effects; they allow us to render to
  * textures in one pass, and read from it in a later pass.
  *
- * @param {Object} options The initial framebuffer attachments as shown in the example below. <code>context</code> is required. The possible properties are <code>colorTextures</code>, <code>colorRenderbuffers</code>, <code>depthTexture</code>, <code>depthRenderbuffer</code>, <code>stencilRenderbuffer</code>, <code>depthStencilTexture</code>, <code>depthStencilRenderbuffer</code>, and <code>destroyAttachments</code>.
+ * @param {object} options The initial framebuffer attachments as shown in the example below. <code>context</code> is required. The possible properties are <code>colorTextures</code>, <code>colorRenderbuffers</code>, <code>depthTexture</code>, <code>depthRenderbuffer</code>, <code>stencilRenderbuffer</code>, <code>depthStencilTexture</code>, <code>depthStencilRenderbuffer</code>, and <code>destroyAttachments</code>.
  *
  * @exception {DeveloperError} Cannot have both color texture and color renderbuffer attachments.
  * @exception {DeveloperError} Cannot have both a depth texture and depth renderbuffer attachment.
@@ -101,7 +101,7 @@ function Framebuffer(options) {
    * {@link Framebuffer#destroy} is called or when a new attachment is assigned
    * to an attachment point.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    *
    * @see Framebuffer#destroy
@@ -292,7 +292,7 @@ Object.defineProperties(Framebuffer.prototype, {
    * The status of the framebuffer. If the status is not WebGLConstants.FRAMEBUFFER_COMPLETE,
    * a {@link DeveloperError} will be thrown when attempting to render to the framebuffer.
    * @memberof Framebuffer.prototype
-   * @type {Number}
+   * @type {number}
    */
   status: {
     get: function () {
@@ -338,7 +338,7 @@ Object.defineProperties(Framebuffer.prototype, {
    * depth and depth-stencil textures, and depth and depth-stencil renderbuffers.  When
    * rendering to a framebuffer, a depth attachment is required for the depth test to have effect.
    * @memberof Framebuffer.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   hasDepthAttachment: {
     get: function () {

package/Source/Renderer/FramebufferManager.js

@@ -13,15 +13,15 @@ import PixelFormat from "../Core/PixelFormat.js";
 /**
  * Creates a wrapper object around a framebuffer and its resources.
  *
- * @param {Object} options Object with the following properties:
- * @param {Number} [options.numSamples=1] The multisampling rate of the render targets. Requires a WebGL2 context.
- * @param {Number} [options.colorAttachmentsLength=1] The number of color attachments this FramebufferManager will create.
- * @param {Boolean} [options.color=true] Whether the FramebufferManager will use color attachments.
- * @param {Boolean} [options.depth=false] Whether the FramebufferManager will use depth attachments.
- * @param {Boolean} [options.depthStencil=false] Whether the FramebufferManager will use depth-stencil attachments.
- * @param {Boolean} [options.supportsDepthTexture=false] Whether the FramebufferManager will create a depth texture when the extension is supported.
- * @param {Boolean} [options.createColorAttachments=true] Whether the FramebufferManager will construct its own color attachments.
- * @param {Boolean} [options.createDepthAttachments=true] Whether the FramebufferManager will construct its own depth attachments.
+ * @param {object} options Object with the following properties:
+ * @param {number} [options.numSamples=1] The multisampling rate of the render targets. Requires a WebGL2 context.
+ * @param {number} [options.colorAttachmentsLength=1] The number of color attachments this FramebufferManager will create.
+ * @param {boolean} [options.color=true] Whether the FramebufferManager will use color attachments.
+ * @param {boolean} [options.depth=false] Whether the FramebufferManager will use depth attachments.
+ * @param {boolean} [options.depthStencil=false] Whether the FramebufferManager will use depth-stencil attachments.
+ * @param {boolean} [options.supportsDepthTexture=false] Whether the FramebufferManager will create a depth texture when the extension is supported.
+ * @param {boolean} [options.createColorAttachments=true] Whether the FramebufferManager will construct its own color attachments.
+ * @param {boolean} [options.createDepthAttachments=true] Whether the FramebufferManager will construct its own depth attachments.
  * @param {PixelDatatype} [options.pixelDatatype=undefined] The default pixel datatype to use when creating color attachments.
  * @param {PixelFormat} [options.pixelFormat=undefined] The default pixel format to use when creating color attachments.
  *

package/Source/Renderer/MultisampleFramebuffer.js

@@ -12,7 +12,7 @@ import Framebuffer from "./Framebuffer.js";
  * second is bound to DRAW_FRAMEBUFFER during the blit, and has texture attachments
  * to store the copied pixels.
  *
- * @param {Object} options The initial framebuffer attachments. <code>context</code>, <code>width</code>, and <code>height</code> are required. The possible properties are <code>colorTextures</code>, <code>colorRenderbuffers</code>, <code>depthStencilTexture</code>, <code>depthStencilRenderbuffer</code>, and <code>destroyAttachments</code>.
+ * @param {object} options The initial framebuffer attachments. <code>context</code>, <code>width</code>, and <code>height</code> are required. The possible properties are <code>colorTextures</code>, <code>colorRenderbuffers</code>, <code>depthStencilTexture</code>, <code>depthStencilRenderbuffer</code>, and <code>destroyAttachments</code>.
  *
  * @exception {DeveloperError} Both color renderbuffer and texture attachments must be provided.
  * @exception {DeveloperError} Both depth-stencil renderbuffer and texture attachments must be provided.

package/Source/Renderer/PassState.js

@@ -30,7 +30,7 @@ function PassState(context) {
    * When this is <code>undefined</code>, the {@link DrawCommand}'s property is used.
    * </p>
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @default undefined
    */
   this.blendingEnabled = undefined;
@@ -42,7 +42,7 @@ function PassState(context) {
    * When this is <code>undefined</code>, the {@link DrawCommand}'s property is used.
    * </p>
    *
-   * @type {Object}
+   * @type {object}
    * @default undefined
    */
   this.scissorTest = undefined;

package/Source/Renderer/PixelDatatype.js

@@ -3,7 +3,7 @@ import WebGLConstants from "../Core/WebGLConstants.js";
 /**
  * The data type of a pixel.
  *
- * @enum {Number}
+ * @enum {number}
  * @see PostProcessStage
  */
 const PixelDatatype = {

package/Source/Renderer/RenderState.js

@@ -372,7 +372,7 @@ let renderStateCache = {};
  * state for a {@link DrawCommand} or {@link ClearCommand}.  All inputs states are optional.  Omitted states
  * use the defaults shown in the example below.
  *
- * @param {Object} [renderState] The states defining the render state as shown in the example below.
+ * @param {object} [renderState] The states defining the render state as shown in the example below.
  *
  * @exception {RuntimeError} renderState.lineWidth is out of range.
  * @exception {DeveloperError} Invalid renderState.frontFace.

package/Source/Renderer/ShaderBuilder.js

@@ -92,7 +92,7 @@ Object.defineProperties(ShaderBuilder.prototype, {
    * the vertex shader.
    *
    * @memberof ShaderBuilder.prototype
-   * @type {Object.<String, Number>}
+   * @type {Object<string, number>}
    * @readonly
    * @private
    */
@@ -107,8 +107,8 @@ Object.defineProperties(ShaderBuilder.prototype, {
  * 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 {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
@@ -141,8 +141,8 @@ ShaderBuilder.prototype.addDefine = function (identifier, value, destination) {
 
 /**
  * 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 {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
@@ -174,9 +174,9 @@ ShaderBuilder.prototype.addStruct = function (
 
 /**
  * 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.
+ * @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
@@ -200,8 +200,8 @@ ShaderBuilder.prototype.addStructField = function (structId, 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 {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
@@ -233,8 +233,8 @@ ShaderBuilder.prototype.addFunction = function (
 
 /**
  * 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.
+ * @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
@@ -265,8 +265,8 @@ ShaderBuilder.prototype.addFunctionLines = function (functionName, 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 {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
@@ -302,9 +302,9 @@ ShaderBuilder.prototype.addUniform = function (type, identifier, destination) {
  * {@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.
+ * @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;"
@@ -338,9 +338,9 @@ ShaderBuilder.prototype.setPositionAttribute = function (type, identifier) {
  * 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}
+ * @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
@@ -367,8 +367,8 @@ ShaderBuilder.prototype.addAttribute = function (type, identifier) {
 /**
  * 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} 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.
  *
  * @example
  * // creates the line "in vec3 v_color;" in the vertex shader
@@ -389,7 +389,7 @@ ShaderBuilder.prototype.addVarying = function (type, identifier) {
 /**
  * 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
+ * @param {string|string[]} lines One or more lines to add to the end of the vertex shader source
  *
  * @example
  * shaderBuilder.addVertexLines([
@@ -421,7 +421,7 @@ ShaderBuilder.prototype.addVertexLines = function (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
+ * @param {string[]} lines The lines to add to the end of the fragment shader source
  *
  * @example
  * shaderBuilder.addFragmentLines([

package/Source/Renderer/ShaderCache.js

@@ -29,11 +29,11 @@ Object.defineProperties(ShaderCache.prototype, {
      * replace an existing reference to a shader program, which is passed as the first argument.
      * </p>
      *
-     * @param {Object} options Object with the following properties:
+     * @param {object} options Object with the following properties:
      * @param {ShaderProgram} [options.shaderProgram] The shader program that is being reassigned.
-     * @param {String|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader.
-     * @param {String|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader.
-     * @param {Object} options.attributeLocations Indices for the attribute inputs to the vertex shader.
+     * @param {string|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader.
+     * @param {string|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader.
+     * @param {object} options.attributeLocations Indices for the attribute inputs to the vertex shader.
 
      * @returns {ShaderProgram} The cached or newly created shader program.
      *
@@ -65,10 +65,10 @@ function toSortedJson(dictionary) {
  * Returns a shader program from the cache, or creates and caches a new shader program,
  * given the GLSL vertex and fragment shader source and attribute locations.
  *
- * @param {Object} options Object with the following properties:
- * @param {String|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader.
- * @param {String|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader.
- * @param {Object} options.attributeLocations Indices for the attribute inputs to the vertex shader.
+ * @param {object} options Object with the following properties:
+ * @param {string|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader.
+ * @param {string|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader.
+ * @param {object} options.attributeLocations Indices for the attribute inputs to the vertex shader.
  *
  * @returns {ShaderProgram} The cached or newly created shader program.
  */

package/Source/Renderer/ShaderDestination.js

@@ -16,7 +16,7 @@ const ShaderDestination = {
  * Check if a variable should be included in the vertex shader.
  *
  * @param {ShaderDestination} destination The ShaderDestination to check
- * @return {Boolean} <code>true</code> if the variable appears in the vertex shader, or <code>false</code> otherwise
+ * @return {boolean} <code>true</code> if the variable appears in the vertex shader, or <code>false</code> otherwise
  * @private
  */
 ShaderDestination.includesVertexShader = function (destination) {
@@ -34,7 +34,7 @@ ShaderDestination.includesVertexShader = function (destination) {
  * Check if a variable should be included in the vertex shader.
  *
  * @param {ShaderDestination} destination The ShaderDestination to check
- * @return {Boolean} <code>true</code> if the variable appears in the vertex shader, or <code>false</code> otherwise
+ * @return {boolean} <code>true</code> if the variable appears in the vertex shader, or <code>false</code> otherwise
  * @private
  */
 ShaderDestination.includesFragmentShader = function (destination) {

package/Source/Renderer/ShaderFunction.js

@@ -7,7 +7,7 @@ import DeveloperError from "../Core/DeveloperError.js";
  * @constructor
  *
  * @see {@link ShaderBuilder}
- * @param {String} signature The full signature of the function as it will appear in the shader. Do not include the curly braces.
+ * @param {string} signature The full signature of the function as it will appear in the shader. Do not include the curly braces.
  * @example
  * // generate the following function
  * //
@@ -31,7 +31,7 @@ function ShaderFunction(signature) {
 
 /**
  * Adds one or more lines to the body of the function
- * @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.
+ * @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.
  */
 ShaderFunction.prototype.addLines = function (lines) {
   //>>includeStart('debug', pragmas.debug);
@@ -57,7 +57,7 @@ ShaderFunction.prototype.addLines = function (lines) {
 
 /**
  * Generate lines of GLSL code for use with {@link ShaderBuilder}
- * @return {String[]}
+ * @return {string[]}
  */
 ShaderFunction.prototype.generateGlslLines = function () {
   return [].concat(this.signature, "{", this.body, "}");

package/Source/Renderer/ShaderSource.js

@@ -304,11 +304,11 @@ function combineShader(shaderSource, isFragmentShader, context) {
 /**
  * An object containing various inputs that will be combined to form a final GLSL shader string.
  *
- * @param {Object} [options] Object with the following properties:
- * @param {String[]} [options.sources] An array of strings to combine containing GLSL code for the shader.
- * @param {String[]} [options.defines] An array of strings containing GLSL identifiers to <code>#define</code>.
- * @param {String} [options.pickColorQualifier] The GLSL qualifier, <code>uniform</code> or <code>in</code>, for the input <code>czm_pickColor</code>.  When defined, a pick fragment shader is generated.
- * @param {Boolean} [options.includeBuiltIns=true] If true, referenced built-in functions will be included with the combined shader.  Set to false if this shader will become a source in another shader, to avoid duplicating functions.
+ * @param {object} [options] Object with the following properties:
+ * @param {string[]} [options.sources] An array of strings to combine containing GLSL code for the shader.
+ * @param {string[]} [options.defines] An array of strings containing GLSL identifiers to <code>#define</code>.
+ * @param {string} [options.pickColorQualifier] The GLSL qualifier, <code>uniform</code> or <code>in</code>, for the input <code>czm_pickColor</code>.  When defined, a pick fragment shader is generated.
+ * @param {boolean} [options.includeBuiltIns=true] If true, referenced built-in functions will be included with the combined shader.  Set to false if this shader will become a source in another shader, to avoid duplicating functions.
  *
  * @exception {DeveloperError} options.pickColorQualifier must be 'uniform' or 'in'.
  *
@@ -368,7 +368,7 @@ ShaderSource.replaceMain = function (source, renamedMain) {
  * {@link ShaderSource#createCombinedFragmentShader} are both expensive to
  * compute, create a simpler string key for lookups in the {@link ShaderCache}.
  *
- * @returns {String} A key for identifying this shader
+ * @returns {string} A key for identifying this shader
  *
  * @private
  */
@@ -388,7 +388,7 @@ ShaderSource.prototype.getCacheKey = function () {
  *
  * @param {Context} context The current rendering context
  *
- * @returns {String} The combined shader string.
+ * @returns {string} The combined shader string.
  */
 ShaderSource.prototype.createCombinedVertexShader = function (context) {
   return combineShader(this, false, context);
@@ -399,7 +399,7 @@ ShaderSource.prototype.createCombinedVertexShader = function (context) {
  *
  * @param {Context} context The current rendering context
  *
- * @returns {String} The combined shader string.
+ * @returns {string} The combined shader string.
  */
 ShaderSource.prototype.createCombinedFragmentShader = function (context) {
   return combineShader(this, true, context);

package/Source/Renderer/ShaderStruct.js

@@ -5,7 +5,7 @@
  * @constructor
  *
  * @see {@link ShaderBuilder}
- * @param {String} name The name of the struct as it will appear in the shader.
+ * @param {string} name The name of the struct as it will appear in the shader.
  * @example
  * // Generate the struct:
  * //
@@ -30,8 +30,8 @@ function ShaderStruct(name) {
 
 /**
  * Add a field to the struct
- * @param {String} type The type of the struct field
- * @param {String} identifier The identifier of the struct field
+ * @param {string} type The type of the struct field
+ * @param {string} identifier The identifier of the struct field
  */
 ShaderStruct.prototype.addField = function (type, identifier) {
   const field = `    ${type} ${identifier};`;
@@ -40,7 +40,7 @@ ShaderStruct.prototype.addField = function (type, identifier) {
 
 /**
  * Generate a list of lines of GLSL code for use with {@link ShaderBuilder}
- * @return {String[]} The generated GLSL code.
+ * @return {string[]} The generated GLSL code.
  */
 ShaderStruct.prototype.generateGlslLines = function () {
   let fields = this.fields;

package/Source/Renderer/Texture.js

@@ -411,13 +411,13 @@ Texture.create = function (options) {
  * Creates a texture, and copies a subimage of the framebuffer to it.  When called without arguments,
  * the texture is the same width and height as the framebuffer and contains its contents.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Context} options.context The context in which the Texture gets created.
  * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGB] The texture's internal pixel format.
- * @param {Number} [options.framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from.
- * @param {Number} [options.framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from.
- * @param {Number} [options.width=canvas.clientWidth] The width of the texture in texels.
- * @param {Number} [options.height=canvas.clientHeight] The height of the texture in texels.
+ * @param {number} [options.framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from.
+ * @param {number} [options.framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from.
+ * @param {number} [options.width=canvas.clientWidth] The width of the texture in texels.
+ * @param {number} [options.height=canvas.clientHeight] The height of the texture in texels.
  * @param {Framebuffer} [options.framebuffer=defaultFramebuffer] The framebuffer from which to create the texture.  If this
  *        parameter is not specified, the default framebuffer is used.
  * @returns {Texture} A texture with contents from the framebuffer.
@@ -515,7 +515,7 @@ Object.defineProperties(Texture.prototype, {
   /**
    * A unique id for the texture
    * @memberof Texture.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -531,7 +531,7 @@ Object.defineProperties(Texture.prototype, {
    * coordinates in both directions, uses linear filtering for both magnification and minification,
    * and uses a maximum anisotropy of 1.0.
    * @memberof Texture.prototype
-   * @type {Object}
+   * @type {object}
    */
   sampler: {
     get: function () {
@@ -648,12 +648,12 @@ Object.defineProperties(Texture.prototype, {
 /**
  * Copy new image data into this texture, from a source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, or {@link HTMLVideoElement}.
  * or an object with width, height, and arrayBufferView properties.
- * @param {Object} options Object with the following properties:
- * @param {Object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, or {@link HTMLVideoElement},
+ * @param {object} options Object with the following properties:
+ * @param {object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, or {@link HTMLVideoElement},
  *                        or an object with width, height, and arrayBufferView properties.
- * @param {Number} [options.xOffset=0] The offset in the x direction within the texture to copy into.
- * @param {Number} [options.yOffset=0] The offset in the y direction within the texture to copy into.
- * @param {Boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored.
+ * @param {number} [options.xOffset=0] The offset in the x direction within the texture to copy into.
+ * @param {number} [options.yOffset=0] The offset in the y direction within the texture to copy into.
+ * @param {boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored.
  *
  * @exception {DeveloperError} Cannot call copyFrom when the texture pixel format is DEPTH_COMPONENT or DEPTH_STENCIL.
  * @exception {DeveloperError} Cannot call copyFrom with a compressed texture pixel format.
@@ -872,12 +872,12 @@ Texture.prototype.copyFrom = function (options) {
 };
 
 /**
- * @param {Number} [xOffset=0] The offset in the x direction within the texture to copy into.
- * @param {Number} [yOffset=0] The offset in the y direction within the texture to copy into.
- * @param {Number} [framebufferXOffset=0] optional
- * @param {Number} [framebufferYOffset=0] optional
- * @param {Number} [width=width] optional
- * @param {Number} [height=height] optional
+ * @param {number} [xOffset=0] The offset in the x direction within the texture to copy into.
+ * @param {number} [yOffset=0] The offset in the y direction within the texture to copy into.
+ * @param {number} [framebufferXOffset=0] optional
+ * @param {number} [framebufferYOffset=0] optional
+ * @param {number} [width=width] optional
+ * @param {number} [height=height] optional
  *
  * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel format is DEPTH_COMPONENT or DEPTH_STENCIL.
  * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel data type is FLOAT.

package/Source/Renderer/TextureMagnificationFilter.js

@@ -3,7 +3,7 @@ import WebGLConstants from "../Core/WebGLConstants.js";
 /**
  * Enumerates all possible filters used when magnifying WebGL textures.
  *
- * @enum {Number}
+ * @enum {number}
  *
  * @see TextureMinificationFilter
  */
@@ -11,14 +11,14 @@ const TextureMagnificationFilter = {
   /**
    * Samples the texture by returning the closest pixel.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   NEAREST: WebGLConstants.NEAREST,
   /**
    * Samples the texture through bi-linear interpolation of the four nearest pixels. This produces smoother results than <code>NEAREST</code> filtering.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   LINEAR: WebGLConstants.LINEAR,
@@ -27,7 +27,7 @@ const TextureMagnificationFilter = {
 /**
  * Validates the given <code>textureMinificationFilter</code> with respect to the possible enum values.
  * @param textureMagnificationFilter
- * @returns {Boolean} <code>true</code> if <code>textureMagnificationFilter</code> is valid.
+ * @returns {boolean} <code>true</code> if <code>textureMagnificationFilter</code> is valid.
  *
  * @private
  */