super-three 0.173.5 → 0.176.0

package/src/nodes/accessors/TextureNode.js

@@ -7,14 +7,12 @@ import { maxMipLevel } from '../utils/MaxMipLevelNode.js';
 import { nodeProxy, vec3, nodeObject, int } from '../tsl/TSLBase.js';
 import { NodeUpdateType } from '../core/constants.js';
 
-import { IntType, UnsignedIntType } from '../../constants.js';
-
-/** @module TextureNode **/
+import { IntType, NearestFilter, UnsignedIntType } from '../../constants.js';
 
 /**
  * This type of uniform node represents a 2D texture.
  *
- * @augments module:UniformNode~UniformNode
+ * @augments UniformNode
  */
 class TextureNode extends UniformNode {
 
@@ -28,9 +26,9 @@ class TextureNode extends UniformNode {
 	 * Constructs a new texture node.
 	 *
 	 * @param {Texture} value - The texture.
-	 * @param {Node<vec2|vec3>?} [uvNode=null] - The uv node.
-	 * @param {Node<int>?} [levelNode=null] - The level node.
-	 * @param {Node<float>?} [biasNode=null] - The bias node.
+	 * @param {?Node<vec2|vec3>} [uvNode=null] - The uv node.
+	 * @param {?Node<int>} [levelNode=null] - The level node.
+	 * @param {?Node<float>} [biasNode=null] - The bias node.
 	 */
 	constructor( value, uvNode = null, levelNode = null, biasNode = null ) {
 
@@ -39,7 +37,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -48,7 +46,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * Represents the texture coordinates.
 		 *
-		 * @type {Node<vec2|vec3>?}
+		 * @type {?Node<vec2|vec3>}
 		 * @default null
 		 */
 		this.uvNode = uvNode;
@@ -56,7 +54,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * Represents the mip level that should be selected.
 		 *
-		 * @type {Node<int>?}
+		 * @type {?Node<int>}
 		 * @default null
 		 */
 		this.levelNode = levelNode;
@@ -64,7 +62,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * Represents the bias to be applied during level-of-detail computation.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.biasNode = biasNode;
@@ -72,7 +70,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * Represents a reference value a texture sample is compared to.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.compareNode = null;
@@ -80,7 +78,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * When using texture arrays, the depth node defines the layer to select.
 		 *
-		 * @type {Node<int>?}
+		 * @type {?Node<int>}
 		 * @default null
 		 */
 		this.depthNode = null;
@@ -88,7 +86,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * When defined, a texture is sampled using explicit gradients.
 		 *
-		 * @type {Array<Node<vec2>>?}
+		 * @type {?Array<Node<vec2>>}
 		 * @default null
 		 */
 		this.gradNode = null;
@@ -96,7 +94,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * Whether texture values should be sampled or fetched.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.sampler = true;
@@ -106,7 +104,7 @@ class TextureNode extends UniformNode {
 		 * automatically updated or not. Use `setUpdateMatrix()`
 		 * if you want to change the value of the property.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.updateMatrix = false;
@@ -116,7 +114,7 @@ class TextureNode extends UniformNode {
 		 * sets the value to `frame` when the uv transformation matrix should
 		 * automatically be updated.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'none'
 		 */
 		this.updateType = NodeUpdateType.NONE;
@@ -124,7 +122,7 @@ class TextureNode extends UniformNode {
 		/**
 		 * The reference node.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.referenceNode = null;
@@ -141,7 +139,7 @@ class TextureNode extends UniformNode {
 		 * The uniform node that represents the uv transformation matrix.
 		 *
 		 * @private
-		 * @type {UniformNode<mat3>?}
+		 * @type {?UniformNode<mat3>}
 		 */
 		this._matrixUniform = null;
 
@@ -178,7 +176,7 @@ class TextureNode extends UniformNode {
 	 * Overwritten since the uniform hash is defined by the texture's UUID.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The uniform hash.
+	 * @return {string} The uniform hash.
 	 */
 	getUniformHash( /*builder*/ ) {
 
@@ -190,7 +188,7 @@ class TextureNode extends UniformNode {
 	 * Overwritten since the node type is inferred from the texture type.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( /*builder*/ ) {
 
@@ -214,7 +212,7 @@ class TextureNode extends UniformNode {
 	 * Overwrites the default implementation to return a fixed value `'texture'`.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The input type.
+	 * @return {string} The input type.
 	 */
 	getInputType( /*builder*/ ) {
 
@@ -236,7 +234,7 @@ class TextureNode extends UniformNode {
 	/**
 	 * Overwritten to always return the texture reference of the node.
 	 *
-	 * @param {Any} state - This method can be invocated in different contexts so `state` can refer to any object type.
+	 * @param {any} state - This method can be invocated in different contexts so `state` can refer to any object type.
 	 * @return {Texture} The texture reference.
 	 */
 	updateReference( /*state*/ ) {
@@ -262,7 +260,7 @@ class TextureNode extends UniformNode {
 	/**
 	 * Defines whether the uv transformation matrix should automatically be updated or not.
 	 *
-	 * @param {Boolean} value - The update toggle.
+	 * @param {boolean} value - The update toggle.
 	 * @return {TextureNode} A reference to this node.
 	 */
 	setUpdateMatrix( value ) {
@@ -370,7 +368,7 @@ class TextureNode extends UniformNode {
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
 	 * @param {Node} uvNode - The uv node to generate code for.
-	 * @return {String} The generated code snippet.
+	 * @return {string} The generated code snippet.
 	 */
 	generateUV( builder, uvNode ) {
 
@@ -382,14 +380,14 @@ class TextureNode extends UniformNode {
 	 * Generates the snippet for the texture sampling.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @param {String} textureProperty - The texture property.
-	 * @param {String} uvSnippet - The uv snippet.
-	 * @param {String?} levelSnippet - The level snippet.
-	 * @param {String?} biasSnippet - The bias snippet.
-	 * @param {String?} depthSnippet - The depth snippet.
-	 * @param {String?} compareSnippet - The compare snippet.
-	 * @param {Array<String>?} gradSnippet - The grad snippet.
-	 * @return {String} The generated code snippet.
+	 * @param {string} textureProperty - The texture property.
+	 * @param {string} uvSnippet - The uv snippet.
+	 * @param {?string} levelSnippet - The level snippet.
+	 * @param {?string} biasSnippet - The bias snippet.
+	 * @param {?string} depthSnippet - The depth snippet.
+	 * @param {?string} compareSnippet - The compare snippet.
+	 * @param {?Array<string>} gradSnippet - The grad snippet.
+	 * @return {string} The generated code snippet.
 	 */
 	generateSnippet( builder, textureProperty, uvSnippet, levelSnippet, biasSnippet, depthSnippet, compareSnippet, gradSnippet ) {
 
@@ -431,8 +429,8 @@ class TextureNode extends UniformNode {
 	 * Generates the code snippet of the texture node.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @param {String} output - The current output.
-	 * @return {String} The generated code snippet.
+	 * @param {string} output - The current output.
+	 * @return {string} The generated code snippet.
 	 */
 	generate( builder, output ) {
 
@@ -441,7 +439,7 @@ class TextureNode extends UniformNode {
 		const properties = builder.getNodeProperties( this );
 		const textureProperty = super.generate( builder, 'property' );
 
-		if ( output === 'sampler' ) {
+		if ( /^sampler/.test( output ) ) {
 
 			return textureProperty + '_sampler';
 
@@ -497,7 +495,7 @@ class TextureNode extends UniformNode {
 	/**
 	 * Sets the sampler value.
 	 *
-	 * @param {Boolean} value - The sampler value to set.
+	 * @param {boolean} value - The sampler value to set.
 	 * @return {TextureNode} A reference to this texture node.
 	 */
 	setSampler( value ) {
@@ -511,7 +509,7 @@ class TextureNode extends UniformNode {
 	/**
 	 * Returns the sampler value.
 	 *
-	 * @return {Boolean} The sampler value.
+	 * @return {boolean} The sampler value.
 	 */
 	getSampler() {
 
@@ -564,6 +562,16 @@ class TextureNode extends UniformNode {
 		textureNode.biasNode = nodeObject( amountNode ).mul( maxMipLevel( textureNode ) );
 		textureNode.referenceNode = this.getSelf();
 
+		const map = textureNode.value;
+
+		if ( map && map.generateMipmaps === false || map.minFilter === NearestFilter || map.magFilter === NearestFilter ) {
+
+			console.warn( 'THREE.TSL: texture().blur() requires mipmaps and sampling. Use .generateMipmaps=true and .minFilter/.magFilter=THREE.LinearFilter in the Texture.' );
+
+			textureNode.biasNode = null;
+
+		}
+
 		return nodeObject( textureNode );
 
 	}
@@ -724,23 +732,25 @@ export default TextureNode;
 /**
  * TSL function for creating a texture node.
  *
+ * @tsl
  * @function
  * @param {Texture} value - The texture.
- * @param {Node<vec2|vec3>?} [uvNode=null] - The uv node.
- * @param {Node<int>?} [levelNode=null] - The level node.
- * @param {Node<float>?} [biasNode=null] - The bias node.
+ * @param {?Node<vec2|vec3>} [uvNode=null] - The uv node.
+ * @param {?Node<int>} [levelNode=null] - The level node.
+ * @param {?Node<float>} [biasNode=null] - The bias node.
  * @returns {TextureNode}
  */
-export const texture = /*@__PURE__*/ nodeProxy( TextureNode );
+export const texture = /*@__PURE__*/ nodeProxy( TextureNode ).setParameterLength( 1, 4 );
 
 /**
  * TSL function for creating a texture node that fetches/loads texels without interpolation.
  *
+ * @tsl
  * @function
  * @param {Texture} value - The texture.
- * @param {Node<vec2|vec3>?} [uvNode=null] - The uv node.
- * @param {Node<int>?} [levelNode=null] - The level node.
- * @param {Node<float>?} [biasNode=null] - The bias node.
+ * @param {?Node<vec2|vec3>} [uvNode=null] - The uv node.
+ * @param {?Node<int>} [levelNode=null] - The level node.
+ * @param {?Node<float>} [biasNode=null] - The bias node.
  * @returns {TextureNode}
  */
 export const textureLoad = ( ...params ) => texture( ...params ).setSampler( false );
@@ -750,8 +760,19 @@ export const textureLoad = ( ...params ) => texture( ...params ).setSampler( fal
 /**
  * Converts a texture or texture node to a sampler.
  *
+ * @tsl
+ * @function
+ * @param {TextureNode|Texture} value - The texture or texture node to convert.
+ * @returns {Node}
+ */
+export const sampler = ( value ) => ( value.isNode === true ? value : texture( value ) ).convert( 'sampler' );
+
+/**
+ * Converts a texture or texture node to a sampler comparison.
+ *
+ * @tsl
  * @function
- * @param {TextureNode|Texture} aTexture - The texture or texture node to convert.
+ * @param {TextureNode|Texture} value - The texture or texture node to convert.
  * @returns {Node}
  */
-export const sampler = ( aTexture ) => ( aTexture.isNode === true ? aTexture : texture( aTexture ) ).convert( 'sampler' );
+export const samplerComparison = ( value ) => ( value.isNode === true ? value : texture( value ) ).convert( 'samplerComparison' );

package/src/nodes/accessors/TextureSizeNode.js

@@ -1,8 +1,6 @@
 import Node from '../core/Node.js';
 import { nodeProxy } from '../tsl/TSLBase.js';
 
-/** @module TextureSizeNode **/
-
 /**
  * A node that represents the dimensions of a texture. The texture size is
  * retrieved in the shader via built-in shader functions like `textureDimensions()`
@@ -22,7 +20,7 @@ class TextureSizeNode extends Node {
 	 * Constructs a new texture size node.
 	 *
 	 * @param {TextureNode} textureNode - A texture node which size should be retrieved.
-	 * @param {Node<int>?} [levelNode=null] - A level node which defines the requested mip.
+	 * @param {?Node<int>} [levelNode=null] - A level node which defines the requested mip.
 	 */
 	constructor( textureNode, levelNode = null ) {
 
@@ -31,7 +29,7 @@ class TextureSizeNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -70,9 +68,10 @@ export default TextureSizeNode;
 /**
  * TSL function for creating a texture size node.
  *
+ * @tsl
  * @function
  * @param {TextureNode} textureNode - A texture node which size should be retrieved.
- * @param {Node<int>?} [levelNode=null] - A level node which defines the requested mip.
+ * @param {?Node<int>} [levelNode=null] - A level node which defines the requested mip.
  * @returns {TextureSizeNode}
  */
-export const textureSize = /*@__PURE__*/ nodeProxy( TextureSizeNode );
+export const textureSize = /*@__PURE__*/ nodeProxy( TextureSizeNode ).setParameterLength( 1, 2 );

package/src/nodes/accessors/UV.js

@@ -1,12 +1,11 @@
 import { attribute } from '../core/AttributeNode.js';
 
-/** @module UV **/
-
 /**
  * TSL function for creating an uv attribute node with the given index.
  *
+ * @tsl
  * @function
- * @param {Number} [index=0] - The uv index.
+ * @param {number} [index=0] - The uv index.
  * @return {AttributeNode<vec2>} The uv attribute node.
  */
 export const uv = ( index = 0 ) => attribute( 'uv' + ( index > 0 ? index : '' ), 'vec2' );

package/src/nodes/accessors/UniformArrayNode.js

@@ -4,8 +4,6 @@ import { getValueType } from '../core/NodeUtils.js';
 import ArrayElementNode from '../utils/ArrayElementNode.js';
 import BufferNode from './BufferNode.js';
 
-/** @module UniformArrayNode **/
-
 /**
  * Represents the element access on uniform array nodes.
  *
@@ -32,7 +30,7 @@ class UniformArrayElementNode extends ArrayElementNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -53,8 +51,8 @@ class UniformArrayElementNode extends ArrayElementNode {
 }
 
 /**
- * Similar to {@link module:BufferNode~BufferNode} this module represents array-like data as
- * uniform buffers. Unlike {@link module:BufferNode~BufferNode}, it can handle more common
+ * Similar to {@link BufferNode} this module represents array-like data as
+ * uniform buffers. Unlike {@link BufferNode}, it can handle more common
  * data types in the array (e.g `three.js` primitives) and automatically
  * manage buffer padding. It should be the first choice when working with
  * uniforms buffers.
@@ -67,7 +65,7 @@ class UniformArrayElementNode extends ArrayElementNode {
  *
  * const redColor = tintColors.element( 0 );
  *
- * @augments module:BufferNode~BufferNode
+ * @augments BufferNode
  */
 class UniformArrayNode extends BufferNode {
 
@@ -80,26 +78,26 @@ class UniformArrayNode extends BufferNode {
 	/**
 	 * Constructs a new uniform array node.
 	 *
-	 * @param {Array<Any>} value - Array holding the buffer data.
-	 * @param {String?} [elementType=null] - The data type of a buffer element.
+	 * @param {Array<any>} value - Array holding the buffer data.
+	 * @param {?string} [elementType=null] - The data type of a buffer element.
 	 */
 	constructor( value, elementType = null ) {
 
 		super( null );
 
 		/**
-		 * Array holding the buffer data. Unlike {@link module:BufferNode~BufferNode}, the array can
+		 * Array holding the buffer data. Unlike {@link BufferNode}, the array can
 		 * hold number primitives as well as three.js objects like vectors, matrices
 		 * or colors.
 		 *
-		 * @type {Array<Any>}
+		 * @type {Array<any>}
 		 */
 		this.array = value;
 
 		/**
 		 * The data type of an array element.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.elementType = elementType === null ? getValueType( value[ 0 ] ) : elementType;
 
@@ -107,14 +105,14 @@ class UniformArrayNode extends BufferNode {
 		 * The padded type. Uniform buffers must conform to a certain buffer layout
 		 * so a separate type is computed to ensure correct buffer size.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.paddedType = this.getPaddedType();
 
 		/**
 		 * Overwritten since uniform array nodes are updated per render.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'render'
 		 */
 		this.updateType = NodeUpdateType.RENDER;
@@ -122,7 +120,7 @@ class UniformArrayNode extends BufferNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -132,10 +130,10 @@ class UniformArrayNode extends BufferNode {
 
 	/**
 	 * This method is overwritten since the node type is inferred from the
-	 * {@link module:UniformArrayNode~UniformArrayNode#paddedType}.
+	 * {@link UniformArrayNode#paddedType}.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( /*builder*/ ) {
 
@@ -147,7 +145,7 @@ class UniformArrayNode extends BufferNode {
 	 * The data type of the array elements.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The element type.
+	 * @return {string} The element type.
 	 */
 	getElementType() {
 
@@ -158,7 +156,7 @@ class UniformArrayNode extends BufferNode {
 	/**
 	 * Returns the padded type based on the element type.
 	 *
-	 * @return {String} The padded type.
+	 * @return {string} The padded type.
 	 */
 	getPaddedType() {
 
@@ -323,7 +321,7 @@ class UniformArrayNode extends BufferNode {
 
 	/**
 	 * Overwrites the default `element()` method to provide element access
-	 * based on {@link module:UniformArrayNode~UniformArrayNode}.
+	 * based on {@link UniformArrayNode}.
 	 *
 	 * @param {IndexNode} indexNode - The index node.
 	 * @return {UniformArrayElementNode}
@@ -341,24 +339,26 @@ export default UniformArrayNode;
 /**
  * TSL function for creating an uniform array node.
  *
+ * @tsl
  * @function
- * @param {Array<Any>} values - Array-like data.
- * @param {String?} nodeType - The data type of the array elements.
+ * @param {Array<any>} values - Array-like data.
+ * @param {?string} [nodeType] - The data type of the array elements.
  * @returns {UniformArrayNode}
  */
 export const uniformArray = ( values, nodeType ) => nodeObject( new UniformArrayNode( values, nodeType ) );
 
 /**
+ * @tsl
  * @function
  * @deprecated since r168. Use {@link uniformArray} instead.
  *
- * @param {Array<Any>} values - Array-like data.
- * @param {String} nodeType - The data type of the array elements.
+ * @param {Array<any>} values - Array-like data.
+ * @param {string} nodeType - The data type of the array elements.
  * @returns {UniformArrayNode}
  */
 export const uniforms = ( values, nodeType ) => { // @deprecated, r168
 
-	console.warn( 'TSL.UniformArrayNode: uniforms() has been renamed to uniformArray().' );
+	console.warn( 'THREE.TSL: uniforms() has been renamed to uniformArray().' );
 	return nodeObject( new UniformArrayNode( values, nodeType ) );
 
 };

package/src/nodes/accessors/UserDataNode.js

@@ -1,8 +1,6 @@
 import ReferenceNode from './ReferenceNode.js';
 import { nodeObject } from '../tsl/TSLBase.js';
 
-/** @module UserDataNode **/
-
 /**
  * A special type of reference node that allows to link values in
  * `userData` fields to node objects.
@@ -12,10 +10,10 @@ import { nodeObject } from '../tsl/TSLBase.js';
  * const material = new THREE.SpriteNodeMaterial();
  * material.rotationNode = userData( 'rotation', 'float' );
  * ```
- * Since `UserDataNode` is extended from {@link module:ReferenceNode~ReferenceNode}, the node value
+ * Since `UserDataNode` is extended from {@link ReferenceNode}, the node value
  * will automatically be updated when the `rotation` user data field changes.
  *
- * @augments module:ReferenceNode~ReferenceNode
+ * @augments ReferenceNode
  */
 class UserDataNode extends ReferenceNode {
 
@@ -28,9 +26,9 @@ class UserDataNode extends ReferenceNode {
 	/**
 	 * Constructs a new user data node.
 	 *
-	 * @param {String} property - The property name that should be referenced by the node.
-	 * @param {String} inputType - The node data type of the reference.
-	 * @param {Object?} [userData=null] - A reference to the `userData` object. If not provided, the `userData` property of the 3D object that uses the node material is evaluated.
+	 * @param {string} property - The property name that should be referenced by the node.
+	 * @param {string} inputType - The node data type of the reference.
+	 * @param {?Object} [userData=null] - A reference to the `userData` object. If not provided, the `userData` property of the 3D object that uses the node material is evaluated.
 	 */
 	constructor( property, inputType, userData = null ) {
 
@@ -40,7 +38,7 @@ class UserDataNode extends ReferenceNode {
 		 * A reference to the `userData` object. If not provided, the `userData`
 		 * property of the 3D object that uses the node material is evaluated.
 		 *
-		 * @type {Object?}
+		 * @type {?Object}
 		 * @default null
 		 */
 		this.userData = userData;
@@ -48,7 +46,7 @@ class UserDataNode extends ReferenceNode {
 	}
 
 	/**
-	 * Overwritten to make sure {@link module:ReferenceNode~ReferenceNode#reference} points to the correct
+	 * Overwritten to make sure {@link ReferenceNode#reference} points to the correct
 	 * `userData` field.
 	 *
 	 * @param {(NodeFrame|NodeBuilder)} state - The current state to evaluate.
@@ -69,10 +67,11 @@ export default UserDataNode;
 /**
  * TSL function for creating a user data node.
  *
+ * @tsl
  * @function
- * @param {String} name - The property name that should be referenced by the node.
- * @param {String} inputType - The node data type of the reference.
- * @param {Object?} userData - A reference to the `userData` object. If not provided, the `userData` property of the 3D object that uses the node material is evaluated.
+ * @param {string} name - The property name that should be referenced by the node.
+ * @param {string} inputType - The node data type of the reference.
+ * @param {?Object} userData - A reference to the `userData` object. If not provided, the `userData` property of the 3D object that uses the node material is evaluated.
  * @returns {UserDataNode}
  */
 export const userData = ( name, inputType, userData ) => nodeObject( new UserDataNode( name, inputType, userData ) );

package/src/nodes/accessors/VelocityNode.js

@@ -11,8 +11,6 @@ import { renderGroup } from '../core/UniformGroupNode.js';
 
 const _objectData = new WeakMap();
 
-/** @module VelocityNode **/
-
 /**
  * A node for representing motion or velocity vectors. Foundation
  * for advanced post processing effects like motion blur or TRAA.
@@ -41,7 +39,7 @@ class VelocityNode extends TempNode {
 		/**
 		 * The current projection matrix.
 		 *
-		 * @type {Matrix4?}
+		 * @type {?Matrix4}
 		 * @default null
 		 */
 		this.projectionMatrix = null;
@@ -49,7 +47,7 @@ class VelocityNode extends TempNode {
 		/**
 		 * Overwritten since velocity nodes are updated per object.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'object'
 		 */
 		this.updateType = NodeUpdateType.OBJECT;
@@ -57,7 +55,7 @@ class VelocityNode extends TempNode {
 		/**
 		 * Overwritten since velocity nodes save data after the update.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'object'
 		 */
 		this.updateAfterType = NodeUpdateType.OBJECT;
@@ -219,6 +217,7 @@ export default VelocityNode;
 /**
  * TSL object that represents the velocity of a render pass.
  *
+ * @tsl
  * @type {VelocityNode}
  */
 export const velocity = /*@__PURE__*/ nodeImmutable( VelocityNode );