@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/PostProcessStage.js

@@ -26,17 +26,17 @@ import PostProcessStageSampleMode from "./PostProcessStageSampleMode.js";
  * @alias PostProcessStage
  * @constructor
  *
- * @param {Object} options An object with the following properties:
- * @param {String} options.fragmentShader The fragment shader to use. The default <code>sampler2D</code> uniforms are <code>colorTexture</code> and <code>depthTexture</code>. The color texture is the output of rendering the scene or the previous stage. The depth texture is the output from rendering the scene. The shader should contain one or both uniforms. There is also a <code>vec2</code> varying named <code>v_textureCoordinates</code> that can be used to sample the textures.
- * @param {Object} [options.uniforms] An object whose properties will be used to set the shaders uniforms. The properties can be constant values or a function. A constant value can also be a URI, data URI, or HTML element to use as a texture.
- * @param {Number} [options.textureScale=1.0] A number in the range (0.0, 1.0] used to scale the texture dimensions. A scale of 1.0 will render this post-process stage  to a texture the size of the viewport.
- * @param {Boolean} [options.forcePowerOfTwo=false] Whether or not to force the texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions.
+ * @param {object} options An object with the following properties:
+ * @param {string} options.fragmentShader The fragment shader to use. The default <code>sampler2D</code> uniforms are <code>colorTexture</code> and <code>depthTexture</code>. The color texture is the output of rendering the scene or the previous stage. The depth texture is the output from rendering the scene. The shader should contain one or both uniforms. There is also a <code>vec2</code> varying named <code>v_textureCoordinates</code> that can be used to sample the textures.
+ * @param {object} [options.uniforms] An object whose properties will be used to set the shaders uniforms. The properties can be constant values or a function. A constant value can also be a URI, data URI, or HTML element to use as a texture.
+ * @param {number} [options.textureScale=1.0] A number in the range (0.0, 1.0] used to scale the texture dimensions. A scale of 1.0 will render this post-process stage  to a texture the size of the viewport.
+ * @param {boolean} [options.forcePowerOfTwo=false] Whether or not to force the texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions.
  * @param {PostProcessStageSampleMode} [options.sampleMode=PostProcessStageSampleMode.NEAREST] How to sample the input color texture.
  * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGBA] The color pixel format of the output texture.
  * @param {PixelDatatype} [options.pixelDatatype=PixelDatatype.UNSIGNED_BYTE] The pixel data type of the output texture.
  * @param {Color} [options.clearColor=Color.BLACK] The color to clear the output texture to.
  * @param {BoundingRectangle} [options.scissorRectangle] The rectangle to use for the scissor test.
- * @param {String} [options.name=createGuid()] The unique name of this post-process stage for reference by other stages in a composite. If a name is not supplied, a GUID will be generated.
+ * @param {string} [options.name=createGuid()] The unique name of this post-process stage for reference by other stages in a composite. If a name is not supplied, a GUID will be generated.
  *
  * @exception {DeveloperError} options.textureScale must be greater than 0.0 and less than or equal to 1.0.
  * @exception {DeveloperError} options.pixelFormat must be a color format.
