super-three 0.173.4 → 0.175.0

package/src/renderers/common/RendererUtils.js

@@ -1,7 +1,5 @@
 import { Color } from '../../math/Color.js';
 
-/** @module RendererUtils **/
-
 /**
  * Saves the state of the given renderer and stores it into the given state object.
  *

package/src/renderers/common/SampledTexture.js

@@ -13,8 +13,8 @@ class SampledTexture extends Binding {
 	/**
 	 * Constructs a new sampled texture.
 	 *
-	 * @param {String} name - The sampled texture's name.
-	 * @param {Texture?} texture - The texture this binding is referring to.
+	 * @param {string} name - The sampled texture's name.
+	 * @param {?Texture} texture - The texture this binding is referring to.
 	 */
 	constructor( name, texture ) {
 
@@ -23,28 +23,28 @@ class SampledTexture extends Binding {
 		/**
 		 * This identifier.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.id = _id ++;
 
 		/**
 		 * The texture this binding is referring to.
 		 *
-		 * @type {Texture?}
+		 * @type {?Texture}
 		 */
 		this.texture = texture;
 
 		/**
 		 * The binding's version.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.version = texture ? texture.version : 0;
 
 		/**
 		 * Whether the texture is a storage texture or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.store = false;
@@ -53,7 +53,7 @@ class SampledTexture extends Binding {
 		 * The binding's generation which is an additional version
 		 * qualifier.
 		 *
-		 * @type {Number?}
+		 * @type {?number}
 		 * @default null
 		 */
 		this.generation = null;
@@ -61,7 +61,7 @@ class SampledTexture extends Binding {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -73,8 +73,8 @@ class SampledTexture extends Binding {
 	 * Returns `true` whether this binding requires an update for the
 	 * given generation.
 	 *
-	 * @param {Number} generation - The generation.
-	 * @return {Boolean} Whether an update is required or not.
+	 * @param {number} generation - The generation.
+	 * @return {boolean} Whether an update is required or not.
 	 */
 	needsBindingsUpdate( generation ) {
 
@@ -95,7 +95,7 @@ class SampledTexture extends Binding {
 	/**
 	 * Updates the binding.
 	 *
-	 * @return {Boolean} Whether the texture has been updated and must be
+	 * @return {boolean} Whether the texture has been updated and must be
 	 * uploaded to the GPU.
 	 */
 	update() {
@@ -127,8 +127,8 @@ class SampledArrayTexture extends SampledTexture {
 	/**
 	 * Constructs a new sampled array texture.
 	 *
-	 * @param {String} name - The sampled array texture's name.
-	 * @param {(DataArrayTexture|CompressedArrayTexture)?} texture - The texture this binding is referring to.
+	 * @param {string} name - The sampled array texture's name.
+	 * @param {?(DataArrayTexture|CompressedArrayTexture)} texture - The texture this binding is referring to.
 	 */
 	constructor( name, texture ) {
 
@@ -137,7 +137,7 @@ class SampledArrayTexture extends SampledTexture {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -158,8 +158,8 @@ class Sampled3DTexture extends SampledTexture {
 	/**
 	 * Constructs a new sampled 3D texture.
 	 *
-	 * @param {String} name - The sampled 3D texture's name.
-	 * @param {Data3DTexture?} texture - The texture this binding is referring to.
+	 * @param {string} name - The sampled 3D texture's name.
+	 * @param {?Data3DTexture} texture - The texture this binding is referring to.
 	 */
 	constructor( name, texture ) {
 
@@ -168,7 +168,7 @@ class Sampled3DTexture extends SampledTexture {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -189,8 +189,8 @@ class SampledCubeTexture extends SampledTexture {
 	/**
 	 * Constructs a new sampled cube texture.
 	 *
-	 * @param {String} name - The sampled cube texture's name.
-	 * @param {(CubeTexture|CompressedCubeTexture)?} texture - The texture this binding is referring to.
+	 * @param {string} name - The sampled cube texture's name.
+	 * @param {?(CubeTexture|CompressedCubeTexture)} texture - The texture this binding is referring to.
 	 */
 	constructor( name, texture ) {
 
@@ -199,7 +199,7 @@ class SampledCubeTexture extends SampledTexture {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/Sampler.js

@@ -11,8 +11,8 @@ class Sampler extends Binding {
 	/**
 	 * Constructs a new sampler.
 	 *
-	 * @param {String} name - The samplers's name.
-	 * @param {Texture?} texture - The texture this binding is referring to.
+	 * @param {string} name - The samplers's name.
+	 * @param {?Texture} texture - The texture this binding is referring to.
 	 */
 	constructor( name, texture ) {
 
@@ -21,21 +21,21 @@ class Sampler extends Binding {
 		/**
 		 * The texture the sampler is referring to.
 		 *
-		 * @type {Texture?}
+		 * @type {?Texture}
 		 */
 		this.texture = texture;
 
 		/**
 		 * The binding's version.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.version = texture ? texture.version : 0;
 
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/StorageBuffer.js

@@ -11,7 +11,7 @@ class StorageBuffer extends Buffer {
 	/**
 	 * Constructs a new uniform buffer.
 	 *
-	 * @param {String} name - The buffer's name.
+	 * @param {string} name - The buffer's name.
 	 * @param {BufferAttribute} attribute - The buffer attribute.
 	 */
 	constructor( name, attribute ) {
@@ -28,7 +28,7 @@ class StorageBuffer extends Buffer {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/StorageBufferAttribute.js

@@ -8,7 +8,7 @@ import { BufferAttribute } from '../../core/BufferAttribute.js';
  * to compute the data for an attribute more efficiently on the GPU.
  *
  * The idea is to create an instance of this class and provide it as an input
- * to {@link module:StorageBufferNode}.
+ * to {@link StorageBufferNode}.
  *
  * Note: This type of buffer attribute can only be used with `WebGPURenderer`.
  *
@@ -19,9 +19,9 @@ class StorageBufferAttribute extends BufferAttribute {
 	/**
 	 * Constructs a new storage buffer attribute.
 	 *
-	 * @param {Number|TypedArray} count - The item count. It is also valid to pass a typed array as an argument.
+	 * @param {number|TypedArray} count - The item count. It is also valid to pass a typed array as an argument.
 	 * The subsequent parameters are then obsolete.
-	 * @param {Number} itemSize - The item size.
+	 * @param {number} itemSize - The item size.
 	 * @param {TypedArray.constructor} [typeClass=Float32Array] - A typed array constructor.
 	 */
 	constructor( count, itemSize, typeClass = Float32Array ) {
@@ -33,7 +33,7 @@ class StorageBufferAttribute extends BufferAttribute {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/StorageInstancedBufferAttribute.js

@@ -8,7 +8,7 @@ import { InstancedBufferAttribute } from '../../core/InstancedBufferAttribute.js
  * to compute the data for an attribute more efficiently on the GPU.
  *
  * The idea is to create an instance of this class and provide it as an input
- * to {@link module:StorageBufferNode}.
+ * to {@link StorageBufferNode}.
  *
  * Note: This type of buffer attribute can only be used with `WebGPURenderer`.
  *
@@ -19,9 +19,9 @@ class StorageInstancedBufferAttribute extends InstancedBufferAttribute {
 	/**
 	 * Constructs a new storage instanced buffer attribute.
 	 *
-	 * @param {Number|TypedArray} count - The item count. It is also valid to pass a typed array as an argument.
+	 * @param {number|TypedArray} count - The item count. It is also valid to pass a typed array as an argument.
 	 * The subsequent parameters are then obsolete.
-	 * @param {Number} itemSize - The item size.
+	 * @param {number} itemSize - The item size.
 	 * @param {TypedArray.constructor} [typeClass=Float32Array] - A typed array constructor.
 	 */
 	constructor( count, itemSize, typeClass = Float32Array ) {
@@ -33,7 +33,7 @@ class StorageInstancedBufferAttribute extends InstancedBufferAttribute {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/StorageTexture.js

@@ -15,8 +15,8 @@ class StorageTexture extends Texture {
 	/**
 	 * Constructs a new storage texture.
 	 *
-	 * @param {Number} [width=1] - The storage texture's width.
-	 * @param {Number} [height=1] - The storage texture's height.
+	 * @param {number} [width=1] - The storage texture's width.
+	 * @param {number} [height=1] - The storage texture's height.
 	 */
 	constructor( width = 1, height = 1 ) {
 
@@ -25,28 +25,28 @@ class StorageTexture extends Texture {
 		/**
 		 * The image object which just represents the texture's dimension.
 		 *
-		 * @type {{width: Number, height: Number}}
+		 * @type {{width: number, height: number}}
 		 */
 		this.image = { width, height };
 
 		/**
 		 * The default `magFilter` for storage textures is `THREE.LinearFilter`.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.magFilter = LinearFilter;
 
 		/**
 		 * The default `minFilter` for storage textures is `THREE.LinearFilter`.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.minFilter = LinearFilter;
 
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/Textures.js

@@ -53,7 +53,7 @@ class Textures extends DataMap {
 	 * it updates the texture states representing the attachments of the framebuffer.
 	 *
 	 * @param {RenderTarget} renderTarget - The render target to update.
-	 * @param {Number} [activeMipmapLevel=0] - The active mipmap level.
+	 * @param {number} [activeMipmapLevel=0] - The active mipmap level.
 	 */
 	updateRenderTarget( renderTarget, activeMipmapLevel = 0 ) {
 
@@ -382,9 +382,9 @@ class Textures extends DataMap {
 	 * Computes the number of mipmap levels for the given texture.
 	 *
 	 * @param {Texture} texture - The texture.
-	 * @param {Number} width - The texture's width.
-	 * @param {Number} height - The texture's height.
-	 * @return {Number} The number of mipmap levels.
+	 * @param {number} width - The texture's width.
+	 * @param {number} height - The texture's height.
+	 * @return {number} The number of mipmap levels.
 	 */
 	getMipLevels( texture, width, height ) {
 
@@ -416,7 +416,7 @@ class Textures extends DataMap {
 	 * Returns `true` if the given texture requires mipmaps.
 	 *
 	 * @param {Texture} texture - The texture.
-	 * @return {Boolean} Whether mipmaps are required or not.
+	 * @return {boolean} Whether mipmaps are required or not.
 	 */
 	needsMipmaps( texture ) {
 
@@ -428,7 +428,7 @@ class Textures extends DataMap {
 	 * Returns `true` if the given texture is an environment map.
 	 *
 	 * @param {Texture} texture - The texture.
-	 * @return {Boolean} Whether the given texture is an environment map or not.
+	 * @return {boolean} Whether the given texture is an environment map or not.
 	 */
 	isEnvironmentTexture( texture ) {
 

package/src/renderers/common/TimestampQueryPool.js

@@ -1,30 +1,89 @@
+/**
+ * Abstract base class of a timestamp query pool.
+ *
+ * @abstract
+ */
 class TimestampQueryPool {
 
+	/**
+	 * Creates a new timestamp query pool.
+	 *
+	 * @param {number} [maxQueries=256] - Maximum number of queries this pool can hold.
+	 */
 	constructor( maxQueries = 256 ) {
 
+		/**
+		 * Whether to track timestamps or not.
+		 *
+		 * @type {boolean}
+		 * @default true
+		 */
 		this.trackTimestamp = true;
+
+		/**
+		 * Maximum number of queries this pool can hold.
+		 *
+		 * @type {number}
+		 * @default 256
+		 */
 		this.maxQueries = maxQueries;
-		this.currentQueryIndex = 0; // how many queries allocated so far
-		this.queryOffsets = new Map(); // track offsets for different contexts
+
+		/**
+		 * How many queries allocated so far.
+		 *
+		 * @type {number}
+		 * @default 0
+		 */
+		this.currentQueryIndex = 0;
+
+		/**
+		 * Tracks offsets for different contexts.
+		 *
+		 * @type {Map<string, number>}
+		 */
+		this.queryOffsets = new Map();
+
+		/**
+		 * Whether the pool has been disposed or not.
+		 *
+		 * @type {boolean}
+		 * @default false
+		 */
 		this.isDisposed = false;
+
+		/**
+		 * TODO
+		 *
+		 * @type {number}
+		 * @default 0
+		 */
 		this.lastValue = 0;
+
+		/**
+		 * TODO
+		 *
+		 * @type {boolean}
+		 * @default false
+		 */
 		this.pendingResolve = false;
 
 	}
 
 	/**
-     * Allocate queries for a specific renderContext.
+	 * Allocate queries for a specific renderContext.
 	 *
 	 * @abstract
-     */
+	 * @param {Object} renderContext - The render context to allocate queries for.
+	 */
 	allocateQueriesForContext( /* renderContext */ ) {}
 
 	/**
-     * Resolve all timestamps and return data (or process them).
+	 * Resolve all timestamps and return data (or process them).
 	 *
 	 * @abstract
-	 * @returns {Promise<Number>|Number} The resolved timestamp value.
-     */
+	 * @async
+	 * @returns {Promise<number>|number} The resolved timestamp value.
+	 */
 	async resolveQueriesAsync() {}
 
 	/**

package/src/renderers/common/Uniform.js

@@ -17,22 +17,22 @@ class Uniform {
 	/**
 	 * Constructs a new uniform.
 	 *
-	 * @param {String} name - The uniform's name.
-	 * @param {Any} value - The uniform's value.
+	 * @param {string} name - The uniform's name.
+	 * @param {any} value - The uniform's value.
 	 */
 	constructor( name, value ) {
 
 		/**
 		 * The uniform's name.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.name = name;
 
 		/**
 		 * The uniform's value.
 		 *
-		 * @type {Any}
+		 * @type {any}
 		 */
 		this.value = value;
 
@@ -41,7 +41,7 @@ class Uniform {
 		 * Derived uniforms will set this property to a data type specific
 		 * value.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.boundary = 0;
 
@@ -49,7 +49,7 @@ class Uniform {
 		 * The item size. Derived uniforms will set this property to a data
 		 * type specific value.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.itemSize = 0;
 
@@ -57,7 +57,7 @@ class Uniform {
 		 * This property is set by {@link UniformsGroup} and marks
 		 * the start position in the uniform buffer.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.offset = 0;
 
@@ -66,7 +66,7 @@ class Uniform {
 	/**
 	 * Sets the uniform's value.
 	 *
-	 * @param {Any} value - The value to set.
+	 * @param {any} value - The value to set.
 	 */
 	setValue( value ) {
 
@@ -77,7 +77,7 @@ class Uniform {
 	/**
 	 * Returns the uniform's value.
 	 *
-	 * @return {Any} The value.
+	 * @return {any} The value.
 	 */
 	getValue() {
 
@@ -98,8 +98,8 @@ class NumberUniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
-	 * @param {Number} value - The uniform's value.
+	 * @param {string} name - The uniform's name.
+	 * @param {number} value - The uniform's value.
 	 */
 	constructor( name, value = 0 ) {
 
@@ -108,7 +108,7 @@ class NumberUniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -132,7 +132,7 @@ class Vector2Uniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
+	 * @param {string} name - The uniform's name.
 	 * @param {Vector2} value - The uniform's value.
 	 */
 	constructor( name, value = new Vector2() ) {
@@ -142,7 +142,7 @@ class Vector2Uniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -166,7 +166,7 @@ class Vector3Uniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
+	 * @param {string} name - The uniform's name.
 	 * @param {Vector3} value - The uniform's value.
 	 */
 	constructor( name, value = new Vector3() ) {
@@ -176,7 +176,7 @@ class Vector3Uniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -200,7 +200,7 @@ class Vector4Uniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
+	 * @param {string} name - The uniform's name.
 	 * @param {Vector4} value - The uniform's value.
 	 */
 	constructor( name, value = new Vector4() ) {
@@ -210,7 +210,7 @@ class Vector4Uniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -234,7 +234,7 @@ class ColorUniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
+	 * @param {string} name - The uniform's name.
 	 * @param {Color} value - The uniform's value.
 	 */
 	constructor( name, value = new Color() ) {
@@ -244,7 +244,7 @@ class ColorUniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -268,7 +268,7 @@ class Matrix2Uniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
+	 * @param {string} name - The uniform's name.
 	 * @param {Matrix2} value - The uniform's value.
 	 */
 	constructor( name, value = new Matrix2() ) {
@@ -278,7 +278,7 @@ class Matrix2Uniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -303,7 +303,7 @@ class Matrix3Uniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
+	 * @param {string} name - The uniform's name.
 	 * @param {Matrix3} value - The uniform's value.
 	 */
 	constructor( name, value = new Matrix3() ) {
@@ -313,7 +313,7 @@ class Matrix3Uniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -337,7 +337,7 @@ class Matrix4Uniform extends Uniform {
 	/**
 	 * Constructs a new Number uniform.
 	 *
-	 * @param {String} name - The uniform's name.
+	 * @param {string} name - The uniform's name.
 	 * @param {Matrix4} value - The uniform's value.
 	 */
 	constructor( name, value = new Matrix4() ) {
@@ -347,7 +347,7 @@ class Matrix4Uniform extends Uniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/UniformBuffer.js

@@ -11,7 +11,7 @@ class UniformBuffer extends Buffer {
 	/**
 	 * Constructs a new uniform buffer.
 	 *
-	 * @param {String} name - The buffer's name.
+	 * @param {string} name - The buffer's name.
 	 * @param {TypedArray} [buffer=null] - The buffer.
 	 */
 	constructor( name, buffer = null ) {
@@ -21,7 +21,7 @@ class UniformBuffer extends Buffer {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */