Explorar o código

Documentation: Add missing JSDoc. (#32921)

Michael Herzog hai 3 semanas
pai
achega
edc270bbbd

+ 4 - 4
src/animation/PropertyMixer.js

@@ -88,7 +88,7 @@ class PropertyMixer {
 		this._addIndex = 4;
 		this._addIndex = 4;
 
 
 		/**
 		/**
-		 * TODO
+		 * Accumulated weight of the property binding.
 		 *
 		 *
 		 * @type {number}
 		 * @type {number}
 		 * @default 0
 		 * @default 0
@@ -96,7 +96,7 @@ class PropertyMixer {
 		this.cumulativeWeight = 0;
 		this.cumulativeWeight = 0;
 
 
 		/**
 		/**
-		 * TODO
+		 * Accumulated additive weight of the property binding.
 		 *
 		 *
 		 * @type {number}
 		 * @type {number}
 		 * @default 0
 		 * @default 0
@@ -104,7 +104,7 @@ class PropertyMixer {
 		this.cumulativeWeightAdditive = 0;
 		this.cumulativeWeightAdditive = 0;
 
 
 		/**
 		/**
-		 * TODO
+		 * Number of active keyframe tracks currently using this property binding.
 		 *
 		 *
 		 * @type {number}
 		 * @type {number}
 		 * @default 0
 		 * @default 0
@@ -112,7 +112,7 @@ class PropertyMixer {
 		this.useCount = 0;
 		this.useCount = 0;
 
 
 		/**
 		/**
-		 * TODO
+		 * Number of keyframe tracks referencing this property binding.
 		 *
 		 *
 		 * @type {number}
 		 * @type {number}
 		 * @default 0
 		 * @default 0

+ 2 - 1
src/lights/webgpu/IESSpotLight.js

@@ -22,7 +22,8 @@ class IESSpotLight extends SpotLight {
 		super( color, intensity, distance, angle, penumbra, decay );
 		super( color, intensity, distance, angle, penumbra, decay );
 
 
 		/**
 		/**
-		 * TODO
+		 * The IES map. It's a lookup table that stores normalized attenuation factors
+		 * (0.0 to 1.0) that represent the light's intensity at a specific angle.
 		 *
 		 *
 		 * @type {?Texture}
 		 * @type {?Texture}
 		 * @default null
 		 * @default null

+ 5 - 3
src/nodes/accessors/Texture3DNode.js

@@ -141,10 +141,12 @@ class Texture3DNode extends TextureNode {
 	}
 	}
 
 
 	/**
 	/**
-	 * TODO.
+	 * Computes the normal for the given uv. These texture coordiantes represent a
+	 * certain point inside the 3D texture. Unlike geometric normals, this normal
+	 * represents a slope or gradient of scalar data inside the 3D texture.
 	 *
 	 *
-	 * @param {Node<vec3>} uvNode - The uv node .
-	 * @return {Node<vec3>} TODO.
+	 * @param {Node<vec3>} uvNode - The uv node that defines a points in the 3D texture.
+	 * @return {Node<vec3>} The normal representing the slope/gradient in the data.
 	 */
 	 */
 	normal( uvNode ) {
 	normal( uvNode ) {
 
 

+ 5 - 3
src/renderers/common/TimestampQueryPool.js

@@ -54,7 +54,7 @@ class TimestampQueryPool {
 		this.isDisposed = false;
 		this.isDisposed = false;
 
 
 		/**
 		/**
-		 * TODO
+		 * The total frame duration until the next update.
 		 *
 		 *
 		 * @type {number}
 		 * @type {number}
 		 * @default 0
 		 * @default 0
@@ -69,9 +69,11 @@ class TimestampQueryPool {
 		this.frames = [];
 		this.frames = [];
 
 
 		/**
 		/**
-		 * TODO
+		 * This property is used to avoid multiple concurrent resolve operations.
+		 * The WebGL backend uses it as a boolean flag. In context of WebGPU, it holds
+		 * the promise of the current resolve operation.
 		 *
 		 *
-		 * @type {boolean}
+		 * @type {boolean|Promise<number>}
 		 * @default false
 		 * @default false
 		 */
 		 */
 		this.pendingResolve = false;
 		this.pendingResolve = false;

粤ICP备19079148号