super-three 0.173.4 → 0.175.0

package/src/nodes/parsers/GLSLNodeFunction.js

@@ -111,7 +111,7 @@ class GLSLNodeFunction extends NodeFunction {
 	/**
 	 * Constructs a new GLSL node function.
 	 *
-	 * @param {String} source - The GLSL source.
+	 * @param {string} source - The GLSL source.
 	 */
 	constructor( source ) {
 
@@ -128,8 +128,8 @@ class GLSLNodeFunction extends NodeFunction {
 	/**
 	 * This method returns the GLSL code of the node function.
 	 *
-	 * @param {String} [name=this.name] - The function's name.
-	 * @return {String} The shader code.
+	 * @param {string} [name=this.name] - The function's name.
+	 * @return {string} The shader code.
 	 */
 	getCode( name = this.name ) {
 

package/src/nodes/parsers/GLSLNodeParser.js

@@ -11,7 +11,7 @@ class GLSLNodeParser extends NodeParser {
 	/**
 	 * The method parses the given GLSL code an returns a node function.
 	 *
-	 * @param {String} source - The GLSL code.
+	 * @param {string} source - The GLSL code.
 	 * @return {GLSLNodeFunction} A node function.
 	 */
 	parseFunction( source ) {

package/src/nodes/pmrem/PMREMNode.js

@@ -5,12 +5,9 @@ import { uniform } from '../core/UniformNode.js';
 import { NodeUpdateType } from '../core/constants.js';
 import { nodeProxy, vec3 } from '../tsl/TSLBase.js';
 
-import { WebGLCoordinateSystem } from '../../constants.js';
 import { Texture } from '../../textures/Texture.js';
-
-/** @module PMREMNode **/
-
-let _generator = null;
+import PMREMGenerator from '../../renderers/common/extras/PMREMGenerator.js';
+import { materialEnvRotation } from '../accessors/MaterialProperties.js';
 
 const _cache = new WeakMap();
 
@@ -18,8 +15,8 @@ const _cache = new WeakMap();
  * Generates the cubeUV size based on the given image height.
  *
  * @private
- * @param {Number} imageHeight - The image height.
- * @return {{texelWidth: Number,texelHeight: Number, maxMip: Number}} The result object.
+ * @param {number} imageHeight - The image height.
+ * @return {{texelWidth: number,texelHeight: number, maxMip: number}} The result object.
  */
 function _generateCubeUVSize( imageHeight ) {
 
@@ -34,15 +31,19 @@ function _generateCubeUVSize( imageHeight ) {
 }
 
 /**
- * Generates a PMREM from the given texture .
+ * Generates a PMREM from the given texture.
  *
  * @private
  * @param {Texture} texture - The texture to create the PMREM for.
- * @return {Texture} The PMREM.
+ * @param {Renderer} renderer - The renderer.
+ * @param {PMREMGenerator} generator - The PMREM generator.
+ * @return {?Texture} The PMREM.
  */
-function _getPMREMFromTexture( texture ) {
+function _getPMREMFromTexture( texture, renderer, generator ) {
 
-	let cacheTexture = _cache.get( texture );
+	const cache = _getCache( renderer );
+
+	let cacheTexture = cache.get( texture );
 
 	const pmremVersion = cacheTexture !== undefined ? cacheTexture.pmremVersion : - 1;
 
@@ -54,7 +55,7 @@ function _getPMREMFromTexture( texture ) {
 
 			if ( isCubeMapReady( image ) ) {
 
-				cacheTexture = _generator.fromCubemap( texture, cacheTexture );
+				cacheTexture = generator.fromCubemap( texture, cacheTexture );
 
 			} else {
 
@@ -67,7 +68,7 @@ function _getPMREMFromTexture( texture ) {
 
 			if ( isEquirectangularMapReady( image ) ) {
 
-				cacheTexture = _generator.fromEquirectangular( texture, cacheTexture );
+				cacheTexture = generator.fromEquirectangular( texture, cacheTexture );
 
 			} else {
 
@@ -79,7 +80,7 @@ function _getPMREMFromTexture( texture ) {
 
 		cacheTexture.pmremVersion = texture.pmremVersion;
 
-		_cache.set( texture, cacheTexture );
+		cache.set( texture, cacheTexture );
 
 	}
 
@@ -87,6 +88,30 @@ function _getPMREMFromTexture( texture ) {
 
 }
 
+/**
+ * Returns a cache that stores generated PMREMs for the respective textures.
+ * A cache must be maintained per renderer since PMREMs are render target textures
+ * which can't be shared across render contexts.
+ *
+ * @private
+ * @param {Renderer} renderer - The renderer.
+ * @return {WeakMap<Texture, Texture>} The PMREM cache.
+ */
+function _getCache( renderer ) {
+
+	let rendererCache = _cache.get( renderer );
+
+	if ( rendererCache === undefined ) {
+
+		rendererCache = new WeakMap();
+		_cache.set( renderer, rendererCache );
+
+	}
+
+	return rendererCache;
+
+}
+
 /**
  * This node represents a PMREM which is a special type of preprocessed
  * environment map intended for PBR materials.
@@ -152,7 +177,7 @@ class PMREMNode extends TempNode {
 		 * Reference to a PMREM generator.
 		 *
 		 * @private
-		 * @type {PMREMGenerator}
+		 * @type {?PMREMGenerator}
 		 * @default null
 		 */
 		this._generator = null;
@@ -195,7 +220,7 @@ class PMREMNode extends TempNode {
 		/**
 		 * The `updateBeforeType` is set to `NodeUpdateType.RENDER`.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'render'
 		 */
 		this.updateBeforeType = NodeUpdateType.RENDER;
@@ -236,7 +261,7 @@ class PMREMNode extends TempNode {
 
 	}
 
-	updateBefore() {
+	updateBefore( frame ) {
 
 		let pmrem = this._pmrem;
 
@@ -251,7 +276,7 @@ class PMREMNode extends TempNode {
 
 			} else {
 
-				pmrem = _getPMREMFromTexture( texture );
+				pmrem = _getPMREMFromTexture( texture, frame.renderer, this._generator );
 
 			}
 
@@ -269,14 +294,12 @@ class PMREMNode extends TempNode {
 
 	setup( builder ) {
 
-		if ( _generator === null ) {
+		if ( this._generator === null ) {
 
-			_generator = builder.createPMREMGenerator();
+			this._generator = new PMREMGenerator( builder.renderer );
 
 		}
 
-		//
-
 		this.updateBefore( builder );
 
 		//
@@ -291,15 +314,7 @@ class PMREMNode extends TempNode {
 
 		//
 
-		const texture = this.value;
-
-		if ( builder.renderer.coordinateSystem === WebGLCoordinateSystem && texture.isPMREMTexture !== true && texture.isRenderTargetTexture === true ) {
-
-			uvNode = vec3( uvNode.x.negate(), uvNode.yz );
-
-		}
-
-		uvNode = vec3( uvNode.x, uvNode.y.negate(), uvNode.z );
+		uvNode = materialEnvRotation.mul( vec3( uvNode.x, uvNode.y.negate(), uvNode.z ) );
 
 		//
 
@@ -317,6 +332,14 @@ class PMREMNode extends TempNode {
 
 	}
 
+	dispose() {
+
+		super.dispose();
+
+		if ( this._generator !== null ) this._generator.dispose();
+
+	}
+
 }
 
 export default PMREMNode;
@@ -325,8 +348,8 @@ export default PMREMNode;
  * Returns `true` if the given cube map image has been fully loaded.
  *
  * @private
- * @param {Array<(Image|Object)>} image - The cube map image.
- * @return {Boolean} Whether the given cube map is ready or not.
+ * @param {?Array<(Image|Object)>} [image] - The cube map image.
+ * @return {boolean} Whether the given cube map is ready or not.
  */
 function isCubeMapReady( image ) {
 
@@ -351,7 +374,7 @@ function isCubeMapReady( image ) {
  *
  * @private
  * @param {(Image|Object)} image - The equirectangular image.
- * @return {Boolean} Whether the given cube map is ready or not.
+ * @return {boolean} Whether the given cube map is ready or not.
  */
 function isEquirectangularMapReady( image ) {
 
@@ -364,10 +387,11 @@ function isEquirectangularMapReady( image ) {
 /**
  * TSL function for creating a PMREM node.
  *
+ * @tsl
  * @function
  * @param {Texture} value - The input texture.
- * @param {Node<vec2>} [uvNode=null] - The uv node.
- * @param {Node<float>} [levelNode=null] - The level node.
+ * @param {?Node<vec2>} [uvNode=null] - The uv node.
+ * @param {?Node<float>} [levelNode=null] - The level node.
  * @returns {PMREMNode}
  */
-export const pmremTexture = /*@__PURE__*/ nodeProxy( PMREMNode );
+export const pmremTexture = /*@__PURE__*/ nodeProxy( PMREMNode ).setParameterLength( 1, 3 );

package/src/nodes/pmrem/PMREMUtils.js

@@ -1,5 +1,5 @@
 import { Fn, int, float, vec2, vec3, vec4, If } from '../tsl/TSLBase.js';
-import { cos, sin, abs, max, exp2, log2, clamp, fract, mix, floor, normalize, cross, all } from '../math/MathNode.js';
+import { cos, sin, abs, max, exp2, log2, clamp, fract, mix, floor, normalize, cross } from '../math/MathNode.js';
 import { mul } from '../math/OperatorNode.js';
 import { select } from '../math/ConditionalNode.js';
 import { Loop, Break } from '../utils/LoopNode.js';
@@ -258,7 +258,7 @@ export const blur = /*@__PURE__*/ Fn( ( { n, latitudinal, poleAxis, outputDirect
 
 	const axis = vec3( select( latitudinal, poleAxis, cross( poleAxis, outputDirection ) ) ).toVar();
 
-	If( all( axis.equals( vec3( 0.0 ) ) ), () => {
+	If( axis.equal( vec3( 0.0 ) ), () => {
 
 		axis.assign( vec3( outputDirection.z, 0.0, outputDirection.x.negate() ) );
 

package/src/nodes/procedural/Checker.js

@@ -1,12 +1,11 @@
 import { uv } from '../accessors/UV.js';
 import { Fn } from '../tsl/TSLBase.js';
 
-/** @module Procedural **/
-
 /**
  * Creates a 2x2 checkerboard pattern that can be used as procedural texture data.
  *
- * @method
+ * @tsl
+ * @function
  * @param {Node<vec2>} coord - The uv coordinates.
  * @return {Node<float>} The result data.
  */

package/src/nodes/shapes/Shapes.js

@@ -2,12 +2,11 @@ import { Fn, float } from '../tsl/TSLBase.js';
 import { lengthSq, smoothstep } from '../math/MathNode.js';
 import { uv } from '../accessors/UV.js';
 
-/** @module Shapes **/
-
 /**
  * Generates a circle based on the uv coordinates.
  *
- * @method
+ * @tsl
+ * @function
  * @param {Node<vec2>} coord - The uv to generate the circle.
  * @return {Node<float>} The circle shape.
  */

package/src/nodes/tsl/TSLBase.js

@@ -23,9 +23,10 @@ export * from '../utils/RemapNode.js'; // .remap(), .remapClamp()
 export * from '../code/ExpressionNode.js'; // expression()
 export * from '../utils/Discard.js'; // Discard(), Return()
 export * from '../display/RenderOutputNode.js'; // .renderOutput()
+export * from '../utils/DebugNode.js'; // debug()
 
 export function addNodeElement( name/*, nodeElement*/ ) {
 
-	console.warn( 'THREE.TSLBase: AddNodeElement has been removed in favor of tree-shaking. Trying add', name );
+	console.warn( 'THREE.TSL: AddNodeElement has been removed in favor of tree-shaking. Trying add', name );
 
 }

package/src/nodes/tsl/TSLCore.js

@@ -9,8 +9,6 @@ import ConstNode from '../core/ConstNode.js';
 import MemberNode from '../utils/MemberNode.js';
 import { getValueFromType, getValueType } from '../core/NodeUtils.js';
 
-/** @module TSLCore **/
-
 let currentStack = null;
 
 const NodeElements = new Map();
@@ -19,12 +17,12 @@ export function addMethodChaining( name, nodeElement ) {
 
 	if ( NodeElements.has( name ) ) {
 
-		console.warn( `Redefinition of method chaining ${ name }` );
+		console.warn( `THREE.TSL: Redefinition of method chaining '${ name }'.` );
 		return;
 
 	}
 
-	if ( typeof nodeElement !== 'function' ) throw new Error( `Node element ${ name } is not a function` );
+	if ( typeof nodeElement !== 'function' ) throw new Error( `THREE.TSL: Node element ${ name } is not a function` );
 
 	NodeElements.set( name, nodeElement );
 
@@ -215,11 +213,38 @@ const ShaderNodeProxy = function ( NodeClass, scope = null, factor = null, setti
 
 	const assignNode = ( node ) => nodeObject( settings !== null ? Object.assign( node, settings ) : node );
 
+	let fn, name = scope, minParams, maxParams;
+
+	function verifyParamsLimit( params ) {
+
+		let tslName;
+
+		if ( name ) tslName = /[a-z]/i.test( name ) ? name + '()' : name;
+		else tslName = NodeClass.type;
+
+		if ( minParams !== undefined && params.length < minParams ) {
+
+			console.error( `THREE.TSL: "${ tslName }" parameter length is less than minimum required.` );
+
+			return params.concat( new Array( minParams - params.length ).fill( 0 ) );
+
+		} else if ( maxParams !== undefined && params.length > maxParams ) {
+
+			console.error( `THREE.TSL: "${ tslName }" parameter length exceeds limit.` );
+
+			return params.slice( 0, maxParams );
+
+		}
+
+		return params;
+
+	}
+
 	if ( scope === null ) {
 
-		return ( ...params ) => {
+		fn = ( ...params ) => {
 
-			return assignNode( new NodeClass( ...nodeArray( params ) ) );
+			return assignNode( new NodeClass( ...nodeArray( verifyParamsLimit( params ) ) ) );
 
 		};
 
@@ -227,22 +252,41 @@ const ShaderNodeProxy = function ( NodeClass, scope = null, factor = null, setti
 
 		factor = nodeObject( factor );
 
-		return ( ...params ) => {
+		fn = ( ...params ) => {
 
-			return assignNode( new NodeClass( scope, ...nodeArray( params ), factor ) );
+			return assignNode( new NodeClass( scope, ...nodeArray( verifyParamsLimit( params ) ), factor ) );
 
 		};
 
 	} else {
 
-		return ( ...params ) => {
+		fn = ( ...params ) => {
 
-			return assignNode( new NodeClass( scope, ...nodeArray( params ) ) );
+			return assignNode( new NodeClass( scope, ...nodeArray( verifyParamsLimit( params ) ) ) );
 
 		};
 
 	}
 
+	fn.setParameterLength = ( ...params ) => {
+
+		if ( params.length === 1 ) minParams = maxParams = params[ 0 ];
+		else if ( params.length === 2 ) [ minParams, maxParams ] = params;
+
+		return fn;
+
+	};
+
+	fn.setName = ( value ) => {
+
+		name = value;
+
+		return fn;
+
+	};
+
+	return fn;
+
 };
 
 const ShaderNodeImmutable = function ( NodeClass, ...params ) {
@@ -307,11 +351,7 @@ class ShaderCallNodeInternal extends Node {
 
 			}
 
-			if ( builder.currentFunctionNode !== null ) {
-
-				builder.currentFunctionNode.includes.push( functionNode );
-
-			}
+			builder.addInclude( functionNode );
 
 			result = nodeObject( functionNode.call( inputNodes ) );
 
@@ -520,7 +560,35 @@ export const nodeArray = ( val, altType = null ) => new ShaderNodeArray( val, al
 export const nodeProxy = ( ...params ) => new ShaderNodeProxy( ...params );
 export const nodeImmutable = ( ...params ) => new ShaderNodeImmutable( ...params );
 
-export const Fn = ( jsFunc, nodeType ) => {
+let fnId = 0;
+
+export const Fn = ( jsFunc, layout = null ) => {
+
+	let nodeType = null;
+
+	if ( layout !== null ) {
+
+		if ( typeof layout === 'object' ) {
+
+			nodeType = layout.return;
+
+		} else {
+
+			if ( typeof layout === 'string' ) {
+
+				nodeType = layout;
+
+			} else {
+
+				console.error( 'THREE.TSL: Invalid layout type.' );
+
+			}
+
+			layout = null;
+
+		}
+
+	}
 
 	const shaderNode = new ShaderNode( jsFunc, nodeType );
 
@@ -562,20 +630,50 @@ export const Fn = ( jsFunc, nodeType ) => {
 
 	};
 
+	if ( layout !== null ) {
+
+		if ( typeof layout.inputs !== 'object' ) {
+
+			const fullLayout = {
+				name: 'fn' + fnId ++,
+				type: nodeType,
+				inputs: []
+			};
+
+			for ( const name in layout ) {
+
+				if ( name === 'return' ) continue;
+
+				fullLayout.inputs.push( {
+					name: name,
+					type: layout[ name ]
+				} );
+
+			}
+
+			layout = fullLayout;
+
+		}
+
+		fn.setLayout( layout );
+
+	}
+
 	return fn;
 
 };
 
 /**
+ * @tsl
  * @function
  * @deprecated since r168. Use {@link Fn} instead.
  *
- * @param  {...any} params
+ * @param {...any} params
  * @returns {Function}
  */
 export const tslFn = ( ...params ) => { // @deprecated, r168
 
-	console.warn( 'TSL.ShaderNode: tslFn() has been renamed to Fn().' );
+	console.warn( 'THREE.TSL: tslFn() has been renamed to Fn().' );
 	return Fn( ...params );
 
 };
@@ -672,7 +770,7 @@ addMethodChaining( 'toMat4', mat4 );
 
 // basic nodes
 
-export const element = /*@__PURE__*/ nodeProxy( ArrayElementNode );
+export const element = /*@__PURE__*/ nodeProxy( ArrayElementNode ).setParameterLength( 2 );
 export const convert = ( node, types ) => nodeObject( new ConvertNode( nodeObject( node ), types ) );
 export const split = ( node, channels ) => nodeObject( new SplitNode( nodeObject( node ), channels ) );
 

package/src/nodes/utils/ArrayElementNode.js

@@ -41,7 +41,7 @@ class ArrayElementNode extends Node { // @TODO: If extending from TempNode it br
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -53,7 +53,7 @@ class ArrayElementNode extends Node { // @TODO: If extending from TempNode it br
 	 * This method is overwritten since the node type is inferred from the array-like node.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( builder ) {
 
@@ -63,8 +63,10 @@ class ArrayElementNode extends Node { // @TODO: If extending from TempNode it br
 
 	generate( builder ) {
 
+		const indexType = this.indexNode.getNodeType( builder );
+
 		const nodeSnippet = this.node.build( builder );
-		const indexSnippet = this.indexNode.build( builder, 'uint' );
+		const indexSnippet = this.indexNode.build( builder, ! builder.isVector( indexType ) && builder.isInteger( indexType ) ? indexType : 'uint' );
 
 		return `${ nodeSnippet }[ ${ indexSnippet } ]`;
 

package/src/nodes/utils/ConvertNode.js

@@ -19,7 +19,7 @@ class ConvertNode extends Node {
 	 * Constructs a new convert node.
 	 *
 	 * @param {Node} node - The node which type should be converted.
-	 * @param {String} convertTo - The target node type. Multiple types can be defined by separating them with a `|` sign.
+	 * @param {string} convertTo - The target node type. Multiple types can be defined by separating them with a `|` sign.
 	 */
 	constructor( node, convertTo ) {
 
@@ -35,7 +35,7 @@ class ConvertNode extends Node {
 		/**
 		 * The target node type. Multiple types can be defined by separating them with a `|` sign.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.convertTo = convertTo;
 
@@ -46,7 +46,7 @@ class ConvertNode extends Node {
 	 * matching type from the {@link ConvertNode#convertTo} property.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( builder ) {
 

package/src/nodes/utils/CubeMapNode.js

@@ -6,8 +6,6 @@ import { cubeTexture } from '../accessors/CubeTextureNode.js';
 import CubeRenderTarget from '../../renderers/common/CubeRenderTarget.js';
 import { CubeReflectionMapping, CubeRefractionMapping, EquirectangularReflectionMapping, EquirectangularRefractionMapping } from '../../constants.js';
 
-/** @module CubeMapNode **/
-
 const _cache = new WeakMap();
 
 /**
@@ -44,7 +42,7 @@ class CubeMapNode extends TempNode {
 		 * A reference to the internal cube texture.
 		 *
 		 * @private
-		 * @type {CubeTexture}
+		 * @type {?CubeTexture}
 		 * @default null
 		 */
 		this._cubeTexture = null;
@@ -55,7 +53,7 @@ class CubeMapNode extends TempNode {
 		 * @private
 		 * @type {CubeTextureNode}
 		 */
-		this._cubeTextureNode = cubeTexture();
+		this._cubeTextureNode = cubeTexture( null );
 
 		const defaultTexture = new CubeTexture();
 		defaultTexture.isRenderTargetTexture = true;
@@ -74,7 +72,7 @@ class CubeMapNode extends TempNode {
 		 * The `updateBeforeType` is set to `NodeUpdateType.RENDER` since the node updates
 		 * the texture once per render in its {@link CubeMapNode#updateBefore} method.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'render'
 		 */
 		this.updateBeforeType = NodeUpdateType.RENDER;
@@ -170,7 +168,7 @@ export default CubeMapNode;
  *
  * @private
  * @param {Image} image - The equirectangular image to check.
- * @return {Boolean} Whether the image is ready or not.
+ * @return {boolean} Whether the image is ready or not.
  */
 function isEquirectangularMapReady( image ) {
 
@@ -212,7 +210,7 @@ function onTextureDispose( event ) {
  *
  * @private
  * @param {Texture} texture - The cube texture.
- * @param {Number} mapping - The original texture mapping.
+ * @param {number} mapping - The original texture mapping.
  */
 function mapTextureMapping( texture, mapping ) {
 
@@ -231,8 +229,9 @@ function mapTextureMapping( texture, mapping ) {
 /**
  * TSL function for creating a cube map node.
  *
+ * @tsl
  * @function
  * @param {Node} envNode - The node representing the environment map.
  * @returns {CubeMapNode}
  */
-export const cubeMapNode = /*@__PURE__*/ nodeProxy( CubeMapNode );
+export const cubeMapNode = /*@__PURE__*/ nodeProxy( CubeMapNode ).setParameterLength( 1 );