super-three 0.173.5 → 0.175.0

package/src/nodes/core/NodeCache.js

@@ -9,14 +9,14 @@ class NodeCache {
 	/**
 	 * Constructs a new node cache.
 	 *
-	 * @param {NodeCache?} parent - A reference to a parent cache.
+	 * @param {?NodeCache} parent - A reference to a parent cache.
 	 */
 	constructor( parent = null ) {
 
 		/**
 		 * The id of the cache.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @readonly
 		 */
 		this.id = _id ++;
@@ -31,7 +31,7 @@ class NodeCache {
 		/**
 		 * Reference to a parent node cache.
 		 *
-		 * @type {NodeCache?}
+		 * @type {?NodeCache}
 		 * @default null
 		 */
 		this.parent = parent;
@@ -42,7 +42,7 @@ class NodeCache {
 	 * Returns the data for the given node.
 	 *
 	 * @param {Node} node - The node.
-	 * @return {Object?} The data for the node.
+	 * @return {?Object} The data for the node.
 	 */
 	getData( node ) {
 

package/src/nodes/core/NodeCode.js

@@ -9,30 +9,30 @@ class NodeCode {
 	/**
 	 * Constructs a new code node.
 	 *
-	 * @param {String} name - The name of the code.
-	 * @param {String} type - The node type.
-	 * @param {String} [code=''] - The native shader code.
+	 * @param {string} name - The name of the code.
+	 * @param {string} type - The node type.
+	 * @param {string} [code=''] - The native shader code.
 	 */
 	constructor( name, type, code = '' ) {
 
 		/**
 		 * The name of the code.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.name = name;
 
 		/**
 		 * The node type.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.type = type;
 
 		/**
 		 * The native shader code.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default ''
 		 */
 		this.code = code;

package/src/nodes/core/NodeFrame.js

@@ -16,7 +16,7 @@ class NodeFrame {
 		/**
 		 * The elapsed time in seconds.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @default 0
 		 */
 		this.time = 0;
@@ -24,7 +24,7 @@ class NodeFrame {
 		/**
 		 * The delta time in seconds.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @default 0
 		 */
 		this.deltaTime = 0;
@@ -32,7 +32,7 @@ class NodeFrame {
 		/**
 		 * The frame ID.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @default 0
 		 */
 		this.frameId = 0;
@@ -40,7 +40,7 @@ class NodeFrame {
 		/**
 		 * The render ID.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @default 0
 		 */
 		this.renderId = 0;
@@ -69,7 +69,7 @@ class NodeFrame {
 		/**
 		 * A reference to the current renderer.
 		 *
-		 * @type {Renderer?}
+		 * @type {?Renderer}
 		 * @default null
 		 */
 		this.renderer = null;
@@ -77,7 +77,7 @@ class NodeFrame {
 		/**
 		 * A reference to the current material.
 		 *
-		 * @type {Material?}
+		 * @type {?Material}
 		 * @default null
 		 */
 		this.material = null;
@@ -85,7 +85,7 @@ class NodeFrame {
 		/**
 		 * A reference to the current camera.
 		 *
-		 * @type {Camera?}
+		 * @type {?Camera}
 		 * @default null
 		 */
 		this.camera = null;
@@ -93,7 +93,7 @@ class NodeFrame {
 		/**
 		 * A reference to the current 3D object.
 		 *
-		 * @type {Object3D?}
+		 * @type {?Object3D}
 		 * @default null
 		 */
 		this.object = null;
@@ -101,7 +101,7 @@ class NodeFrame {
 		/**
 		 * A reference to the current scene.
 		 *
-		 * @type {Scene?}
+		 * @type {?Scene}
 		 * @default null
 		 */
 		this.scene = null;
@@ -115,7 +115,7 @@ class NodeFrame {
 	 * @private
 	 * @param {WeakMap<Node, Object>} referenceMap - The reference weak map.
 	 * @param {Node} nodeRef - The reference to the current node.
-	 * @return {Object<String,WeakMap>} The dictionary.
+	 * @return {Object<string,WeakMap>} The dictionary.
 	 */
 	_getMaps( referenceMap, nodeRef ) {
 

package/src/nodes/core/NodeFunction.js

@@ -9,17 +9,17 @@ class NodeFunction {
 	/**
 	 * Constructs a new node function.
 	 *
-	 * @param {String} type - The node type. This type is the return type of the node function.
+	 * @param {string} type - The node type. This type is the return type of the node function.
 	 * @param {Array<NodeFunctionInput>} inputs - The function's inputs.
-	 * @param {String} [name=''] - The function's name.
-	 * @param {String} [precision=''] - The precision qualifier.
+	 * @param {string} [name=''] - The function's name.
+	 * @param {string} [precision=''] - The precision qualifier.
 	 */
 	constructor( type, inputs, name = '', precision = '' ) {
 
 		/**
 		 * The node type. This type is the return type of the node function.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.type = type;
 
@@ -33,7 +33,7 @@ class NodeFunction {
 		/**
 		 * The name of the uniform.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default ''
 		 */
 		this.name = name;
@@ -41,7 +41,7 @@ class NodeFunction {
 		/**
 		 * The precision qualifier.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default ''
 		 */
 		this.precision = precision;
@@ -52,8 +52,8 @@ class NodeFunction {
 	 * This method returns the native code of the node function.
 	 *
 	 * @abstract
-	 * @param {String} name - The function's name.
-	 * @return {String} A shader code.
+	 * @param {string} name - The function's name.
+	 * @return {string} A shader code.
 	 */
 	getCode( /*name = this.name*/ ) {
 

package/src/nodes/core/NodeFunctionInput.js

@@ -6,32 +6,32 @@ class NodeFunctionInput {
 	/**
 	 * Constructs a new node function input.
 	 *
-	 * @param {String} type - The input type.
-	 * @param {String} name - The input name.
-	 * @param {Number?} [count=null] - If the input is an Array, count will be the length.
+	 * @param {string} type - The input type.
+	 * @param {string} name - The input name.
+	 * @param {?number} [count=null] - If the input is an Array, count will be the length.
 	 * @param {('in'|'out'|'inout')} [qualifier=''] - The parameter qualifier (only relevant for GLSL).
-	 * @param {Boolean} [isConst=false] - Whether the input uses a const qualifier or not (only relevant for GLSL).
+	 * @param {boolean} [isConst=false] - Whether the input uses a const qualifier or not (only relevant for GLSL).
 	 */
 	constructor( type, name, count = null, qualifier = '', isConst = false ) {
 
 		/**
 		 *  The input type.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.type = type;
 
 		/**
 		 * The input name.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.name = name;
 
 		/**
 		 * If the input is an Array, count will be the length.
 		 *
-		 * @type {Number?}
+		 * @type {?number}
 		 * @default null
 		 */
 		this.count = count;
@@ -47,7 +47,7 @@ class NodeFunctionInput {
 		/**
 		 * Whether the input uses a const qualifier or not (only relevant for GLSL).
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.isConst = isConst;

package/src/nodes/core/NodeParser.js

@@ -8,7 +8,7 @@ class NodeParser {
 	 * The method parses the given native code an returns a node function.
 	 *
 	 * @abstract
-	 * @param {String} source - The native shader code.
+	 * @param {string} source - The native shader code.
 	 * @return {NodeFunction} A node function.
 	 */
 	parseFunction( /*source*/ ) {

package/src/nodes/core/NodeUniform.js

@@ -9,8 +9,8 @@ class NodeUniform {
 	/**
 	 * Constructs a new node uniform.
 	 *
-	 * @param {String} name - The name of the uniform.
-	 * @param {String} type - The type of the uniform.
+	 * @param {string} name - The name of the uniform.
+	 * @param {string} type - The type of the uniform.
 	 * @param {UniformNode} node - An reference to the node.
 	 */
 	constructor( name, type, node ) {
@@ -18,7 +18,7 @@ class NodeUniform {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -27,14 +27,14 @@ class NodeUniform {
 		/**
 		 * The name of the uniform.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.name = name;
 
 		/**
 		 * The type of the uniform.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.type = type;
 
@@ -50,7 +50,7 @@ class NodeUniform {
 	/**
 	 * The value of the uniform node.
 	 *
-	 * @type {Any}
+	 * @type {any}
 	 */
 	get value() {
 
@@ -67,7 +67,7 @@ class NodeUniform {
 	/**
 	 * The id of the uniform node.
 	 *
-	 * @type {Number}
+	 * @type {number}
 	 */
 	get id() {
 

package/src/nodes/core/NodeUtils.js

@@ -6,8 +6,6 @@ import { Vector2 } from '../../math/Vector2.js';
 import { Vector3 } from '../../math/Vector3.js';
 import { Vector4 } from '../../math/Vector4.js';
 
-/** @module NodeUtils **/
-
 // cyrb53 (c) 2018 bryc (github.com/bryc). License: Public domain. Attribution appreciated.
 // A fast and simple 64-bit (or 53-bit) string hash function with decent collision resistance.
 // Largely inspired by MurmurHash2/3, but with a focus on speed/simplicity.
@@ -52,8 +50,8 @@ function cyrb53( value, seed = 0 ) {
  * Computes a hash for the given string.
  *
  * @method
- * @param {String} str - The string to be hashed.
- * @return {Number} The hash.
+ * @param {string} str - The string to be hashed.
+ * @return {number} The hash.
  */
 export const hashString = ( str ) => cyrb53( str );
 
@@ -61,8 +59,8 @@ export const hashString = ( str ) => cyrb53( str );
  * Computes a hash for the given array.
  *
  * @method
- * @param {Array<Number>} array - The array to be hashed.
- * @return {Number} The hash.
+ * @param {Array<number>} array - The array to be hashed.
+ * @return {number} The hash.
  */
 export const hashArray = ( array ) => cyrb53( array );
 
@@ -70,8 +68,8 @@ export const hashArray = ( array ) => cyrb53( array );
  * Computes a hash for the given list of parameters.
  *
  * @method
- * @param {...Number} params - A list of parameters.
- * @return {Number} The hash.
+ * @param {...number} params - A list of parameters.
+ * @return {number} The hash.
  */
 export const hash = ( ...params ) => cyrb53( params );
 
@@ -79,9 +77,9 @@ export const hash = ( ...params ) => cyrb53( params );
  * Computes a cache key for the given node.
  *
  * @method
- * @param {Object} object - The object to be hashed.
- * @param {Boolean} [force=false] - Whether to force a cache key computation or not.
- * @return {Number} The hash.
+ * @param {Object|Node} object - The object to be hashed.
+ * @param {boolean} [force=false] - Whether to force a cache key computation or not.
+ * @return {number} The hash.
  */
 export function getCacheKey( object, force = false ) {
 
@@ -110,7 +108,7 @@ export function getCacheKey( object, force = false ) {
  *
  * @generator
  * @param {Object} node - The object to be hashed.
- * @param {Boolean} [toJSON=false] - Whether to return JSON or not.
+ * @param {boolean} [toJSON=false] - Whether to return JSON or not.
  * @yields {Object} A result node holding the property, index (if available) and the child node.
  */
 export function* getNodeChildren( node, toJSON = false ) {
@@ -175,8 +173,8 @@ const dataFromObject = /*@__PURE__*/ new WeakMap();
  * Returns the data type for the given the length.
  *
  * @method
- * @param {Number} length - The length.
- * @return {String} The data type.
+ * @param {number} length - The length.
+ * @return {string} The data type.
  */
 export function getTypeFromLength( length ) {
 
@@ -188,7 +186,7 @@ export function getTypeFromLength( length ) {
  * Returns the typed array for the given data type.
  *
  * @method
- * @param {String} type - The data type.
+ * @param {string} type - The data type.
  * @return {TypedArray} The typed array.
  */
 export function getTypedArrayFromType( type ) {
@@ -221,8 +219,8 @@ export function getTypedArrayFromType( type ) {
  * Returns the length for the given data type.
  *
  * @method
- * @param {String} type - The data type.
- * @return {Number} The length.
+ * @param {string} type - The data type.
+ * @return {number} The length.
  */
 export function getLengthFromType( type ) {
 
@@ -242,8 +240,8 @@ export function getLengthFromType( type ) {
  * Returns the data type for the given value.
  *
  * @method
- * @param {Any} value - The value.
- * @return {String?} The data type.
+ * @param {any} value - The value.
+ * @return {?string} The data type.
  */
 export function getValueType( value ) {
 
@@ -313,9 +311,9 @@ export function getValueType( value ) {
  * Returns the value/object for the given data type and parameters.
  *
  * @method
- * @param {String} type - The given type.
- * @param {...Any} params - A parameter list.
- * @return {Any} The value/object.
+ * @param {string} type - The given type.
+ * @param {...any} params - A parameter list.
+ * @return {any} The value/object.
  */
 export function getValueFromType( type, ...params ) {
 
@@ -405,7 +403,7 @@ export function getDataFromObject( object ) {
  *
  * @method
  * @param {ArrayBuffer} arrayBuffer - The array buffer.
- * @return {String} The Base64 string.
+ * @return {string} The Base64 string.
  */
 export function arrayBufferToBase64( arrayBuffer ) {
 
@@ -427,7 +425,7 @@ export function arrayBufferToBase64( arrayBuffer ) {
  * Converts the given Base64 string to an array buffer.
  *
  * @method
- * @param {String} base64 - The Base64 string.
+ * @param {string} base64 - The Base64 string.
  * @return {ArrayBuffer} The array buffer.
  */
 export function base64ToArrayBuffer( base64 ) {

package/src/nodes/core/NodeVar.js

@@ -9,17 +9,17 @@ class NodeVar {
 	/**
 	 * Constructs a new node variable.
 	 *
-	 * @param {String} name - The name of the variable.
-	 * @param {String} type - The type of the variable.
-	 * @param {Boolean} [readOnly=false] - The read-only flag.
-	 * @param {Number?} [count=null] - The size.
+	 * @param {string} name - The name of the variable.
+	 * @param {string} type - The type of the variable.
+	 * @param {boolean} [readOnly=false] - The read-only flag.
+	 * @param {?number} [count=null] - The size.
 	 */
 	constructor( name, type, readOnly = false, count = null ) {
 
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -28,28 +28,28 @@ class NodeVar {
 		/**
 		 * The name of the variable.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.name = name;
 
 		/**
 		 * The type of the variable.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.type = type;
 
 		/**
 		 *  The read-only flag.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 */
 		this.readOnly = readOnly;
 
 		/**
 		 * The size.
 		 *
-		 * @type {Number?}
+		 * @type {?number}
 		 */
 		this.count = count;
 

package/src/nodes/core/NodeVarying.js

@@ -13,8 +13,8 @@ class NodeVarying extends NodeVar {
 	/**
 	 * Constructs a new node varying.
 	 *
-	 * @param {String} name - The name of the varying.
-	 * @param {String} type - The type of the varying.
+	 * @param {string} name - The name of the varying.
+	 * @param {string} type - The type of the varying.
 	 */
 	constructor( name, type ) {
 
@@ -24,7 +24,7 @@ class NodeVarying extends NodeVar {
 		 * Whether this varying requires interpolation or not. This property can be used
 		 * to check if the varying can be optimized for a variable.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.needsInterpolation = false;
@@ -32,7 +32,7 @@ class NodeVarying extends NodeVar {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/nodes/core/OutputStructNode.js

@@ -1,8 +1,6 @@
 import Node from './Node.js';
 import { nodeProxy } from '../tsl/TSLBase.js';
 
-/** @module OutputStructNode **/
-
 /**
  * This node can be used to define multiple outputs in a shader programs.
  *
@@ -36,7 +34,7 @@ class OutputStructNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -97,6 +95,7 @@ export default OutputStructNode;
 /**
  * TSL function for creating an output struct node.
  *
+ * @tsl
  * @function
  * @param {...Node} members - A parameter list of nodes.
  * @returns {OutputStructNode}

package/src/nodes/core/ParameterNode.js

@@ -1,8 +1,6 @@
 import { nodeObject } from '../tsl/TSLBase.js';
 import PropertyNode from './PropertyNode.js';
 
-/** @module ParameterNode **/
-
 /**
  * Special version of {@link PropertyNode} which is used for parameters.
  *
@@ -19,8 +17,8 @@ class ParameterNode extends PropertyNode {
 	/**
 	 * Constructs a new parameter node.
 	 *
-	 * @param {String} nodeType - The type of the node.
-	 * @param {String?} [name=null] - The name of the parameter in the shader.
+	 * @param {string} nodeType - The type of the node.
+	 * @param {?string} [name=null] - The name of the parameter in the shader.
 	 */
 	constructor( nodeType, name = null ) {
 
@@ -29,7 +27,7 @@ class ParameterNode extends PropertyNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -56,9 +54,10 @@ export default ParameterNode;
 /**
  * TSL function for creating a parameter node.
  *
+ * @tsl
  * @function
- * @param {String} type - The type of the node.
- * @param {String?} name - The name of the parameter in the shader.
+ * @param {string} type - The type of the node.
+ * @param {?string} name - The name of the parameter in the shader.
  * @returns {ParameterNode}
  */
 export const parameter = ( type, name ) => nodeObject( new ParameterNode( type, name ) );