@types/three 0.171.0 → 0.173.0

three/src/renderers/common/XRRenderTarget.d.ts

@@ -0,0 +1,23 @@
+import { RenderTarget } from "../../core/RenderTarget.js";
+/**
+ * A special type of render target that is used when rendering
+ * with the WebXR Device API.
+ *
+ * @private
+ * @augments RenderTarget
+ */
+declare class XRRenderTarget extends RenderTarget {
+    readonly isXRRenderTarget: true;
+    hasExternalTextures: boolean;
+    autoAllocateDepthBuffer: boolean;
+    /**
+     * Constructs a new XR render target.
+     *
+     * @param {Number} [width=1] - The width of the render target.
+     * @param {Number} [height=1] - The height of the render target.
+     * @param {Object} [options={}] - The configuration options.
+     */
+    constructor(width?: number, height?: number, options?: {});
+    copy(source: XRRenderTarget): this;
+}
+export { XRRenderTarget };

three/src/renderers/common/nodes/NodeBuilderState.d.ts

@@ -2,6 +2,15 @@ import NodeMaterialObserver from "../../../materials/nodes/manager/NodeMaterialO
 import Node from "../../../nodes/core/Node.js";
 import NodeAttribute from "../../../nodes/core/NodeAttribute.js";
 import BindGroup from "../BindGroup.js";