@@ -176,7 +176,7 @@ function PostProcessStage(options) {
   /**
    * Whether or not to execute this post-process stage when ready.
    *
-   * @type {Boolean}
+   * @type {boolean}
    */
   this.enabled = true;
   this._enabled = true;
@@ -189,7 +189,7 @@ Object.defineProperties(PostProcessStage.prototype, {
    * to load.
    *
    * @memberof PostProcessStage.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -201,7 +201,7 @@ Object.defineProperties(PostProcessStage.prototype, {
    * The unique name of this post-process stage for reference by other stages in a {@link PostProcessStageComposite}.
    *
    * @memberof PostProcessStage.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   name: {
@@ -221,7 +221,7 @@ Object.defineProperties(PostProcessStage.prototype, {
    * </p>
    *
    * @memberof PostProcessStage.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   fragmentShader: {
@@ -244,7 +244,7 @@ Object.defineProperties(PostProcessStage.prototype, {
    * </p>
    *
    * @memberof PostProcessStage.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   uniforms: {
@@ -256,7 +256,7 @@ Object.defineProperties(PostProcessStage.prototype, {
    * A number in the range (0.0, 1.0] used to scale the output texture dimensions. A scale of 1.0 will render this post-process stage to a texture the size of the viewport.
    *
    * @memberof PostProcessStage.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   textureScale: {
@@ -268,7 +268,7 @@ Object.defineProperties(PostProcessStage.prototype, {
    * Whether or not to force the output texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions.
    *
    * @memberof PostProcessStage.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   forcePowerOfTwo: {
@@ -875,7 +875,7 @@ function createSelectedTexture(stage, context) {
 /**
  * A function that will be called before execute. Used to create WebGL resources and load any textures.
  * @param {Context} context The context.
- * @param {Boolean} useLogDepth Whether the scene uses a logarithmic depth buffer.
+ * @param {boolean} useLogDepth Whether the scene uses a logarithmic depth buffer.
  * @private
  */
 PostProcessStage.prototype.update = function (context, useLogDepth) {
@@ -995,7 +995,7 @@ PostProcessStage.prototype.execute = function (
  * <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>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see PostProcessStage#destroy
  */

package/Source/Scene/PostProcessStageCollection.js

@@ -105,7 +105,7 @@ Object.defineProperties(PostProcessStageCollection.prototype, {
    * Determines if all of the post-process stages in the collection are ready to be executed.
    *
    * @memberof PostProcessStageCollection.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -231,7 +231,7 @@ Object.defineProperties(PostProcessStageCollection.prototype, {
    * The number of post-process stages in this collection.
    *
    * @memberof PostProcessStageCollection.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   length: {
@@ -286,7 +286,7 @@ Object.defineProperties(PostProcessStageCollection.prototype, {
    * Whether the collection has a stage that has selected features.
    *
    * @memberof PostProcessStageCollection.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    * @private
    */
@@ -453,7 +453,7 @@ PostProcessStageCollection.prototype.add = function (stage) {
  * Removes a post-process stage from the collection and destroys it.
  *
  * @param {PostProcessStage|PostProcessStageComposite} stage The post-process stage to remove from the collection.
- * @return {Boolean} Whether the post-process stage was removed.
+ * @return {boolean} Whether the post-process stage was removed.
  */
 PostProcessStageCollection.prototype.remove = function (stage) {
   if (!this.contains(stage)) {
@@ -489,7 +489,7 @@ PostProcessStageCollection.prototype.remove = function (stage) {
  * Returns whether the collection contains a post-process stage.
  *
  * @param {PostProcessStage|PostProcessStageComposite} stage The post-process stage.
- * @return {Boolean} Whether the collection contains the post-process stage.
+ * @return {boolean} Whether the collection contains the post-process stage.
  */
 PostProcessStageCollection.prototype.contains = function (stage) {
   return (
@@ -502,7 +502,7 @@ PostProcessStageCollection.prototype.contains = function (stage) {
 /**
  * Gets the post-process stage at <code>index</code>.
  *
- * @param {Number} index The index of the post-process stage.
+ * @param {number} index The index of the post-process stage.
  * @return {PostProcessStage|PostProcessStageComposite} The post-process stage at index.
  */
 PostProcessStageCollection.prototype.get = function (index) {
@@ -532,7 +532,7 @@ PostProcessStageCollection.prototype.removeAll = function () {
 /**
  * Gets a post-process stage in the collection by its name.
  *
- * @param {String} name The name of the post-process stage.
+ * @param {string} name The name of the post-process stage.
  * @return {PostProcessStage|PostProcessStageComposite} The post-process stage.
  *
  * @private
@@ -545,7 +545,7 @@ PostProcessStageCollection.prototype.getStageByName = function (name) {
  * Called before the post-process stages in the collection are executed. Calls update for each stage and creates WebGL resources.
  *
  * @param {Context} context The context.
- * @param {Boolean} useLogDepth Whether the scene uses a logarithmic depth buffer.
+ * @param {boolean} useLogDepth Whether the scene uses a logarithmic depth buffer.
  *
  * @private
  */
@@ -703,7 +703,7 @@ function getOutputTexture(stage) {
 /**
  * Gets the output texture of a stage with the given name.
  *
- * @param {String} stageName The name of the stage.
+ * @param {string} stageName The name of the stage.
  * @return {Texture|undefined} The texture rendered to by the stage with the given name.
  *
  * @private
@@ -854,7 +854,7 @@ PostProcessStageCollection.prototype.copy = function (context, framebuffer) {
  * <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>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see PostProcessStageCollection#destroy
  */

package/Source/Scene/PostProcessStageComposite.js

@@ -16,11 +16,11 @@ import destroyObject from "../Core/destroyObject.js";
  * @alias PostProcessStageComposite
  * @constructor
  *
- * @param {Object} options An object with the following properties:
+ * @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.
+ * @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.
  *
@@ -119,7 +119,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, {
    * Determines if this post-process stage is ready to be executed.
    *
    * @memberof PostProcessStageComposite.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -138,7 +138,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, {
    * The unique name of this post-process stage for reference by other stages in a PostProcessStageComposite.
    *
    * @memberof PostProcessStageComposite.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   name: {
@@ -150,7 +150,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, {
    * Whether or not to execute this post-process stage when ready.
    *
    * @memberof PostProcessStageComposite.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   enabled: {
     get: function () {
@@ -167,7 +167,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, {
   /**
    * 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}
+   * @type {object}
    */
   uniforms: {
     get: function () {
@@ -181,7 +181,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, {
    * or the output texture of the previous stage.
    *
    * @memberof PostProcessStageComposite.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   inputPreviousStageTexture: {
@@ -193,7 +193,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, {
    * The number of post-process stages in this composite.
    *
    * @memberof PostProcessStageComposite.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   length: {
@@ -245,7 +245,7 @@ PostProcessStageComposite.prototype._isSupported = function (context) {
 /**
  * Gets the post-process stage at <code>index</code>
  *
- * @param {Number} index The index of the post-process stage or composite.
+ * @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.
@@ -298,7 +298,7 @@ function isSelectedTextureDirty(stage) {
 /**
  * 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.
+ * @param {boolean} useLogDepth Whether the scene uses a logarithmic depth buffer.
  * @private
  */
 PostProcessStageComposite.prototype.update = function (context, useLogDepth) {
@@ -330,7 +330,7 @@ PostProcessStageComposite.prototype.update = function (context, useLogDepth) {
  * <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>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see PostProcessStageComposite#destroy
  */

package/Source/Scene/PostProcessStageLibrary.js

@@ -198,7 +198,7 @@ PostProcessStageLibrary.createDepthOfFieldStage = function () {
  * </p>
  *
  * @param {Scene} scene The scene.
- * @return {Boolean} Whether this post process stage is supported.
+ * @return {boolean} Whether this post process stage is supported.
  *
  * @see {Context#depthTexture}
  * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture}
@@ -257,7 +257,7 @@ PostProcessStageLibrary.createEdgeDetectionStage = function () {
  * </p>
  *
  * @param {Scene} scene The scene.
- * @return {Boolean} Whether this post process stage is supported.
+ * @return {boolean} Whether this post process stage is supported.
  *
  * @see {Context#depthTexture}
  * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture}
@@ -352,7 +352,7 @@ PostProcessStageLibrary.createSilhouetteStage = function (edgeDetectionStages) {
  * </p>
  *
  * @param {Scene} scene The scene.
- * @return {Boolean} Whether this post process stage is supported.
+ * @return {boolean} Whether this post process stage is supported.
  *
  * @see {Context#depthTexture}
  * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture}
@@ -628,7 +628,7 @@ PostProcessStageLibrary.createAmbientOcclusionStage = function () {
  * </p>
  *
  * @param {Scene} scene The scene.
- * @return {Boolean} Whether this post process stage is supported.
+ * @return {boolean} Whether this post process stage is supported.
  *
  * @see {Context#depthTexture}
  * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture}
@@ -655,7 +655,7 @@ PostProcessStageLibrary.createFXAAStage = function () {
 
 /**
  * Creates a post-process stage that applies ACES tonemapping operator.
- * @param {Boolean} useAutoExposure Whether or not to use auto-exposure.
+ * @param {boolean} useAutoExposure Whether or not to use auto-exposure.
  * @return {PostProcessStage} A post-process stage that applies ACES tonemapping operator.
  * @private
  */
@@ -675,7 +675,7 @@ PostProcessStageLibrary.createAcesTonemappingStage = function (
 
 /**
  * Creates a post-process stage that applies filmic tonemapping operator.
- * @param {Boolean} useAutoExposure Whether or not to use auto-exposure.
+ * @param {boolean} useAutoExposure Whether or not to use auto-exposure.
  * @return {PostProcessStage} A post-process stage that applies filmic tonemapping operator.
  * @private
  */
@@ -695,7 +695,7 @@ PostProcessStageLibrary.createFilmicTonemappingStage = function (
 
 /**
  * Creates a post-process stage that applies Reinhard tonemapping operator.
- * @param {Boolean} useAutoExposure Whether or not to use auto-exposure.
+ * @param {boolean} useAutoExposure Whether or not to use auto-exposure.
  * @return {PostProcessStage} A post-process stage that applies Reinhard tonemapping operator.
  * @private
  */
@@ -715,7 +715,7 @@ PostProcessStageLibrary.createReinhardTonemappingStage = function (
 
 /**
  * Creates a post-process stage that applies modified Reinhard tonemapping operator.
- * @param {Boolean} useAutoExposure Whether or not to use auto-exposure.
+ * @param {boolean} useAutoExposure Whether or not to use auto-exposure.
  * @return {PostProcessStage} A post-process stage that applies modified Reinhard tonemapping operator.
  * @private
  */

package/Source/Scene/PostProcessStageSampleMode.js

@@ -1,20 +1,20 @@
 /**
  * Determines how input texture to a {@link PostProcessStage} is sampled.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const PostProcessStageSampleMode = {
   /**
    * Samples the texture by returning the closest texel.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   NEAREST: 0,
   /**
    * Samples the texture through bi-linear interpolation of the four nearest texels.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   LINEAR: 1,

package/Source/Scene/PostProcessStageTextureCache.js

@@ -389,7 +389,7 @@ PostProcessStageTextureCache.prototype.clear = function (context) {
 
 /**
  * Gets the stage with the given name.
- * @param {String} name The name of the stage.
+ * @param {string} name The name of the stage.
  * @return {PostProcessStage|PostProcessStageComposite}
  */
 PostProcessStageTextureCache.prototype.getStageByName = function (name) {
@@ -398,7 +398,7 @@ PostProcessStageTextureCache.prototype.getStageByName = function (name) {
 
 /**
  * Gets the output texture for a stage with the given name.
- * @param {String} name The name of the stage.
+ * @param {string} name The name of the stage.
  * @return {Texture|undefined} The output texture of the stage with the given name.
  */
 PostProcessStageTextureCache.prototype.getOutputTexture = function (name) {
@@ -408,7 +408,7 @@ PostProcessStageTextureCache.prototype.getOutputTexture = function (name) {
 /**
  * Gets the framebuffer for a stage with the given name.
  *
- * @param {String} name The name of the stage.
+ * @param {string} name The name of the stage.
  * @return {Framebuffer|undefined} The framebuffer for the stage with the given name.
  */
 PostProcessStageTextureCache.prototype.getFramebuffer = function (name) {
@@ -426,7 +426,7 @@ PostProcessStageTextureCache.prototype.getFramebuffer = function (name) {
  * <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>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see PostProcessStageTextureCache#destroy
  */

package/Source/Scene/Primitive.js

@@ -9,6 +9,7 @@ import combine from "../Core/combine.js";
 import ComponentDatatype from "../Core/ComponentDatatype.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
+import deprecationWarning from "../Core/deprecationWarning.js";
 import destroyObject from "../Core/destroyObject.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import EncodedCartesian3 from "../Core/EncodedCartesian3.js";
@@ -63,20 +64,20 @@ import ShadowMode from "./ShadowMode.js";
  * @alias Primitive
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {GeometryInstance[]|GeometryInstance} [options.geometryInstances] The geometry instances - or a single geometry instance - to render.
  * @param {Appearance} [options.appearance] The appearance used to render the primitive.
  * @param {Appearance} [options.depthFailAppearance] The appearance used to shade this primitive when it fails the depth test.
- * @param {Boolean} [options.show=true] Determines if this primitive will be shown.
+ * @param {boolean} [options.show=true] Determines if this primitive will be shown.
  * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the primitive (all geometry instances) from model to world coordinates.
- * @param {Boolean} [options.vertexCacheOptimize=false] When <code>true</code>, geometry vertices are optimized for the pre and post-vertex-shader caches.
- * @param {Boolean} [options.interleave=false] When <code>true</code>, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time.
- * @param {Boolean} [options.compressVertices=true] When <code>true</code>, the geometry vertices are compressed, which will save memory.
- * @param {Boolean} [options.releaseGeometryInstances=true] When <code>true</code>, the primitive does not keep a reference to the input <code>geometryInstances</code> to save memory.
- * @param {Boolean} [options.allowPicking=true] When <code>true</code>, each geometry instance will only be pickable with {@link Scene#pick}.  When <code>false</code>, GPU memory is saved.
- * @param {Boolean} [options.cull=true] When <code>true</code>, the renderer frustum culls and horizon culls the primitive's commands based on their bounding volume.  Set this to <code>false</code> for a small performance gain if you are manually culling the primitive.
- * @param {Boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready.
- * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
+ * @param {boolean} [options.vertexCacheOptimize=false] When <code>true</code>, geometry vertices are optimized for the pre and post-vertex-shader caches.
+ * @param {boolean} [options.interleave=false] When <code>true</code>, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time.
+ * @param {boolean} [options.compressVertices=true] When <code>true</code>, the geometry vertices are compressed, which will save memory.
+ * @param {boolean} [options.releaseGeometryInstances=true] When <code>true</code>, the primitive does not keep a reference to the input <code>geometryInstances</code> to save memory.
+ * @param {boolean} [options.allowPicking=true] When <code>true</code>, each geometry instance will only be pickable with {@link Scene#pick}.  When <code>false</code>, GPU memory is saved.
+ * @param {boolean} [options.cull=true] When <code>true</code>, the renderer frustum culls and horizon culls the primitive's commands based on their bounding volume.  Set this to <code>false</code> for a small performance gain if you are manually culling the primitive.
+ * @param {boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready.
+ * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
  * @param {ShadowMode} [options.shadows=ShadowMode.DISABLED] Determines whether this primitive casts or receives shadows from light sources.
  *
  * @example
@@ -233,7 +234,7 @@ function Primitive(options) {
    * Determines if the primitive will be shown.  This affects all geometry
    * instances in the primitive.
    *
-   * @type Boolean
+   * @type {boolean}
    *
    * @default true
    */
@@ -254,7 +255,7 @@ function Primitive(options) {
    * based on their bounding volume.  Set this to <code>false</code> for a small performance gain
    * if you are manually culling the primitive.
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default true
    */
@@ -266,7 +267,7 @@ function Primitive(options) {
    * Draws the bounding sphere for each draw command in the primitive.
    * </p>
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default false
    */
@@ -314,7 +315,7 @@ function Primitive(options) {
   this._boundingSphereCV = [];
   this._boundingSphere2D = [];
   this._boundingSphereMorph = [];
-  this._perInstanceAttributeCache = [];
+  this._perInstanceAttributeCache = new Map();
   this._instanceIds = [];
   this._lastPerInstanceAttributeIndex = 0;
 
@@ -350,6 +351,7 @@ function Primitive(options) {
   this._ready = false;
 
   const primitive = this;
+  // This is here for backwards compatibility. This promise wrapper can be removed once readyPromise is removed.
   this._readyPromise = new Promise((resolve, reject) => {
     primitive._completeLoad = (frameState, state, error) => {
       this._error = error;
@@ -386,7 +388,7 @@ Object.defineProperties(Primitive.prototype, {
    *
    * @memberof Primitive.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default true
@@ -402,7 +404,7 @@ Object.defineProperties(Primitive.prototype, {
    *
    * @memberof Primitive.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -418,7 +420,7 @@ Object.defineProperties(Primitive.prototype, {
    *
    * @memberof Primitive.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default true
@@ -434,7 +436,7 @@ Object.defineProperties(Primitive.prototype, {
    *
    * @memberof Primitive.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default true
@@ -450,7 +452,7 @@ Object.defineProperties(Primitive.prototype, {
    *
    * @memberof Primitive.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default true
@@ -466,7 +468,7 @@ Object.defineProperties(Primitive.prototype, {
    *
    * @memberof Primitive.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default true
@@ -484,8 +486,21 @@ Object.defineProperties(Primitive.prototype, {
    *
    * @memberof Primitive.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
+   *
+   * @example
+   * // Wait for a primitive to become ready before accessing attributes
+   * const removeListener = scene.postRender.addEventListener(() => {
+   *   if (!frustumPrimitive.ready) {
+   *     return;
+   *   }
+   *
+   *   const attributes = primitive.getGeometryInstanceAttributes('an id');
+   *   attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
+   *
+   *   removeListener();
+   * });
    */
   ready: {
     get: function () {
@@ -496,11 +511,16 @@ Object.defineProperties(Primitive.prototype, {
   /**
    * Gets a promise that resolves when the primitive is ready to render.
    * @memberof Primitive.prototype
-   * @type {Promise.<Primitive>}
+   * @type {Promise<Primitive>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: function () {
+      deprecationWarning(
+        "Primitive.readyPromise",
+        "Primitive.readyPromise was deprecated in CesiumJS 1.104. It will be removed in 1.107. Wait for Primitive.ready to return true instead."
+      );
       return this._readyPromise;
     },
   },
@@ -2388,7 +2408,7 @@ function createPickIdProperty(primitive, properties, index) {
  * Returns the modifiable per-instance attributes for a {@link GeometryInstance}.
  *
  * @param {*} id The id of the {@link GeometryInstance}.
- * @returns {Object} The typed array in the attribute's format or undefined if the is no instance with id.
+ * @returns {object} The typed array in the attribute's format or undefined if the is no instance with id.
  *
  * @exception {DeveloperError} must call update before calling getGeometryInstanceAttributes.
  *
@@ -2411,6 +2431,11 @@ Primitive.prototype.getGeometryInstanceAttributes = function (id) {
   }
   //>>includeEnd('debug');
 
+  let attributes = this._perInstanceAttributeCache.get(id);
+  if (defined(attributes)) {
+    return attributes;
+  }
+
   let index = -1;
   const lastIndex = this._lastPerInstanceAttributeIndex;
   const ids = this._instanceIds;
@@ -2427,11 +2452,6 @@ Primitive.prototype.getGeometryInstanceAttributes = function (id) {
     return undefined;
   }
 
-  let attributes = this._perInstanceAttributeCache[index];
-  if (defined(attributes)) {
-    return attributes;
-  }
-
   const batchTable = this._batchTable;
   const perInstanceAttributeIndices = this._batchTableAttributeIndices;
   attributes = {};
@@ -2452,7 +2472,7 @@ Primitive.prototype.getGeometryInstanceAttributes = function (id) {
   Object.defineProperties(attributes, properties);
 
   this._lastPerInstanceAttributeIndex = index;
-  this._perInstanceAttributeCache[index] = attributes;
+  this._perInstanceAttributeCache.set(id, attributes);
   return attributes;
 };
 
@@ -2463,7 +2483,7 @@ Primitive.prototype.getGeometryInstanceAttributes = function (id) {
  * <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>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see Primitive#destroy
  */