@types/three 0.171.0 → 0.172.0

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

@@ -14,46 +14,200 @@ 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 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 {

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;

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

@@ -33,20 +33,33 @@ interface ComputeNodeData {
 }
 interface SceneData {
     background?: Color | Texture | CubeTexture | undefined;
-    backgroundNode?: Node | undefined;
+    backgroundNode?: ShaderNodeObject<Node> | undefined;
     fog?: Fog | FogExp2 | undefined;
-    fogNode?: Node | undefined;
+    fogNode?: ShaderNodeObject<Node> | undefined;
     environment?: Texture | undefined;
-    environmentNode?: Node | undefined;
+    environmentNode?: ShaderNodeObject<Node> | undefined;
 }
 declare module "../../../scenes/Scene.js" {
     interface Scene {
-        environmentNode?: Node | null | undefined;
-        backgroundNode?: Node | null | undefined;
-        fogNode?: Node | null | undefined;
+        environmentNode?: ShaderNodeObject<Node> | null | undefined;
+        backgroundNode?: ShaderNodeObject<Node> | null | undefined;
+        fogNode?: ShaderNodeObject<Node> | null | undefined;
     }
 }
+/**
+ * This renderer module manages node-related objects and is the
+ * primary interface between the renderer and the node system.
+ *
+ * @private
+ * @augments DataMap
+ */
 declare class Nodes extends DataMap<{
+    /**
+     * Constructs a new nodes management component.
+     *
+     * @param {Renderer} renderer - The renderer.
+     * @param {Backend} backend - The renderer's backend.
+     */
     nodeUniformsGroup: {
         key: NodeUniformsGroup;
         value: NodeUniformsGroupData;
@@ -75,23 +88,132 @@ declare class Nodes extends DataMap<{
     groupsData: ChainMap<readonly [UniformGroupNode, NodeUniformsGroup], {
         version?: number;
     }>;
+    cacheLib: {
+        [type: string]: WeakMap<object, ShaderNodeObject<Node> | undefined>;
+    };
     constructor(renderer: Renderer, backend: Backend);
+    /**
+     * Returns `true` if the given node uniforms group must be updated or not.
+     *
+     * @param {NodeUniformsGroup} nodeUniformsGroup - The node uniforms group.
+     * @return {Boolean} Whether the node uniforms group requires an update or not.
+     */
     updateGroup(nodeUniformsGroup: NodeUniformsGroup): boolean;
+    /**
+     * Returns the cache key for the given render object.
+     *
+     * @param {RenderObject} renderObject - The render object.
+     * @return {Number} The cache key.
+     */
     getForRenderCacheKey(renderObject: RenderObject): string;
+    /**
+     * Returns a node builder state for the given render object.
+     *
+     * @param {RenderObject} renderObject - The render object.
+     * @return {NodeBuilderState} The node builder state.
+     */
     getForRender(renderObject: RenderObject): NodeBuilderState;
+    /**
+     * Deletes the given object from the internal data map
+     *
+     * @param {Any} object - The object to delete.
+     * @return {Object?} The deleted dictionary.
+     */
     delete(
         object: NodeUniformsGroup | RenderObject | ComputeNode | Scene,
     ): SceneData | RenderObjectData | NodeUniformsGroupData | ComputeNodeData;
+    /**
+     * Returns a node builder state for the given compute node.
+     *
+     * @param {Node} computeNode - The compute node.
+     * @return {NodeBuilderState} The node builder state.
+     */
     getForCompute(computeNode: ComputeNode): NodeBuilderState;
+    /**
+     * Creates a node builder state for the given node builder.
+     *
+     * @private
+     * @param {NodeBuilder} nodeBuilder - The node builder.
+     * @return {NodeBuilderState} The node builder state.
+     */
     _createNodeBuilderState(nodeBuilder: NodeBuilder): NodeBuilderState;
-    getEnvironmentNode(scene: Scene): Node | null;
-    getBackgroundNode(scene: Scene): Node | null;
-    getFogNode(scene: Scene): Node | null;
+    /**
+     * Returns an environment node for the current configured
+     * scene environment.
+     *
+     * @param {Scene} scene - The scene.
+     * @return {Node} A node representing the current scene environment.
+     */
+    getEnvironmentNode(scene: Scene): ShaderNodeObject<Node> | null;
+    /**
+     * Returns a background node for the current configured
+     * scene background.
+     *
+     * @param {Scene} scene - The scene.
+     * @return {Node} A node representing the current scene background.
+     */
+    getBackgroundNode(scene: Scene): ShaderNodeObject<Node> | null;
+    /**
+     * Returns a fog node for the current configured scene fog.
+     *
+     * @param {Scene} scene - The scene.
+     * @return {Node} A node representing the current scene fog.
+     */
+    getFogNode(scene: Scene): ShaderNodeObject<Node> | null;
+    /**
+     * Returns a cache key for the given scene and lights node.
+     * This key is used by `RenderObject` as a part of the dynamic
+     * cache key (a key that must be checked every time the render
+     * objects is drawn).
+     *
+     * @param {Scene} scene - The scene.
+     * @param {LightsNode} lightsNode - The lights node.
+     * @return {Number} The cache key.
+     */
     getCacheKey(scene: Scene, lightsNode: LightsNode): string;
-    updateScene(scene: Scene): void;
+    /**
+     * A boolean that indicates whether tone mapping should be enabled
+     * or not.
+     *
+     * @type {Boolean}
+     */
     get isToneMappingState(): boolean;
+    /**
+     * If a scene background is configured, this method makes sure to
+     * represent the background with a corresponding node-based implementation.
+     *
+     * @param {Scene} scene - The scene.
+     */
     updateBackground(scene: Scene): void;
+    /**
+     * This method is part of the caching of nodes which are used to represents the
+     * scene's background, fog or environment.
+     *
+     * @param {String} type - The type of object to cache.
+     * @param {Object} object - The object.
+     * @param {Function} callback - A callback that produces a node representation for the given object.
+     * @param {Boolean} [forceUpdate=false] - Whether an update should be enforced or not.
+     * @return {Node} The node representation.
+     */
+    getCacheNode(
+        type: string,
+        object: object,
+        callback: () => ShaderNodeObject<Node> | undefined,
+        forceUpdate?: boolean,
+    ): ShaderNodeObject<Node> | undefined;
+    /**
+     * If a scene fog is configured, this method makes sure to
+     * represent the fog with a corresponding node-based implementation.
+     *
+     * @param {Scene} scene - The scene.
+     */
     updateFog(scene: Scene): void;
+    /**
+     * If a scene environment is configured, this method makes sure to
+     * represent the environment with a corresponding node-based implementation.
+     *
+     * @param {Scene} scene - The scene.
+     */
     updateEnvironment(scene: Scene): void;
     getNodeFrame(
         renderer?: Renderer,
@@ -101,14 +223,66 @@ declare class Nodes extends DataMap<{
         material?: Material | null,
     ): NodeFrame;
     getNodeFrameForRender(renderObject: RenderObject): NodeFrame;
+    /**
+     * Returns the current output cache key.
+     *
+     * @return {String} The output cache key.
+     */
     getOutputCacheKey(): string;
+    /**
+     * Checks if the output configuration (tone mapping and color space) for
+     * the given target has changed.
+     *
+     * @param {Texture} outputTarget - The output target.
+     * @return {Boolean} Whether the output configuration has changed or not.
+     */
     hasOutputChange(outputTarget: Texture): boolean;
-    getOutputNode(outputTexture: Texture): ShaderNodeObject<Node>;
+    /**
+     * Returns a node that represents the output configuration (tone mapping and
+     * color space) for the current target.
+     *
+     * @param {Texture} outputTarget - The output target.
+     * @return {Node} The output node.
+     */
+    getOutputNode(outputTarget: Texture): ShaderNodeObject<Node>;
+    /**
+     * Triggers the call of `updateBefore()` methods
+     * for all nodes of the given render object.
+     *
+     * @param {RenderObject} renderObject - The render object.
+     */
     updateBefore(renderObject: RenderObject): void;
+    /**
+     * Triggers the call of `updateAfter()` methods
+     * for all nodes of the given render object.
+     *
+     * @param {RenderObject} renderObject - The render object.
+     */
     updateAfter(renderObject: RenderObject): void;
+    /**
+     * Triggers the call of `update()` methods
+     * for all nodes of the given compute node.
+     *
+     * @param {Node} computeNode - The compute node.
+     */
     updateForCompute(computeNode: ComputeNode): void;
+    /**
+     * Triggers the call of `update()` methods
+     * for all nodes of the given compute node.
+     *
+     * @param {RenderObject} renderObject - The render object.
+     */
     updateForRender(renderObject: RenderObject): void;
+    /**
+     * Returns `true` if the given render object requires a refresh.
+     *
+     * @param {RenderObject} renderObject - The render object.
+     * @return {Boolean} Whether the given render object requires a refresh or not.
+     */
     needsRefresh(renderObject: RenderObject): boolean;
+    /**
+     * Frees the intenral resources.
+     */
     dispose(): void;
 }
 export default Nodes;

three/src/renderers/webgpu/nodes/BasicNodeLibrary.d.ts

@@ -1,5 +1,15 @@
 import NodeLibrary from "../../common/nodes/NodeLibrary.js";
+/**
+ * This version of a node library represents a basic version
+ * just focusing on lights and tone mapping techniques.
+ *
+ * @private
+ * @augments NodeLibrary
+ */
 declare class BasicNodeLibrary extends NodeLibrary {
+    /**
+     * Constructs a new basic node library.
+     */
     constructor();
 }
 export default BasicNodeLibrary;

three/src/renderers/webgpu/nodes/StandardNodeLibrary.d.ts

@@ -1,5 +1,16 @@
 import NodeLibrary from "../../common/nodes/NodeLibrary.js";
+/**
+ * This version of a node library represents the standard version
+ * used in {@link WebGPURenderer}. It maps lights, tone mapping
+ * techniques and materials to node-based implementations.
+ *
+ * @private
+ * @augments NodeLibrary
+ */
 declare class StandardNodeLibrary extends NodeLibrary {
+    /**
+     * Constructs a new standard node library.
+     */
     constructor();
 }
 export default StandardNodeLibrary;

three/src/textures/DataTexture.d.ts

@@ -51,7 +51,7 @@ export class DataTexture extends Texture {
      * @param colorSpace See {@link Texture.colorSpace | .colorSpace}. Default {@link NoColorSpace}
      */
     constructor(
-        data?: BufferSource | null,
+        data?: ArrayBufferView | null,
         width?: number,
         height?: number,
         format?: PixelFormat,
@@ -111,7 +111,7 @@ export class DataTexture extends Texture {
 }
 
 export interface TextureImageData {
-    data: Uint8Array | Uint8ClampedArray;
+    data: ArrayBufferView;
     height: number;
     width: number;
 }

three/src/textures/Texture.d.ts

@@ -10,6 +10,7 @@ import {
     Wrapping,
 } from "../constants.js";
 import { EventDispatcher } from "../core/EventDispatcher.js";
+import { RenderTarget } from "../core/RenderTarget.js";
 import { Matrix3 } from "../math/Matrix3.js";
 import { Vector2 } from "../math/Vector2.js";
 import { CompressedTextureMipmap } from "./CompressedTexture.js";
@@ -426,6 +427,8 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
      */
     static DEFAULT_MAPPING: Mapping;
 
+    renderTarget: RenderTarget | null;
+
     /**
      * A callback function, called when the texture is updated _(e.g., when needsUpdate has been set to true and then the texture is used)_.
      */

three/examples/jsm/animation/MMDAnimationHelper.d.ts

@@ -1,99 +0,0 @@
-import { AnimationClip, AnimationMixer, Audio, Bone, Camera, Mesh, Object3D, Quaternion, SkinnedMesh } from "three";
-
-import { CCDIKSolver } from "./CCDIKSolver.js";
-import { MMDPhysics } from "./MMDPhysics.js";
-
-export interface MMDAnimationHelperParameter {
-    sync?: boolean | undefined;
-    afterglow?: number | undefined;
-    resetPhysicsOnLoop?: boolean | undefined;
-    pmxAnimation?: boolean | undefined;
-}
-
-export interface MMDAnimationHelperAddParameter {
-    animation?: AnimationClip | AnimationClip[] | undefined;
-    physics?: boolean | undefined;
-    warmup?: number | undefined;
-    unitStep?: number | undefined;
-    maxStepNum?: number | undefined;
-    gravity?: number | undefined;
-    delayTime?: number | undefined;
-}
-
-export interface MMDAnimationHelperPoseParameter {
-    resetPose?: boolean | undefined;
-    ik?: boolean | undefined;
-    grant?: boolean | undefined;
-}
-
-export interface MMDAnimationHelperMixer {
-    looped: boolean;
-    mixer?: AnimationMixer | undefined;
-    ikSolver: CCDIKSolver;
-    grantSolver: GrantSolver;
-    physics?: MMDPhysics | undefined;
-    duration?: number | undefined;
-}
-
-/**
- * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
- * https://github.com/takahirox/three-mmd-loader instead.
- */
-export class MMDAnimationHelper {
-    constructor(params?: MMDAnimationHelperParameter);
-    meshes: SkinnedMesh[];
-    camera: Camera | null;
-    cameraTarget: Object3D;
-    audio: Audio;
-    audioManager: AudioManager;
-    configuration: {
-        sync: boolean;
-        afterglow: number;
-        resetPhysicsOnLoop: boolean;
-        pmxAnimation: boolean;
-    };
-    enabled: {
-        animation: boolean;
-        ik: boolean;
-        grant: boolean;
-        physics: boolean;
-        cameraAnimation: boolean;
-    };
-    objects: WeakMap<SkinnedMesh | Camera | AudioManager, MMDAnimationHelperMixer>;
-    onBeforePhysics: (mesh: SkinnedMesh) => void;
-    sharedPhysics: boolean;
-    masterPhysics: null;
-
-    add(object: SkinnedMesh | Camera | Audio, params?: MMDAnimationHelperAddParameter): this;
-    remove(object: SkinnedMesh | Camera | Audio): this;
-    update(delta: number): this;
-    pose(mesh: SkinnedMesh, vpd: object, params?: MMDAnimationHelperPoseParameter): this;
-    enable(key: string, enabled: boolean): this;
-    createGrantSolver(mesh: SkinnedMesh): GrantSolver;
-}
-
-export interface AudioManagerParameter {
-    delayTime?: number | undefined;
-}
-
-export class AudioManager {
-    constructor(audio: Audio, params?: AudioManagerParameter);
-    audio: Audio;
-    elapsedTime: number;
-    currentTime: number;
-    delayTime: number;
-    audioDuration: number;
-    duration: number;
-
-    control(delta: number): this;
-}
-
-export class GrantSolver {
-    constructor(mesh: SkinnedMesh, grants: object[]);
-    mesh: SkinnedMesh;
-    grants: object[];
-
-    update(): this;
-    updateOne(gran: object[]): this;
-    addGrantRotation(bone: Bone, q: Quaternion, ratio: number): this;
-}