+/**
+ * This module represents the state of a node builder after it was
+ * used to build the nodes for a render object. The state holds the
+ * results of the build for further processing in the renderer.
+ *
+ * Render objects with identical cache keys share the same node builder state.
+ *
+ * @private
+ */
 declare class NodeBuilderState {
     vertexShader: string | null;
     fragmentShader: string | null;
@@ -12,8 +21,22 @@ declare class NodeBuilderState {
     updateNodes: Node[];
     updateBeforeNodes: Node[];
     updateAfterNodes: Node[];
-    monitor: NodeMaterialObserver;
+    observer: NodeMaterialObserver;
     usedTimes: number;
+    /**
+     * Constructs a new node builder state.
+     *
+     * @param {String?} vertexShader - The native vertex shader code.
+     * @param {String?} fragmentShader - The native fragment shader code.
+     * @param {String?} computeShader - The native compute shader code.
+     * @param {Array<NodeAttribute>} nodeAttributes - An array of node attributes.
+     * @param {Array<BindGroup>} bindings - An array of bind groups.
+     * @param {Array<Node>} updateNodes - An array of nodes that implement their `update()` method.
+     * @param {Array<Node>} updateBeforeNodes - An array of nodes that implement their `updateBefore()` method.
+     * @param {Array<Node>} updateAfterNodes - An array of nodes that implement their `updateAfter()` method.
+     * @param {NodeMaterialObserver} observer - A node material observer.
+     * @param {Array<Object>} transforms - An array with transform attribute objects. Only relevant when using compute shaders with WebGL 2.
+     */
     constructor(
         vertexShader: string | null,
         fragmentShader: string | null,
@@ -23,9 +46,16 @@ declare class NodeBuilderState {
         updateNodes: Node[],
         updateBeforeNodes: Node[],
         updateAfterNodes: Node[],
-        monitor: NodeMaterialObserver,
+        observer: NodeMaterialObserver,
         transforms?: never[],
     );
+    /**
+     * This method is used to create a array of bind groups based
+     * on the existing bind groups of this state. Shared groups are
+     * not cloned.
+     *
+     * @return {Array<BindGroup>} A array of bind groups.
+     */
     createBindings(): BindGroup[];
 }
 export default NodeBuilderState;

three/src/renderers/common/nodes/NodeLibrary.d.ts

@@ -5,6 +5,14 @@ import NodeMaterial from "../../../materials/nodes/NodeMaterial.js";
 import Node from "../../../nodes/core/Node.js";
 import AnalyticLightNode from "../../../nodes/lighting/AnalyticLightNode.js";
 import { NodeRepresentation, ShaderNodeObject } from "../../../nodes/tsl/TSLCore.js";
+/**
+ * The purpose of a node library is to assign node implementations
+ * to existing library features. In `WebGPURenderer` lights, materials
+ * which are not based on `NodeMaterial` as well as tone mapping techniques
+ * are implemented with node-based modules.
+ *
+ * @private
+ */
 declare class NodeLibrary {
     lightNodes: WeakMap<{
         new(): Light;
@@ -18,26 +26,89 @@ declare class NodeLibrary {
         ToneMapping,
         (color: NodeRepresentation, exposure: NodeRepresentation) => ShaderNodeObject<Node>
     >;
+    /**
+     * Constructs a new node library.
+     */
     constructor();
+    /**
+     * Returns a matching node material instance for the given material object.
+     *
+     * This method also assigns/copies the properties of the given material object
+     * to the node material. This is done to make sure the current material
+     * configuration carries over to the node version.
+     *
+     * @param {Material} material - A material.
+     * @return {NodeMaterial} The corresponding node material.
+     */
     fromMaterial(material: Material): Material | NodeMaterial | null;
+    /**
+     * Adds a tone mapping node function for a tone mapping technique (constant).
+     *
+     * @param {Function} toneMappingNode - The tone mapping node function.
+     * @param {Number} toneMapping - The tone mapping.
+     */
     addToneMapping(
         toneMappingNode: (color: NodeRepresentation, exposure: NodeRepresentation) => ShaderNodeObject<Node>,
         toneMapping: ToneMapping,
     ): void;
+    /**
+     * Returns a tone mapping node function for a tone mapping technique (constant).
+     *
+     * @param {Number} toneMapping - The tone mapping.
+     * @return {Function?} The tone mapping node function. Returns `null` if no node function is found.
+     */
     getToneMappingFunction(
         toneMapping: ToneMapping,
     ): ((color: NodeRepresentation, exposure: NodeRepresentation) => ShaderNodeObject<Node>) | null;
+    /**
+     * Returns a node material class definition for a material type.
+     *
+     * @param {String} materialType - The material type.
+     * @return {NodeMaterial.constructor?} The node material class definition. Returns `null` if no node material is found.
+     */
     getMaterialNodeClass(materialType: string): (new() => NodeMaterial) | null;
+    /**
+     * Adds a node material class definition for a given material type.
+     *
+     * @param {NodeMaterial.constructor} materialNodeClass - The node material class definition.
+     * @param {String} materialClassType - The material type.
+     */
     addMaterial(materialNodeClass: {
         new(): NodeMaterial;
     }, materialClassType: string): void;
+    /**
+     * Returns a light node class definition for a light class definition.
+     *
+     * @param {Light.constructor} light - The light class definition.
+     * @return {AnalyticLightNode.constructor?} The light node class definition. Returns `null` if no light node is found.
+     */
     getLightNodeClass(light: Light): (new(light: Light) => AnalyticLightNode<Light>) | null;
+    /**
+     * Adds a light node class definition for a given light class definition.
+     *
+     * @param {AnalyticLightNode.constructor} lightNodeClass - The light node class definition.
+     * @param {Light.constructor} lightClass - The light class definition.
+     */
     addLight<TLight extends Light>(lightNodeClass: {
         new(light: TLight): AnalyticLightNode<TLight>;
     }, lightClass: {
         new(): TLight;
     }): void;
+    /**
+     * Adds a node class definition for the given type to the provided type library.
+     *
+     * @param {Any} nodeClass - The node class definition.
+     * @param {Number|String} type - The object type.
+     * @param {Map} library - The type library.
+     */
     addType<TNodeClass, TType>(nodeClass: TNodeClass, type: TType, library: Map<TType, TNodeClass>): void;
+    /**
+     * Adds a node class definition for the given class definition to the provided type library.
+     *
+     * @param {Any} nodeClass - The node class definition.
+     * @param {Any} baseClass - The class definition.
+     * @param {WeakMap} library - The type library.
+     */
     addClass<TNodeClass, TBaseClass extends object>(
         nodeClass: TNodeClass,
         baseClass: TBaseClass,

three/src/renderers/common/nodes/NodeUniform.d.ts

@@ -1,4 +1,5 @@
 import { Color } from "../../../math/Color.js";
+import { Matrix2 } from "../../../math/Matrix2.js";
 import { Matrix3 } from "../../../math/Matrix3.js";
 import { Matrix4 } from "../../../math/Matrix4.js";
 import { Vector2 } from "../../../math/Vector2.js";
@@ -7,6 +8,7 @@ import { Vector4 } from "../../../math/Vector4.js";
 import NodeUniform from "../../../nodes/core/NodeUniform.js";
 import {
     ColorUniform,
+    Matrix2Uniform,
     Matrix3Uniform,
     Matrix4Uniform,
     NumberUniform,
@@ -14,50 +16,233 @@ import {
     Vector3Uniform,
     Vector4Uniform,
 } from "../Uniform.js";
+/**
+ * A special form of Number uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments NumberUniform
+ */
 declare class NumberNodeUniform extends NumberUniform {
     nodeUniform: NodeUniform<number>;
+    /**
+     * Constructs a new node-based Number uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
     constructor(nodeUniform: NodeUniform<number>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Number} The value.
+     */
     getValue(): number;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
     getType(): string | null;
 }
+/**
+ * A special form of Vector2 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Vector2Uniform
+ */
 declare class Vector2NodeUniform extends Vector2Uniform {
     nodeUniform: NodeUniform<Vector2>;
+    /**
+     * Constructs a new node-based Vector2 uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
     constructor(nodeUniform: NodeUniform<Vector2>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Vector2} The value.
+     */
     getValue(): Vector2;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
     getType(): string | null;
 }
+/**
+ * A special form of Vector3 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Vector3Uniform
+ */
 declare class Vector3NodeUniform extends Vector3Uniform {
     nodeUniform: NodeUniform<Vector3>;
+    /**
+     * Constructs a new node-based Vector3 uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
     constructor(nodeUniform: NodeUniform<Vector3>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Vector3} The value.
+     */
     getValue(): Vector3;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
     getType(): string | null;
 }
+/**
+ * A special form of Vector4 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Vector4Uniform
+ */
 declare class Vector4NodeUniform extends Vector4Uniform {
     nodeUniform: NodeUniform<Vector4>;
+    /**
+     * Constructs a new node-based Vector4 uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
     constructor(nodeUniform: NodeUniform<Vector4>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Vector4} The value.
+     */
     getValue(): Vector4;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
     getType(): string | null;
 }
+/**
+ * A special form of Color uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments ColorUniform
+ */
 declare class ColorNodeUniform extends ColorUniform {
     nodeUniform: NodeUniform<Color>;
+    /**
+     * Constructs a new node-based Color uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
     constructor(nodeUniform: NodeUniform<Color>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Color} The value.
+     */
     getValue(): Color;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
     getType(): string | null;
 }
+/**
+ * A special form of Matrix2 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Matrix2Uniform
+ */
+declare class Matrix2NodeUniform extends Matrix2Uniform {
+    nodeUniform: NodeUniform<Matrix2>;
+    /**
+     * Constructs a new node-based Matrix2 uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
+    constructor(nodeUniform: NodeUniform<Matrix2>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Matrix2} The value.
+     */
+    getValue(): Matrix2;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
+    getType(): string | null;
+}
+/**
+ * A special form of Matrix3 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Matrix3Uniform
+ */
 declare class Matrix3NodeUniform extends Matrix3Uniform {
     nodeUniform: NodeUniform<Matrix3>;
+    /**
+     * Constructs a new node-based Matrix3 uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
     constructor(nodeUniform: NodeUniform<Matrix3>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Matrix3} The value.
+     */
     getValue(): Matrix3;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
     getType(): string | null;
 }
+/**
+ * A special form of Matrix4 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Matrix4Uniform
+ */
 declare class Matrix4NodeUniform extends Matrix4Uniform {
     nodeUniform: NodeUniform<Matrix4>;
+    /**
+     * Constructs a new node-based Matrix4 uniform.
+     *
+     * @param {NodeUniform} nodeUniform - The node uniform.
+     */
     constructor(nodeUniform: NodeUniform<Matrix4>);
+    /**
+     * Overwritten to return the value of the node uniform.
+     *
+     * @return {Matrix4} The value.
+     */
     getValue(): Matrix4;
+    /**
+     * Returns the node uniform data type.
+     *
+     * @return {String} The data type.
+     */
     getType(): string | null;
 }
 export {
     ColorNodeUniform,
+    Matrix2NodeUniform,
     Matrix3NodeUniform,
     Matrix4NodeUniform,
     NumberNodeUniform,

three/src/renderers/common/nodes/NodeUniformsGroup.d.ts

@@ -1,10 +1,22 @@
-import { UniformGroupNode, UniformNode } from "../../../nodes/Nodes.js";
+import { UniformGroupNode } from "../../../nodes/Nodes.js";
 import UniformsGroup from "../UniformsGroup.js";
+/**
+ * A special form of uniforms group that represents
+ * the individual uniforms as node-based uniforms.
+ *
+ * @private
+ * @augments UniformsGroup
+ */
 declare class NodeUniformsGroup extends UniformsGroup {
     id: number;
     groupNode: UniformGroupNode;
     readonly isNodeUniformsGroup: true;
+    /**
+     * Constructs a new node-based uniforms group.
+     *
+     * @param {String} name - The group's name.
+     * @param {UniformGroupNode} groupNode - The uniform group node.
+     */
     constructor(name: string, groupNode: UniformGroupNode);
-    getNodes(): UniformNode<unknown>[];
 }
 export default NodeUniformsGroup;