super-three 0.173.4 → 0.175.0

package/src/nodes/gpgpu/AtomicFunctionNode.js

@@ -1,8 +1,6 @@
 import TempNode from '../core/TempNode.js';
 import { nodeProxy } from '../tsl/TSLCore.js';
 
-/** @module AtomicFunctionNode **/
-
 /**
  * `AtomicFunctionNode` represents any function that can operate on atomic variable types
  * within a shader. In an atomic function, any modification to an atomic variable will
@@ -25,19 +23,18 @@ class AtomicFunctionNode extends TempNode {
 	/**
 	 * Constructs a new atomic function node.
 	 *
-	 * @param {String} method - The signature of the atomic function to construct.
+	 * @param {string} method - The signature of the atomic function to construct.
 	 * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
 	 * @param {Node} valueNode - The value that mutates the atomic variable.
-	 * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
 	 */
-	constructor( method, pointerNode, valueNode, storeNode = null ) {
+	constructor( method, pointerNode, valueNode ) {
 
 		super( 'uint' );
 
 		/**
 		 * The signature of the atomic function to construct.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.method = method;
 
@@ -55,14 +52,6 @@ class AtomicFunctionNode extends TempNode {
 		 */
 		this.valueNode = valueNode;
 
-		/**
-		 * A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
-		 *
-		 * @type {Node?}
-		 * @default null
-		 */
-		this.storeNode = storeNode;
-
 	}
 
 	/**
@@ -70,7 +59,7 @@ class AtomicFunctionNode extends TempNode {
 	 * the pointer node.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The input type.
+	 * @return {string} The input type.
 	 */
 	getInputType( builder ) {
 
@@ -82,7 +71,7 @@ class AtomicFunctionNode extends TempNode {
 	 * Overwritten since the node type is inferred from the input type.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( builder ) {
 
@@ -111,20 +100,16 @@ class AtomicFunctionNode extends TempNode {
 
 		}
 
-		const methodSnippet = `${ builder.getMethod( method, type ) }( ${params.join( ', ' )} )`;
+		const methodSnippet = `${ builder.getMethod( method, type ) }( ${ params.join( ', ' ) } )`;
 
-		if ( this.storeNode !== null ) {
-
-			const varSnippet = this.storeNode.build( builder, inputType );
-
-			builder.addLineFlowCode( `${varSnippet} = ${methodSnippet}`, this );
-
-		} else {
+		if ( b !== null ) {
 
 			builder.addLineFlowCode( methodSnippet, this );
 
 		}
 
+		return methodSnippet;
+
 	}
 
 }
@@ -144,11 +129,11 @@ export default AtomicFunctionNode;
 /**
  * TSL function for creating an atomic function node.
  *
+ * @tsl
  * @function
- * @param {String} method - The signature of the atomic function to construct.
+ * @param {string} method - The signature of the atomic function to construct.
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
 const atomicNode = nodeProxy( AtomicFunctionNode );
@@ -156,16 +141,16 @@ const atomicNode = nodeProxy( AtomicFunctionNode );
 /**
  * TSL function for appending an atomic function call into the programmatic flow of a compute shader.
  *
+ * @tsl
  * @function
- * @param {String} method - The signature of the atomic function to construct.
+ * @param {string} method - The signature of the atomic function to construct.
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicFunc = ( method, pointerNode, valueNode, storeNode = null ) => {
+export const atomicFunc = ( method, pointerNode, valueNode ) => {
 
-	const node = atomicNode( method, pointerNode, valueNode, storeNode );
+	const node = atomicNode( method, pointerNode, valueNode );
 	node.append();
 
 	return node;
@@ -175,97 +160,97 @@ export const atomicFunc = ( method, pointerNode, valueNode, storeNode = null ) =
 /**
  * Loads the value stored in the atomic variable.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicLoad = ( pointerNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_LOAD, pointerNode, null, storeNode );
+export const atomicLoad = ( pointerNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_LOAD, pointerNode, null );
 
 /**
  * Stores a value in the atomic variable.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicStore = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_STORE, pointerNode, valueNode, storeNode );
+export const atomicStore = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_STORE, pointerNode, valueNode );
 
 /**
  * Increments the value stored in the atomic variable.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicAdd = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_ADD, pointerNode, valueNode, storeNode );
+export const atomicAdd = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_ADD, pointerNode, valueNode );
 
 /**
  * Decrements the value stored in the atomic variable.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicSub = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_SUB, pointerNode, valueNode, storeNode );
+export const atomicSub = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_SUB, pointerNode, valueNode );
 
 /**
  * Stores in an atomic variable the maximum between its current value and a parameter.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicMax = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_MAX, pointerNode, valueNode, storeNode );
+export const atomicMax = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_MAX, pointerNode, valueNode );
 
 /**
  * Stores in an atomic variable the minimum between its current value and a parameter.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicMin = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_MIN, pointerNode, valueNode, storeNode );
+export const atomicMin = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_MIN, pointerNode, valueNode );
 
 /**
  * Stores in an atomic variable the bitwise AND of its value with a parameter.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicAnd = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_AND, pointerNode, valueNode, storeNode );
+export const atomicAnd = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_AND, pointerNode, valueNode );
 
 /**
  * Stores in an atomic variable the bitwise OR of its value with a parameter.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicOr = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_OR, pointerNode, valueNode, storeNode );
+export const atomicOr = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_OR, pointerNode, valueNode );
 
 /**
  * Stores in an atomic variable the bitwise XOR of its value with a parameter.
  *
+ * @tsl
  * @function
  * @param {Node} pointerNode - An atomic variable or element of an atomic buffer.
  * @param {Node} valueNode - The value that mutates the atomic variable.
- * @param {Node?} [storeNode=null] - A variable storing the return value of an atomic operation, typically the value of the atomic variable before the operation.
  * @returns {AtomicFunctionNode}
  */
-export const atomicXor = ( pointerNode, valueNode, storeNode = null ) => atomicFunc( AtomicFunctionNode.ATOMIC_XOR, pointerNode, valueNode, storeNode );
+export const atomicXor = ( pointerNode, valueNode ) => atomicFunc( AtomicFunctionNode.ATOMIC_XOR, pointerNode, valueNode );

package/src/nodes/gpgpu/BarrierNode.js

@@ -1,8 +1,6 @@
 import Node from '../core/Node.js';
 import { nodeProxy } from '../tsl/TSLCore.js';
 
-/** @module BarrierNode **/
-
 /**
  * Represents a GPU control barrier that synchronizes compute operations within a given scope.
  *
@@ -15,7 +13,7 @@ class BarrierNode extends Node {
 	/**
 	 * Constructs a new barrier node.
 	 *
-	 * @param {String} scope - The scope defines the behavior of the node.
+	 * @param {string} scope - The scope defines the behavior of the node.
 	 */
 	constructor( scope ) {
 
@@ -49,8 +47,9 @@ export default BarrierNode;
 /**
  * TSL function for creating a barrier node.
  *
+ * @tsl
  * @function
- * @param {String} scope - The scope defines the behavior of the node..
+ * @param {string} scope - The scope defines the behavior of the node..
  * @returns {BarrierNode}
  */
 const barrier = nodeProxy( BarrierNode );
@@ -60,6 +59,7 @@ const barrier = nodeProxy( BarrierNode );
  * invocations must wait for each invocation within a workgroup to
  * complete before the barrier can be surpassed.
  *
+ * @tsl
  * @function
  * @returns {BarrierNode}
  */
@@ -70,6 +70,7 @@ export const workgroupBarrier = () => barrier( 'workgroup' ).append();
  * wait for each access to variables within the 'storage' address space
  * to complete before the barrier can be passed.
  *
+ * @tsl
  * @function
  * @returns {BarrierNode}
  */
@@ -80,6 +81,7 @@ export const storageBarrier = () => barrier( 'storage' ).append();
  * wait for each access to variables within the 'texture' address space
  * to complete before the barrier can be passed.
  *
+ * @tsl
  * @function
  * @returns {BarrierNode}
  */

package/src/nodes/gpgpu/ComputeBuiltinNode.js

@@ -1,8 +1,6 @@
 import Node from '../core/Node.js';
 import { nodeObject } from '../tsl/TSLBase.js';
 
-/** @module ComputeBuiltinNode **/
-
 /**
  * `ComputeBuiltinNode` represents a compute-scope builtin value that expose information
  * about the currently running dispatch and/or the device it is running on.
@@ -22,8 +20,8 @@ class ComputeBuiltinNode extends Node {
 	/**
 	 * Constructs a new compute builtin node.
 	 *
-	 * @param {String} builtinName - The built-in name.
-	 * @param {String} nodeType - The node type.
+	 * @param {string} builtinName - The built-in name.
+	 * @param {string} nodeType - The node type.
 	 */
 	constructor( builtinName, nodeType ) {
 
@@ -33,7 +31,7 @@ class ComputeBuiltinNode extends Node {
 		 * The built-in name.
 		 *
 		 * @private
-		 * @type {String}
+		 * @type {string}
 		 */
 		this._builtinName = builtinName;
 
@@ -43,7 +41,7 @@ class ComputeBuiltinNode extends Node {
 	 * This method is overwritten since hash is derived from the built-in name.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The hash.
+	 * @return {string} The hash.
 	 */
 	getHash( builder ) {
 
@@ -55,7 +53,7 @@ class ComputeBuiltinNode extends Node {
 	 * This method is overwritten since the node type is simply derived from `nodeType`..
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( /*builder*/ ) {
 
@@ -66,7 +64,7 @@ class ComputeBuiltinNode extends Node {
 	/**
 	 * Sets the builtin name.
 	 *
-	 * @param {String} builtinName - The built-in name.
+	 * @param {string} builtinName - The built-in name.
 	 * @return {ComputeBuiltinNode} A reference to this node.
 	 */
 	setBuiltinName( builtinName ) {
@@ -81,7 +79,7 @@ class ComputeBuiltinNode extends Node {
 	 * Returns the builtin name.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The builtin name.
+	 * @return {string} The builtin name.
 	 */
 	getBuiltinName( /*builder*/ ) {
 
@@ -93,10 +91,11 @@ class ComputeBuiltinNode extends Node {
 	 * Whether the current node builder has the builtin or not.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
+	 * @return {boolean} Whether the builder has the builtin or not.
 	 */
 	hasBuiltin( builder ) {
 
-		builder.hasBuiltin( this._builtinName );
+		return builder.hasBuiltin( this._builtinName );
 
 	}
 
@@ -143,15 +142,15 @@ export default ComputeBuiltinNode;
 /**
  * TSL function for creating a compute builtin node.
  *
+ * @tsl
  * @function
- * @param {String} name - The built-in name.
- * @param {String} nodeType - The node type.
+ * @param {string} name - The built-in name.
+ * @param {string} nodeType - The node type.
  * @returns {ComputeBuiltinNode}
  */
 const computeBuiltin = ( name, nodeType ) => nodeObject( new ComputeBuiltinNode( name, nodeType ) );
 
 /**
- * TSL function for creating a `numWorkgroups` builtin node.
  * Represents the number of workgroups dispatched by the compute shader.
  * ```js
  * // Run 512 invocations/threads with a workgroup size of 128.
@@ -171,19 +170,18 @@ const computeBuiltin = ( name, nodeType ) => nodeObject( new ComputeBuiltinNode(
  * })().compute(512);
  * ```
  *
- * @function
- * @returns {ComputeBuiltinNode<uvec3>}
+ * @tsl
+ * @type {ComputeBuiltinNode<uvec3>}
  */
 export const numWorkgroups = /*@__PURE__*/ computeBuiltin( 'numWorkgroups', 'uvec3' );
 
 /**
- * TSL function for creating a `workgroupId` builtin node.
  * Represents the 3-dimensional index of the workgroup the current compute invocation belongs to.
  * ```js
  * // Execute 12 compute threads with a workgroup size of 3.
  * const computeFn = Fn( () => {
  *
- * 	If( workgroupId.x.modInt( 2 ).equal( 0 ), () => {
+ * 	If( workgroupId.x.mod( 2 ).equal( 0 ), () => {
  *
  * 		storageBuffer.element( instanceIndex ).assign( instanceIndex );
  *
@@ -199,34 +197,31 @@ export const numWorkgroups = /*@__PURE__*/ computeBuiltin( 'numWorkgroups', 'uve
  * // Buffer Output =  [0, 1, 2, 0, 0, 0, 6, 7, 8, 0, 0, 0];
  * ```
  *
- * @function
- * @returns {ComputeBuiltinNode<uvec3>}
+ * @tsl
+ * @type {ComputeBuiltinNode<uvec3>}
  */
 export const workgroupId = /*@__PURE__*/ computeBuiltin( 'workgroupId', 'uvec3' );
 
 /**
- * TSL function for creating a `globalId` builtin node. A non-linearized 3-dimensional
- * representation of the current invocation's position within a 3D global grid.
+ * A non-linearized 3-dimensional representation of the current invocation's position within a 3D global grid.
  *
- * @function
- * @returns {ComputeBuiltinNode<uvec3>}
+ * @tsl
+ * @type {ComputeBuiltinNode<uvec3>}
  */
 export const globalId = /*@__PURE__*/ computeBuiltin( 'globalId', 'uvec3' );
 /**
- * TSL function for creating a `localId` builtin node. A non-linearized 3-dimensional
- * representation of the current invocation's position within a 3D workgroup grid.
+ * A non-linearized 3-dimensional representation of the current invocation's position within a 3D workgroup grid.
  *
- * @function
- * @returns {ComputeBuiltinNode<uvec3>}
+ * @tsl
+ * @type {ComputeBuiltinNode<uvec3>}
  */
 export const localId = /*@__PURE__*/ computeBuiltin( 'localId', 'uvec3' );
 
 /**
- * TSL function for creating a `subgroupSize` builtin node. A device dependent variable
- * that exposes the size of the current invocation's subgroup.
+ * A device dependent variable that exposes the size of the current invocation's subgroup.
  *
- * @function
- * @returns {ComputeBuiltinNode<uint>}
+ * @tsl
+ * @type {ComputeBuiltinNode<uint>}
  */
 export const subgroupSize = /*@__PURE__*/ computeBuiltin( 'subgroupSize', 'uint' );
 

package/src/nodes/gpgpu/ComputeNode.js

@@ -2,8 +2,6 @@ import Node from '../core/Node.js';
 import { NodeUpdateType } from '../core/constants.js';
 import { addMethodChaining, nodeObject } from '../tsl/TSLCore.js';
 
-/** @module ComputeNode **/
-
 /**
  * TODO
  *
@@ -21,8 +19,8 @@ class ComputeNode extends Node {
 	 * Constructs a new compute node.
 	 *
 	 * @param {Node} computeNode - TODO
-	 * @param {Number} count - TODO.
-	 * @param {Array<Number>} [workgroupSize=[64]] - TODO.
+	 * @param {number} count - TODO.
+	 * @param {Array<number>} [workgroupSize=[64]] - TODO.
 	 */
 	constructor( computeNode, count, workgroupSize = [ 64 ] ) {
 
@@ -31,7 +29,7 @@ class ComputeNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -47,14 +45,14 @@ class ComputeNode extends Node {
 		/**
 		 * TODO
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.count = count;
 
 		/**
 		 * TODO
 		 *
-		 * @type {Array<Number>}
+		 * @type {Array<number>}
 		 * @default [64]
 		 */
 		this.workgroupSize = workgroupSize;
@@ -62,21 +60,21 @@ class ComputeNode extends Node {
 		/**
 		 * TODO
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.dispatchCount = 0;
 
 		/**
 		 * TODO
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.version = 1;
 
 		/**
 		 * The name or label of the uniform.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default ''
 		 */
 		this.name = '';
@@ -85,7 +83,7 @@ class ComputeNode extends Node {
 		 * The `updateBeforeType` is set to `NodeUpdateType.OBJECT` since {@link ComputeNode#updateBefore}
 		 * is executed once per object by default.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'object'
 		 */
 		this.updateBeforeType = NodeUpdateType.OBJECT;
@@ -93,7 +91,7 @@ class ComputeNode extends Node {
 		/**
 		 * TODO
 		 *
-		 * @type {Function}
+		 * @type {?Function}
 		 */
 		this.onInitFunction = null;
 
@@ -113,7 +111,7 @@ class ComputeNode extends Node {
 	/**
 	 * Sets the {@link ComputeNode#name} property.
 	 *
-	 * @param {String} name - The name of the uniform.
+	 * @param {string} name - The name of the uniform.
 	 * @return {ComputeNode} A reference to this node.
 	 */
 	label( name ) {
@@ -165,7 +163,24 @@ class ComputeNode extends Node {
 
 	}
 
-	generate( builder ) {
+	setup( builder ) {
+
+		const result = this.computeNode.setup( builder );
+
+		if ( result ) {
+
+			const properties = builder.getNodeProperties( this );
+			properties.outputComputeNode = result.outputNode;
+
+			result.outputNode = null;
+
+		}
+
+		return result;
+
+	}
+
+	generate( builder, output ) {
 
 		const { shaderStage } = builder;
 
@@ -179,6 +194,17 @@ class ComputeNode extends Node {
 
 			}
 
+		} else {
+
+			const properties = builder.getNodeProperties( this );
+			const outputComputeNode = properties.outputComputeNode;
+
+			if ( outputComputeNode ) {
+
+				return outputComputeNode.build( builder, output );
+
+			}
+
 		}
 
 	}
@@ -190,10 +216,11 @@ export default ComputeNode;
 /**
  * TSL function for creating a compute node.
  *
+ * @tsl
  * @function
  * @param {Node} node - TODO
- * @param {Number} count - TODO.
- * @param {Array<Number>} [workgroupSize=[64]] - TODO.
+ * @param {number} count - TODO.
+ * @param {Array<number>} [workgroupSize=[64]] - TODO.
  * @returns {AtomicFunctionNode}
  */
 export const compute = ( node, count, workgroupSize ) => nodeObject( new ComputeNode( nodeObject( node ), count, workgroupSize ) );