super-three 0.173.4 → 0.175.0

package/src/nodes/core/AssignNode.js

@@ -2,8 +2,6 @@ import TempNode from '../core/TempNode.js';
 import { addMethodChaining, nodeProxy } from '../tsl/TSLCore.js';
 import { vectorComponents } from '../core/constants.js';
 
-/** @module AssignNode **/
-
 /**
  * These node represents an assign operation. Meaning a node is assigned
  * to another node.
@@ -48,7 +46,7 @@ class AssignNode extends TempNode {
 	 * Whether this node is used more than once in context of other nodes. This method
 	 * is overwritten since it always returns `false` (assigns are unique).
 	 *
-	 * @return {Boolean} A flag that indicates if there is more than one dependency to other nodes. Always `false`.
+	 * @return {boolean} A flag that indicates if there is more than one dependency to other nodes. Always `false`.
 	 */
 	hasDependencies() {
 
@@ -67,7 +65,7 @@ class AssignNode extends TempNode {
 	 * target and source data type does not match.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {Boolean} Whether a split is required when assigning source to target.
+	 * @return {boolean} Whether a split is required when assigning source to target.
 	 */
 	needsSplitAssign( builder ) {
 
@@ -167,11 +165,12 @@ export default AssignNode;
 /**
  * TSL function for creating an assign node.
  *
+ * @tsl
  * @function
  * @param {Node} targetNode - The target node.
  * @param {Node} sourceNode - The source type.
  * @returns {AssignNode}
  */
-export const assign = /*@__PURE__*/ nodeProxy( AssignNode );
+export const assign = /*@__PURE__*/ nodeProxy( AssignNode ).setParameterLength( 2 );
 
 addMethodChaining( 'assign', assign );

package/src/nodes/core/AttributeNode.js

@@ -1,8 +1,6 @@
 import Node from './Node.js';
 import { nodeObject, varying } from '../tsl/TSLBase.js';
 
-/** @module AttributeNode **/
-
 /**
  * Base class for representing shader attributes as nodes.
  *
@@ -19,8 +17,8 @@ class AttributeNode extends Node {
 	/**
 	 * Constructs a new attribute node.
 	 *
-	 * @param {String} attributeName - The name of the attribute.
-	 * @param {String?} nodeType - The node type.
+	 * @param {string} attributeName - The name of the attribute.
+	 * @param {?string} nodeType - The node type.
 	 */
 	constructor( attributeName, nodeType = null ) {
 
@@ -29,7 +27,7 @@ class AttributeNode extends Node {
 		/**
 		 * `AttributeNode` sets this property to `true` by default.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.global = true;
@@ -75,7 +73,7 @@ class AttributeNode extends Node {
 	 * overwritten in derived classes if the final name must be computed
 	 * analytically.
 	 *
-	 * @param {String} attributeName - The name of the attribute.
+	 * @param {string} attributeName - The name of the attribute.
 	 * @return {AttributeNode} A reference to this node.
 	 */
 	setAttributeName( attributeName ) {
@@ -92,7 +90,7 @@ class AttributeNode extends Node {
 	 * analytically.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The attribute name.
+	 * @return {string} The attribute name.
 	 */
 	getAttributeName( /*builder*/ ) {
 
@@ -160,9 +158,10 @@ export default AttributeNode;
 /**
  * TSL function for creating an attribute node.
  *
+ * @tsl
  * @function
- * @param {String} name - The name of the attribute.
- * @param {String?} nodeType - The node type.
+ * @param {string} name - The name of the attribute.
+ * @param {string} [nodeType] - The node type.
  * @returns {AttributeNode}
  */
 export const attribute = ( name, nodeType ) => nodeObject( new AttributeNode( name, nodeType ) );

package/src/nodes/core/BypassNode.js

@@ -1,8 +1,6 @@
 import Node from './Node.js';
 import { addMethodChaining, nodeProxy } from '../tsl/TSLCore.js';
 
-/** @module BypassNode **/
-
 /**
  * The class generates the code of a given node but returns another node in the output.
  * This can be used to call a method or node that does not return a value, i.e.
@@ -35,7 +33,7 @@ class BypassNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -84,11 +82,12 @@ export default BypassNode;
 /**
  * TSL function for creating a bypass node.
  *
+ * @tsl
  * @function
  * @param {Node} outputNode - The output node.
  * @param {Node} callNode - The call node.
  * @returns {BypassNode}
  */
-export const bypass = /*@__PURE__*/ nodeProxy( BypassNode );
+export const bypass = /*@__PURE__*/ nodeProxy( BypassNode ).setParameterLength( 2 );
 
 addMethodChaining( 'bypass', bypass );

package/src/nodes/core/CacheNode.js

@@ -1,8 +1,6 @@
 import Node from './Node.js';
 import { addMethodChaining, nodeObject } from '../tsl/TSLCore.js';
 
-/** @module CacheNode **/
-
 /**
  * This node can be used as a cache management component for another node.
  * Caching is in general used by default in {@link NodeBuilder} but this node
@@ -22,7 +20,7 @@ class CacheNode extends Node {
 	 * Constructs a new cache node.
 	 *
 	 * @param {Node} node - The node that should be cached.
-	 * @param {Boolean} [parent=true] - Whether this node refers to a shared parent cache or not.
+	 * @param {boolean} [parent=true] - Whether this node refers to a shared parent cache or not.
 	 */
 	constructor( node, parent = true ) {
 
@@ -38,7 +36,7 @@ class CacheNode extends Node {
 		/**
 		 * Whether this node refers to a shared parent cache or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.parent = parent;
@@ -46,7 +44,7 @@ class CacheNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -91,9 +89,10 @@ export default CacheNode;
 /**
  * TSL function for creating a cache node.
  *
+ * @tsl
  * @function
  * @param {Node} node - The node that should be cached.
- * @param {Boolean} parent - Whether this node refers to a shared parent cache or not.
+ * @param {boolean} [parent] - Whether this node refers to a shared parent cache or not.
  * @returns {CacheNode}
  */
 export const cache = ( node, parent ) => nodeObject( new CacheNode( nodeObject( node ), parent ) );

package/src/nodes/core/ConstNode.js

@@ -18,8 +18,8 @@ class ConstNode extends InputNode {
 	/**
 	 * Constructs a new input node.
 	 *
-	 * @param {Any} value - The value of this node. Usually a JS primitive or three.js object (vector, matrix, color).
-	 * @param {String?} nodeType - The node type. If no explicit type is defined, the node tries to derive the type from its value.
+	 * @param {any} value - The value of this node. Usually a JS primitive or three.js object (vector, matrix, color).
+	 * @param {?string} nodeType - The node type. If no explicit type is defined, the node tries to derive the type from its value.
 	 */
 	constructor( value, nodeType = null ) {
 
@@ -28,7 +28,7 @@ class ConstNode extends InputNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -40,7 +40,7 @@ class ConstNode extends InputNode {
 	 * Generates the shader string of the value with the current node builder.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The generated value as a shader string.
+	 * @return {string} The generated value as a shader string.
 	 */
 	generateConst( builder ) {
 

package/src/nodes/core/ContextNode.js

@@ -1,8 +1,6 @@
 import Node from './Node.js';
 import { addMethodChaining, nodeProxy } from '../tsl/TSLCore.js';
 
-/** @module ContextNode **/
-
 /**
  * This node can be used as a context management component for another node.
  * {@link NodeBuilder} performs its node building process in a specific context and
@@ -34,7 +32,7 @@ class ContextNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -58,9 +56,9 @@ class ContextNode extends Node {
 	}
 
 	/**
-	 * This method is overwritten to ensure it returns the reference to {@link module:ContextNode~ContextNode#node}.
+	 * This method is overwritten to ensure it returns the reference to {@link ContextNode#node}.
 	 *
-	 * @return {Node} A reference to {@link module:ContextNode~ContextNode#node}.
+	 * @return {Node} A reference to {@link ContextNode#node}.
 	 */
 	getScope() {
 
@@ -69,10 +67,10 @@ class ContextNode extends Node {
 	}
 
 	/**
-	 * This method is overwritten to ensure it returns the type of {@link module:ContextNode~ContextNode#node}.
+	 * This method is overwritten to ensure it returns the type of {@link ContextNode#node}.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( builder ) {
 
@@ -121,19 +119,21 @@ export default ContextNode;
 /**
  * TSL function for creating a context node.
  *
+ * @tsl
  * @function
  * @param {Node} node - The node whose context should be modified.
  * @param {Object} [value={}] - The modified context data.
  * @returns {ContextNode}
  */
-export const context = /*@__PURE__*/ nodeProxy( ContextNode );
+export const context = /*@__PURE__*/ nodeProxy( ContextNode ).setParameterLength( 1, 2 );
 
 /**
  * TSL function for defining a label context value for a given node.
  *
+ * @tsl
  * @function
  * @param {Node} node - The node whose context should be modified.
- * @param {String} name - The name/label to set.
+ * @param {string} name - The name/label to set.
  * @returns {ContextNode}
  */
 export const label = ( node, name ) => context( node, { label: name } );

package/src/nodes/core/IndexNode.js

@@ -1,8 +1,6 @@
 import Node from './Node.js';
 import { nodeImmutable, varying } from '../tsl/TSLBase.js';
 
-/** @module IndexNode **/
-
 /**
  * This class represents shader indices of different types. The following predefined node
  * objects cover frequent use cases:
@@ -36,14 +34,14 @@ class IndexNode extends Node {
 		/**
 		 * The scope of the index node.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.scope = scope;
 
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -120,6 +118,7 @@ export default IndexNode;
 /**
  * TSL object that represents the index of a vertex within a mesh.
  *
+ * @tsl
  * @type {IndexNode}
  */
 export const vertexIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.VERTEX );
@@ -127,6 +126,7 @@ export const vertexIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.VER
 /**
  * TSL object that represents the index of either a mesh instance or an invocation of a compute shader.
  *
+ * @tsl
  * @type {IndexNode}
  */
 export const instanceIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.INSTANCE );
@@ -134,6 +134,7 @@ export const instanceIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.I
 /**
  * TSL object that represents the index of the subgroup the current compute invocation belongs to.
  *
+ * @tsl
  * @type {IndexNode}
  */
 export const subgroupIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.SUBGROUP );
@@ -141,6 +142,7 @@ export const subgroupIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.S
 /**
  * TSL object that represents the index of a compute invocation within the scope of a subgroup.
  *
+ * @tsl
  * @type {IndexNode}
  */
 export const invocationSubgroupIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.INVOCATION_SUBGROUP );
@@ -148,6 +150,7 @@ export const invocationSubgroupIndex = /*@__PURE__*/ nodeImmutable( IndexNode, I
 /**
  * TSL object that represents the index of a compute invocation within the scope of a workgroup load.
  *
+ * @tsl
  * @type {IndexNode}
  */
 export const invocationLocalIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.INVOCATION_LOCAL );
@@ -155,6 +158,7 @@ export const invocationLocalIndex = /*@__PURE__*/ nodeImmutable( IndexNode, Inde
 /**
  * TSL object that represents the index of a draw call.
  *
+ * @tsl
  * @type {IndexNode}
  */
 export const drawIndex = /*@__PURE__*/ nodeImmutable( IndexNode, IndexNode.DRAW );

package/src/nodes/core/InputNode.js

@@ -17,8 +17,8 @@ class InputNode extends Node {
 	/**
 	 * Constructs a new input node.
 	 *
-	 * @param {Any} value - The value of this node. This can be a any JS primitive, functions, array buffers or even three.js objects (vector, matrices, colors).
-	 * @param {String?} nodeType - The node type. If no explicit type is defined, the node tries to derive the type from its value.
+	 * @param {any} value - The value of this node. This can be any JS primitive, functions, array buffers or even three.js objects (vector, matrices, colors).
+	 * @param {?string} nodeType - The node type. If no explicit type is defined, the node tries to derive the type from its value.
 	 */
 	constructor( value, nodeType = null ) {
 
@@ -27,23 +27,23 @@ class InputNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
 		this.isInputNode = true;
 
 		/**
-		 * The value of this node. This can be a any JS primitive, functions, array buffers or even three.js objects (vector, matrices, colors).
+		 * The value of this node. This can be any JS primitive, functions, array buffers or even three.js objects (vector, matrices, colors).
 		 *
-		 * @type {Any}
+		 * @type {any}
 		 */
 		this.value = value;
 
 		/**
 		 * The precision of the value in the shader.
 		 *
-		 * @type {('low'|'medium'|'high')?}
+		 * @type {?('low'|'medium'|'high')}
 		 * @default null
 		 */
 		this.precision = null;
@@ -70,7 +70,7 @@ class InputNode extends Node {
 	 * normal RGBA texture is `texture` whereas its node type is `vec4`.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The input type.
+	 * @return {string} The input type.
 	 */
 	getInputType( builder ) {
 

package/src/nodes/core/LightingModel.js

@@ -11,54 +11,56 @@ class LightingModel {
 	 * which are later used in the evaluation process.
 	 *
 	 * @abstract
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	start( /*input, stack, builder*/ ) { }
+	start( builder ) {
+
+		// lights ( direct )
+
+		builder.lightsNode.setupLights( builder, builder.lightsNode.getLightNodes( builder ) );
+
+		// indirect
+
+		this.indirect( builder );
+
+	}
 
 	/**
 	 * This method is intended for executing final tasks like final updates
 	 * to the outgoing light.
 	 *
 	 * @abstract
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	finish( /*input, stack, builder*/ ) { }
+	finish( /*builder*/ ) { }
 
 	/**
 	 * This method is intended for implementing the direct light term and
 	 * executed during the build process of directional, point and spot light nodes.
 	 *
 	 * @abstract
-	 * @param {Object} input - The input data.
-	 * @param {StackNode} stack - The current stack.
+	 * @param {Object} lightData - The light data.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	direct( /*input, stack, builder*/ ) { }
+	direct( /*lightData, builder*/ ) { }
 
 	/**
 	 * This method is intended for implementing the direct light term for
 	 * rect area light nodes.
 	 *
 	 * @abstract
-	 * @param {Object} input - The input data.
-	 * @param {StackNode} stack - The current stack.
+	 * @param {Object} lightData - The light data.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	directRectArea( /*input, stack, builder*/ ) {}
+	directRectArea( /*lightData, builder*/ ) {}
 
 	/**
 	 * This method is intended for implementing the indirect light term.
 	 *
 	 * @abstract
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	indirect( /*input, stack, builder*/ ) { }
+	indirect( /*builder*/ ) { }
 
 	/**
 	 * This method is intended for implementing the ambient occlusion term.
@@ -66,8 +68,6 @@ class LightingModel {
 	 * model in its indirect term.
 	 *
 	 * @abstract
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
 	ambientOcclusion( /*input, stack, builder*/ ) { }

package/src/nodes/core/MRTNode.js

@@ -1,14 +1,12 @@
 import OutputStructNode from './OutputStructNode.js';
 import { nodeProxy, vec4 } from '../tsl/TSLBase.js';
 
-/** @module MRTNode **/
-
 /**
  * Returns the MRT texture index for the given name.
  *
  * @param {Array<Texture>} textures - The textures of a MRT-configured render target.
- * @param {String} name - The name of the MRT texture which index is requested.
- * @return {Number} The texture index.
+ * @param {string} name - The name of the MRT texture which index is requested.
+ * @return {number} The texture index.
  */
 export function getTextureIndex( textures, name ) {
 
@@ -50,7 +48,7 @@ class MRTNode extends OutputStructNode {
 	/**
 	 * Constructs a new output struct node.
 	 *
-	 * @param {Object<String, Node>} outputNodes - The MRT outputs.
+	 * @param {Object<string, Node>} outputNodes - The MRT outputs.
 	 */
 	constructor( outputNodes ) {
 
@@ -61,14 +59,14 @@ class MRTNode extends OutputStructNode {
 		 * is the name of the output, the value the node which produces
 		 * the output result.
 		 *
-		 * @type {Object<String, Node>}
+		 * @type {Object<string, Node>}
 		 */
 		this.outputNodes = outputNodes;
 
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -79,7 +77,7 @@ class MRTNode extends OutputStructNode {
 	/**
 	 * Returns `true` if the MRT node has an output with the given name.
 	 *
-	 * @param {String} name - The name of the output.
+	 * @param {string} name - The name of the output.
 	 * @return {NodeBuilder} Whether the MRT node has an output for the given name or not.
 	 */
 	has( name ) {
@@ -91,7 +89,7 @@ class MRTNode extends OutputStructNode {
 	/**
 	 * Returns the output node for the given name.
 	 *
-	 * @param {String} name - The name of the output.
+	 * @param {string} name - The name of the output.
 	 * @return {Node} The output node.
 	 */
 	get( name ) {
@@ -144,8 +142,9 @@ export default MRTNode;
 /**
  * TSL function for creating a MRT node.
  *
+ * @tsl
  * @function
- * @param {Object<String, Node>} outputNodes - The MRT outputs.
+ * @param {Object<string, Node>} outputNodes - The MRT outputs.
  * @returns {MRTNode}
  */
 export const mrt = /*@__PURE__*/ nodeProxy( MRTNode );