super-three 0.173.4 → 0.175.0

package/src/nodes/accessors/StorageBufferNode.js

@@ -5,8 +5,6 @@ import { storageElement } from '../utils/StorageArrayElementNode.js';
 import { NodeAccess } from '../core/constants.js';
 import { getTypeFromLength } from '../core/NodeUtils.js';
 
-/** @module StorageBufferNode **/
-
 /**
  * This node is used in context of compute shaders and allows to define a
  * storage buffer for data. A typical workflow is to create instances of
@@ -50,8 +48,8 @@ class StorageBufferNode extends BufferNode {
 	 * Constructs a new storage buffer node.
 	 *
 	 * @param {StorageBufferAttribute|StorageInstancedBufferAttribute|BufferAttribute} value - The buffer data.
-	 * @param {(String|Struct)?} [bufferType=null] - The buffer type (e.g. `'vec3'`).
-	 * @param {Number} [bufferCount=0] - The buffer count.
+	 * @param {?(string|Struct)} [bufferType=null] - The buffer type (e.g. `'vec3'`).
+	 * @param {number} [bufferCount=0] - The buffer count.
 	 */
 	constructor( value, bufferType = null, bufferCount = 0 ) {
 
@@ -78,7 +76,7 @@ class StorageBufferNode extends BufferNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -88,7 +86,7 @@ class StorageBufferNode extends BufferNode {
 		/**
 		 * The buffer struct type.
 		 *
-		 * @type {structTypeNode?}
+		 * @type {?StructTypeNode}
 		 * @default null
 		 */
 		this.structTypeNode = structTypeNode;
@@ -96,7 +94,7 @@ class StorageBufferNode extends BufferNode {
 		/**
 		 * The access type of the texture node.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'readWrite'
 		 */
 		this.access = NodeAccess.READ_WRITE;
@@ -104,7 +102,7 @@ class StorageBufferNode extends BufferNode {
 		/**
 		 * Whether the node is atomic or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.isAtomic = false;
@@ -113,7 +111,7 @@ class StorageBufferNode extends BufferNode {
 		 * Whether the node represents a PBO or not.
 		 * Only relevant for WebGL.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.isPBO = false;
@@ -121,7 +119,7 @@ class StorageBufferNode extends BufferNode {
 		/**
 		 * A reference to the internal buffer attribute node.
 		 *
-		 * @type {BufferAttributeNode?}
+		 * @type {?BufferAttributeNode}
 		 * @default null
 		 */
 		this._attribute = null;
@@ -129,7 +127,7 @@ class StorageBufferNode extends BufferNode {
 		/**
 		 * A reference to the internal varying node.
 		 *
-		 * @type {VaryingNode?}
+		 * @type {?VaryingNode}
 		 * @default null
 		 */
 		this._varying = null;
@@ -137,7 +135,7 @@ class StorageBufferNode extends BufferNode {
 		/**
 		 * `StorageBufferNode` sets this property to `true` by default.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.global = true;
@@ -158,7 +156,7 @@ class StorageBufferNode extends BufferNode {
 	 * and thus the hash should be shared as well.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The hash.
+	 * @return {string} The hash.
 	 */
 	getHash( builder ) {
 
@@ -188,7 +186,7 @@ class StorageBufferNode extends BufferNode {
 	 * Overwrites the default implementation to return a fixed value `'indirectStorageBuffer'` or `'storageBuffer'`.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The input type.
+	 * @return {string} The input type.
 	 */
 	getInputType( /*builder*/ ) {
 
@@ -211,7 +209,7 @@ class StorageBufferNode extends BufferNode {
 	/**
 	 * Defines whether this node is a PBO or not. Only relevant for WebGL.
 	 *
-	 * @param {Boolean} value - The value so set.
+	 * @param {boolean} value - The value so set.
 	 * @return {StorageBufferNode} A reference to this node.
 	 */
 	setPBO( value ) {
@@ -225,7 +223,7 @@ class StorageBufferNode extends BufferNode {
 	/**
 	 * Returns the `isPBO` value.
 	 *
-	 * @return {Boolean} Whether the node represents a PBO or not.
+	 * @return {boolean} Whether the node represents a PBO or not.
 	 */
 	getPBO() {
 
@@ -236,7 +234,7 @@ class StorageBufferNode extends BufferNode {
 	/**
 	 * Defines the node access.
 	 *
-	 * @param {String} value - The node access.
+	 * @param {string} value - The node access.
 	 * @return {StorageBufferNode} A reference to this node.
 	 */
 	setAccess( value ) {
@@ -261,7 +259,7 @@ class StorageBufferNode extends BufferNode {
 	/**
 	 * Defines whether the node is atomic or not.
 	 *
-	 * @param {Boolean} value - The atomic flag.
+	 * @param {boolean} value - The atomic flag.
 	 * @return {StorageBufferNode} A reference to this node.
 	 */
 	setAtomic( value ) {
@@ -309,7 +307,7 @@ class StorageBufferNode extends BufferNode {
 	 * and the attribute data.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( builder ) {
 
@@ -335,7 +333,7 @@ class StorageBufferNode extends BufferNode {
 	 * Generates the code snippet of the storage buffer node.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The generated code snippet.
+	 * @return {string} The generated code snippet.
 	 */
 	generate( builder ) {
 
@@ -364,21 +362,23 @@ export default StorageBufferNode;
 /**
  * TSL function for creating a storage buffer node.
  *
+ * @tsl
  * @function
  * @param {StorageBufferAttribute|StorageInstancedBufferAttribute|BufferAttribute} value - The buffer data.
- * @param {(String|Struct)?} [type=null] - The buffer type (e.g. `'vec3'`).
- * @param {Number} [count=0] - The buffer count.
+ * @param {?(string|Struct)} [type=null] - The buffer type (e.g. `'vec3'`).
+ * @param {number} [count=0] - The buffer count.
  * @returns {StorageBufferNode}
  */
 export const storage = ( value, type = null, count = 0 ) => nodeObject( new StorageBufferNode( value, type, count ) );
 
 /**
+ * @tsl
  * @function
  * @deprecated since r171. Use `storage().setPBO( true )` instead.
  *
  * @param {StorageBufferAttribute|StorageInstancedBufferAttribute|BufferAttribute} value - The buffer data.
- * @param {String?} type - The buffer type (e.g. `'vec3'`).
- * @param {Number} count - The buffer count.
+ * @param {?string} type - The buffer type (e.g. `'vec3'`).
+ * @param {number} count - The buffer count.
  * @returns {StorageBufferNode}
  */
 export const storageObject = ( value, type, count ) => { // @deprecated, r171

package/src/nodes/accessors/StorageTextureNode.js

@@ -2,8 +2,6 @@ import TextureNode from './TextureNode.js';
 import { nodeProxy } from '../tsl/TSLBase.js';
 import { NodeAccess } from '../core/constants.js';
 
-/** @module StorageTextureNode **/
-
 /**
  * This special version of a texture node can be used to
  * write data into a storage texture with a compute shader.
@@ -13,7 +11,7 @@ import { NodeAccess } from '../core/constants.js';
  *
  * const computeTexture = Fn( ( { storageTexture } ) => {
  *
- * 	const posX = instanceIndex.modInt( width );
+ * 	const posX = instanceIndex.mod( width );
  * 	const posY = instanceIndex.div( width );
  * 	const indexUV = uvec2( posX, posY );
  *
@@ -33,7 +31,7 @@ import { NodeAccess } from '../core/constants.js';
  *
  * This node can only be used with a WebGPU backend.
  *
- * @augments module:TextureNode~TextureNode
+ * @augments TextureNode
  */
 class StorageTextureNode extends TextureNode {
 
@@ -48,7 +46,7 @@ class StorageTextureNode extends TextureNode {
 	 *
 	 * @param {StorageTexture} value - The storage texture.
 	 * @param {Node<vec2|vec3>} uvNode - The uv node.
-	 * @param {Node?} [storeNode=null] - The value node that should be stored in the texture.
+	 * @param {?Node} [storeNode=null] - The value node that should be stored in the texture.
 	 */
 	constructor( value, uvNode, storeNode = null ) {
 
@@ -57,7 +55,7 @@ class StorageTextureNode extends TextureNode {
 		/**
 		 * The value node that should be stored in the texture.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.storeNode = storeNode;
@@ -65,7 +63,7 @@ class StorageTextureNode extends TextureNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -74,7 +72,7 @@ class StorageTextureNode extends TextureNode {
 		/**
 		 * The access type of the texture node.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'writeOnly'
 		 */
 		this.access = NodeAccess.WRITE_ONLY;
@@ -85,7 +83,7 @@ class StorageTextureNode extends TextureNode {
 	 * Overwrites the default implementation to return a fixed value `'storageTexture'`.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The input type.
+	 * @return {string} The input type.
 	 */
 	getInputType( /*builder*/ ) {
 
@@ -105,7 +103,7 @@ class StorageTextureNode extends TextureNode {
 	/**
 	 * Defines the node access.
 	 *
-	 * @param {String} value - The node access.
+	 * @param {string} value - The node access.
 	 * @return {StorageTextureNode} A reference to this node.
 	 */
 	setAccess( value ) {
@@ -116,12 +114,12 @@ class StorageTextureNode extends TextureNode {
 	}
 
 	/**
-	 * Generates the code snippet of the stroge node. If no `storeNode`
+	 * Generates the code snippet of the storage node. If no `storeNode`
 	 * is defined, the texture node is generated as normal texture.
 	 *
 	 * @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 ) {
 
@@ -202,22 +200,24 @@ export default StorageTextureNode;
 /**
  * TSL function for creating a storage texture node.
  *
+ * @tsl
  * @function
  * @param {StorageTexture} value - The storage texture.
- * @param {Node<vec2|vec3>} uvNode - The uv node.
- * @param {Node?} [storeNode=null] - The value node that should be stored in the texture.
+ * @param {?Node<vec2|vec3>} uvNode - The uv node.
+ * @param {?Node} [storeNode=null] - The value node that should be stored in the texture.
  * @returns {StorageTextureNode}
  */
-export const storageTexture = /*@__PURE__*/ nodeProxy( StorageTextureNode );
+export const storageTexture = /*@__PURE__*/ nodeProxy( StorageTextureNode ).setParameterLength( 1, 3 );
 
 
 /**
  * TODO: Explain difference to `storageTexture()`.
  *
+ * @tsl
  * @function
  * @param {StorageTexture} value - The storage texture.
  * @param {Node<vec2|vec3>} uvNode - The uv node.
- * @param {Node?} [storeNode=null] - The value node that should be stored in the texture.
+ * @param {?Node} [storeNode=null] - The value node that should be stored in the texture.
  * @returns {StorageTextureNode}
  */
 export const textureStore = ( value, uvNode, storeNode ) => {

package/src/nodes/accessors/Tangent.js

@@ -3,11 +3,10 @@ import { cameraViewMatrix } from './Camera.js';
 import { modelViewMatrix } from './ModelNode.js';
 import { Fn, vec4 } from '../tsl/TSLBase.js';
 
-/** @module Tangent **/
-
 /**
  * TSL object that represents the tangent attribute of the current rendered object.
  *
+ * @tsl
  * @type {Node<vec4>}
  */
 export const tangentGeometry = /*@__PURE__*/ Fn( ( builder ) => {
@@ -25,6 +24,7 @@ export const tangentGeometry = /*@__PURE__*/ Fn( ( builder ) => {
 /**
  * TSL object that represents the vertex tangent in local space of the current rendered object.
  *
+ * @tsl
  * @type {Node<vec3>}
  */
 export const tangentLocal = /*@__PURE__*/ tangentGeometry.xyz.toVar( 'tangentLocal' );
@@ -32,6 +32,7 @@ export const tangentLocal = /*@__PURE__*/ tangentGeometry.xyz.toVar( 'tangentLoc
 /**
  * TSL object that represents the vertex tangent in view space of the current rendered object.
  *
+ * @tsl
  * @type {Node<vec3>}
  */
 export const tangentView = /*@__PURE__*/ modelViewMatrix.mul( vec4( tangentLocal, 0 ) ).xyz.toVarying( 'v_tangentView' ).normalize().toVar( 'tangentView' );
@@ -39,6 +40,7 @@ export const tangentView = /*@__PURE__*/ modelViewMatrix.mul( vec4( tangentLocal
 /**
  * TSL object that represents the vertex tangent in world space of the current rendered object.
  *
+ * @tsl
  * @type {Node<vec3>}
  */
 export const tangentWorld = /*@__PURE__*/ tangentView.transformDirection( cameraViewMatrix ).toVarying( 'v_tangentWorld' ).normalize().toVar( 'tangentWorld' );
@@ -46,6 +48,7 @@ export const tangentWorld = /*@__PURE__*/ tangentView.transformDirection( camera
 /**
  * TSL object that represents the transformed vertex tangent in view space of the current rendered object.
  *
+ * @tsl
  * @type {Node<vec3>}
  */
 export const transformedTangentView = /*@__PURE__*/ tangentView.toVar( 'transformedTangentView' );
@@ -53,6 +56,7 @@ export const transformedTangentView = /*@__PURE__*/ tangentView.toVar( 'transfor
 /**
  * TSL object that represents the transformed vertex tangent in world space of the current rendered object.
  *
+ * @tsl
  * @type {Node<vec3>}
  */
 export const transformedTangentWorld = /*@__PURE__*/ transformedTangentView.transformDirection( cameraViewMatrix ).normalize().toVar( 'transformedTangentWorld' );

package/src/nodes/accessors/Texture3DNode.js

@@ -2,8 +2,6 @@ import TextureNode from './TextureNode.js';
 import { nodeProxy, vec3, Fn, If, int } from '../tsl/TSLBase.js';
 import { textureSize } from './TextureSizeNode.js';
 
-/** @module Texture3DNode **/
-
 const normal = Fn( ( { texture, uv } ) => {
 
 	const epsilon = 0.0001;
@@ -53,7 +51,7 @@ const normal = Fn( ( { texture, uv } ) => {
 /**
  * This type of uniform node represents a 3D texture.
  *
- * @augments module:TextureNode~TextureNode
+ * @augments TextureNode
  */
 class Texture3DNode extends TextureNode {
 
@@ -67,8 +65,8 @@ class Texture3DNode extends TextureNode {
 	 * Constructs a new 3D texture node.
 	 *
 	 * @param {Data3DTexture} value - The 3D texture.
-	 * @param {Node<vec2|vec3>?} [uvNode=null] - The uv node.
-	 * @param {Node<int>?} [levelNode=null] - The level node.
+	 * @param {?Node<vec2|vec3>} [uvNode=null] - The uv node.
+	 * @param {?Node<int>} [levelNode=null] - The level node.
 	 */
 	constructor( value, uvNode = null, levelNode = null ) {
 
@@ -77,7 +75,7 @@ class Texture3DNode extends TextureNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -89,7 +87,7 @@ class Texture3DNode extends TextureNode {
 	 * Overwrites the default implementation to return a fixed value `'texture3D'`.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The input type.
+	 * @return {string} The input type.
 	 */
 	getInputType( /*builder*/ ) {
 
@@ -113,7 +111,7 @@ class Texture3DNode extends TextureNode {
 	 * Overwritten with an empty implementation since the `updateMatrix` flag is ignored
 	 * for 3D textures. The uv transformation matrix is not applied to 3D textures.
 	 *
-	 * @param {Boolean} value - The update toggle.
+	 * @param {boolean} value - The update toggle.
 	 */
 	setUpdateMatrix( /*value*/ ) { } // Ignore .updateMatrix for 3d TextureNode
 
@@ -151,7 +149,7 @@ class Texture3DNode extends TextureNode {
 	 *
 	 * @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 ) {
 
@@ -178,10 +176,11 @@ export default Texture3DNode;
 /**
  * TSL function for creating a 3D texture node.
  *
+ * @tsl
  * @function
  * @param {Data3DTexture} value - The 3D texture.
- * @param {Node<vec2|vec3>?} [uvNode=null] - The uv node.
- * @param {Node<int>?} [levelNode=null] - The level node.
+ * @param {?Node<vec2|vec3>} [uvNode=null] - The uv node.
+ * @param {?Node<int>} [levelNode=null] - The level node.
  * @returns {Texture3DNode}
  */
-export const texture3D = /*@__PURE__*/ nodeProxy( Texture3DNode );
+export const texture3D = /*@__PURE__*/ nodeProxy( Texture3DNode ).setParameterLength( 1, 3 );

package/src/nodes/accessors/TextureBicubic.js

@@ -2,8 +2,6 @@ import { add, mul, div } from '../math/OperatorNode.js';
 import { floor, ceil, fract, pow } from '../math/MathNode.js';
 import { Fn, float, vec2, vec4, int } from '../tsl/TSLBase.js';
 
-/** @module TextureBicubic **/
-
 // Mipped Bicubic Texture Filtering by N8
 // https://www.shadertoy.com/view/Dl2SDW
 
@@ -56,7 +54,8 @@ const bicubic = ( textureNode, texelSize, lod ) => {
 /**
  * Applies mipped bicubic texture filtering to the given texture node.
  *
- * @method
+ * @tsl
+ * @function
  * @param {TextureNode} textureNode - The texture node that should be filtered.
  * @param {Node<float>} [lodNode=float(3)] - Defines the LOD to sample from.
  * @return {Node} The filtered texture sample.