@cesium/engine 1.1.0 → 2.1.0

package/Source/Renderer/ContextLimits.js

@@ -32,7 +32,7 @@ Object.defineProperties(ContextLimits, {
    * shader with this WebGL implementation.  The minimum is eight.  If both shaders access the
    * same texture unit, this counts as two texture units.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_COMBINED_TEXTURE_IMAGE_UNITS</code>.
    */
   maximumCombinedTextureImageUnits: {
@@ -45,7 +45,7 @@ Object.defineProperties(ContextLimits, {
    * The approximate maximum cube mape width and height supported by this WebGL implementation.
    * The minimum is 16, but most desktop and laptop implementations will support much larger sizes like 8,192.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_CUBE_MAP_TEXTURE_SIZE</code>.
    */
   maximumCubeMapSize: {
@@ -58,7 +58,7 @@ Object.defineProperties(ContextLimits, {
    * The maximum number of <code>vec4</code>, <code>ivec4</code>, and <code>bvec4</code>
    * uniforms that can be used by a fragment shader with this WebGL implementation.  The minimum is 16.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_FRAGMENT_UNIFORM_VECTORS</code>.
    */
   maximumFragmentUniformVectors: {
@@ -70,7 +70,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum number of texture units that can be used from the fragment shader with this WebGL implementation.  The minimum is eight.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_TEXTURE_IMAGE_UNITS</code>.
    */
   maximumTextureImageUnits: {
@@ -83,7 +83,7 @@ Object.defineProperties(ContextLimits, {
    * The maximum renderbuffer width and height supported by this WebGL implementation.
    * The minimum is 16, but most desktop and laptop implementations will support much larger sizes like 8,192.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_RENDERBUFFER_SIZE</code>.
    */
   maximumRenderbufferSize: {
@@ -96,7 +96,7 @@ Object.defineProperties(ContextLimits, {
    * The approximate maximum texture width and height supported by this WebGL implementation.
    * The minimum is 64, but most desktop and laptop implementations will support much larger sizes like 8,192.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_TEXTURE_SIZE</code>.
    */
   maximumTextureSize: {
@@ -109,7 +109,7 @@ Object.defineProperties(ContextLimits, {
    * The maximum number of <code>vec4</code> varying variables supported by this WebGL implementation.
    * The minimum is eight.  Matrices and arrays count as multiple <code>vec4</code>s.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_VARYING_VECTORS</code>.
    */
   maximumVaryingVectors: {
@@ -121,7 +121,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum number of <code>vec4</code> vertex attributes supported by this WebGL implementation.  The minimum is eight.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_VERTEX_ATTRIBS</code>.
    */
   maximumVertexAttributes: {
@@ -134,7 +134,7 @@ Object.defineProperties(ContextLimits, {
    * The maximum number of texture units that can be used from the vertex shader with this WebGL implementation.
    * The minimum is zero, which means the GL does not support vertex texture fetch.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_VERTEX_TEXTURE_IMAGE_UNITS</code>.
    */
   maximumVertexTextureImageUnits: {
@@ -147,7 +147,7 @@ Object.defineProperties(ContextLimits, {
    * The maximum number of <code>vec4</code>, <code>ivec4</code>, and <code>bvec4</code>
    * uniforms that can be used by a vertex shader with this WebGL implementation.  The minimum is 16.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_VERTEX_UNIFORM_VECTORS</code>.
    */
   maximumVertexUniformVectors: {
@@ -159,7 +159,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The minimum aliased line width, in pixels, supported by this WebGL implementation.  It will be at most one.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>ALIASED_LINE_WIDTH_RANGE</code>.
    */
   minimumAliasedLineWidth: {
@@ -171,7 +171,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum aliased line width, in pixels, supported by this WebGL implementation.  It will be at least one.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>ALIASED_LINE_WIDTH_RANGE</code>.
    */
   maximumAliasedLineWidth: {
@@ -183,7 +183,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The minimum aliased point size, in pixels, supported by this WebGL implementation.  It will be at most one.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>ALIASED_POINT_SIZE_RANGE</code>.
    */
   minimumAliasedPointSize: {
@@ -195,7 +195,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum aliased point size, in pixels, supported by this WebGL implementation.  It will be at least one.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>ALIASED_POINT_SIZE_RANGE</code>.
    */
   maximumAliasedPointSize: {
@@ -207,7 +207,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum supported width of the viewport.  It will be at least as large as the visible width of the associated canvas.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_VIEWPORT_DIMS</code>.
    */
   maximumViewportWidth: {
@@ -219,7 +219,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum supported height of the viewport.  It will be at least as large as the visible height of the associated canvas.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with <code>MAX_VIEWPORT_DIMS</code>.
    */
   maximumViewportHeight: {
@@ -231,7 +231,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum degree of anisotropy for texture filtering
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    */
   maximumTextureFilterAnisotropy: {
     get: function () {
@@ -242,7 +242,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum number of simultaneous outputs that may be written in a fragment shader.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    */
   maximumDrawBuffers: {
     get: function () {
@@ -253,7 +253,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum number of color attachments supported.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    */
   maximumColorAttachments: {
     get: function () {
@@ -264,7 +264,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * The maximum number of samples supported for multisampling.
    * @memberof ContextLimits
-   * @type {Number}
+   * @type {number}
    */
   maximumSamples: {
     get: function () {
@@ -275,7 +275,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * High precision float supported (<code>highp</code>) in fragment shaders.
    * @memberof ContextLimits
-   * @type {Boolean}
+   * @type {boolean}
    */
   highpFloatSupported: {
     get: function () {
@@ -286,7 +286,7 @@ Object.defineProperties(ContextLimits, {
   /**
    * High precision int supported (<code>highp</code>) in fragment shaders.
    * @memberof ContextLimits
-   * @type {Boolean}
+   * @type {boolean}
    */
   highpIntSupported: {
     get: function () {

package/Source/Renderer/CubeMapFace.js

@@ -54,12 +54,12 @@ Object.defineProperties(CubeMapFace.prototype, {
 
 /**
  * Copies texels from the source to the cubemap's face.
- * @param {Object} options Object with the following properties:
- * @param {Object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, {@link HTMLVideoElement},
+ * @param {object} options Object with the following properties:
+ * @param {object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, {@link HTMLVideoElement},
  *                              or an object with a width, height, and arrayBufferView properties.
- * @param {Number} [options.xOffset=0] An offset in the x direction in the cubemap where copying begins.
- * @param {Number} [options.yOffset=0] An offset in the y direction in the cubemap where copying begins.
- * @param {Boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored.
+ * @param {number} [options.xOffset=0] An offset in the x direction in the cubemap where copying begins.
+ * @param {number} [options.yOffset=0] An offset in the y direction in the cubemap where copying begins.
+ * @param {boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored.
  * @exception {DeveloperError} xOffset must be greater than or equal to zero.
  * @exception {DeveloperError} yOffset must be greater than or equal to zero.
  * @exception {DeveloperError} xOffset + source.width must be less than or equal to width.
@@ -268,12 +268,12 @@ CubeMapFace.prototype.copyFrom = function (options) {
 /**
  * Copies texels from the framebuffer to the cubemap's face.
  *
- * @param {Number} [xOffset=0] An offset in the x direction in the cubemap where copying begins.
- * @param {Number} [yOffset=0] An offset in the y direction in the cubemap where copying begins.
- * @param {Number} [framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from.
- * @param {Number} [framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from.
- * @param {Number} [width=CubeMap's width] The width of the subimage to copy.
- * @param {Number} [height=CubeMap's height] The height of the subimage to copy.
+ * @param {number} [xOffset=0] An offset in the x direction in the cubemap where copying begins.
+ * @param {number} [yOffset=0] An offset in the y direction in the cubemap where copying begins.
+ * @param {number} [framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from.
+ * @param {number} [framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from.
+ * @param {number} [width=CubeMap's width] The width of the subimage to copy.
+ * @param {number} [height=CubeMap's height] The height of the subimage to copy.
  *
  * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel data type is FLOAT.
  * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel data type is HALF_FLOAT.

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.