@types/three 0.172.0 → 0.174.0

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,
@@ -32,13 +34,13 @@ declare class NumberNodeUniform extends NumberUniform {
     /**
      * Overwritten to return the value of the node uniform.
      *
-     * @return {Number} The value.
+     * @return {number} The value.
      */
     getValue(): number;
     /**
      * Returns the node uniform data type.
      *
-     * @return {String} The data type.
+     * @return {string} The data type.
      */
     getType(): string | null;
 }
@@ -66,7 +68,7 @@ declare class Vector2NodeUniform extends Vector2Uniform {
     /**
      * Returns the node uniform data type.
      *
-     * @return {String} The data type.
+     * @return {string} The data type.
      */
     getType(): string | null;
 }
@@ -94,7 +96,7 @@ declare class Vector3NodeUniform extends Vector3Uniform {
     /**
      * Returns the node uniform data type.
      *
-     * @return {String} The data type.
+     * @return {string} The data type.
      */
     getType(): string | null;
 }
@@ -122,7 +124,7 @@ declare class Vector4NodeUniform extends Vector4Uniform {
     /**
      * Returns the node uniform data type.
      *
-     * @return {String} The data type.
+     * @return {string} The data type.
      */
     getType(): string | null;
 }
@@ -150,7 +152,35 @@ declare class ColorNodeUniform extends ColorUniform {
     /**
      * Returns the node uniform data type.
      *
-     * @return {String} The 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;
 }
@@ -178,7 +208,7 @@ declare class Matrix3NodeUniform extends Matrix3Uniform {
     /**
      * Returns the node uniform data type.
      *
-     * @return {String} The data type.
+     * @return {string} The data type.
      */
     getType(): string | null;
 }
@@ -206,12 +236,13 @@ declare class Matrix4NodeUniform extends Matrix4Uniform {
     /**
      * Returns the node uniform data type.
      *
-     * @return {String} The data type.
+     * @return {string} The data type.
      */
     getType(): string | null;
 }
 export {
     ColorNodeUniform,
+    Matrix2NodeUniform,
     Matrix3NodeUniform,
     Matrix4NodeUniform,
     NumberNodeUniform,

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

@@ -14,7 +14,7 @@ declare class NodeUniformsGroup extends UniformsGroup {
     /**
      * Constructs a new node-based uniforms group.
      *
-     * @param {String} name - The group's name.
+     * @param {string} name - The group's name.
      * @param {UniformGroupNode} groupNode - The uniform group node.
      */
     constructor(name: string, groupNode: UniformGroupNode);

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

@@ -39,6 +39,10 @@ interface SceneData {
     environment?: Texture | undefined;
     environmentNode?: ShaderNodeObject<Node> | undefined;
 }
+interface CacheKeyData {
+    callId: number;
+    cacheKey: number;
+}
 declare module "../../../scenes/Scene.js" {
     interface Scene {
         environmentNode?: ShaderNodeObject<Node> | null | undefined;
@@ -81,10 +85,7 @@ declare class Nodes extends DataMap<{
     backend: Backend;
     nodeFrame: NodeFrame;
     nodeBuilderCache: Map<string, NodeBuilderState>;
-    callHashCache: ChainMap<readonly [Scene, LightsNode], {
-        callId: number;
-        cacheKey: string;
-    }>;
+    callHashCache: ChainMap<readonly [Scene, LightsNode], CacheKeyData>;
     groupsData: ChainMap<readonly [UniformGroupNode, NodeUniformsGroup], {
         version?: number;
     }>;
@@ -96,14 +97,14 @@ declare class Nodes extends DataMap<{
      * 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.
+     * @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.
+     * @return {number} The cache key.
      */
     getForRenderCacheKey(renderObject: RenderObject): string;
     /**
@@ -116,12 +117,12 @@ declare class Nodes extends DataMap<{
     /**
      * Deletes the given object from the internal data map
      *
-     * @param {Any} object - The object to delete.
-     * @return {Object?} The deleted dictionary.
+     * @param {any} object - The object to delete.
+     * @return {?Object} The deleted dictionary.
      */
     delete(
         object: NodeUniformsGroup | RenderObject | ComputeNode | Scene,
-    ): SceneData | RenderObjectData | NodeUniformsGroupData | ComputeNodeData;
+    ): RenderObjectData | NodeUniformsGroupData | ComputeNodeData | SceneData;
     /**
      * Returns a node builder state for the given compute node.
      *
@@ -168,14 +169,14 @@ declare class Nodes extends DataMap<{
      *
      * @param {Scene} scene - The scene.
      * @param {LightsNode} lightsNode - The lights node.
-     * @return {Number} The cache key.
+     * @return {number} The cache key.
      */
-    getCacheKey(scene: Scene, lightsNode: LightsNode): string;
+    getCacheKey(scene: Scene, lightsNode: LightsNode): number;
     /**
      * A boolean that indicates whether tone mapping should be enabled
      * or not.
      *
-     * @type {Boolean}
+     * @type {boolean}
      */
     get isToneMappingState(): boolean;
     /**
@@ -189,10 +190,10 @@ declare class Nodes extends DataMap<{
      * 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 {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.
+     * @param {boolean} [forceUpdate=false] - Whether an update should be enforced or not.
      * @return {Node} The node representation.
      */
     getCacheNode(
@@ -226,7 +227,7 @@ declare class Nodes extends DataMap<{
     /**
      * Returns the current output cache key.
      *
-     * @return {String} The output cache key.
+     * @return {string} The output cache key.
      */
     getOutputCacheKey(): string;
     /**
@@ -234,7 +235,7 @@ declare class Nodes extends DataMap<{
      * the given target has changed.
      *
      * @param {Texture} outputTarget - The output target.
-     * @return {Boolean} Whether the output configuration has changed or not.
+     * @return {boolean} Whether the output configuration has changed or not.
      */
     hasOutputChange(outputTarget: Texture): boolean;
     /**
@@ -277,11 +278,11 @@ declare class Nodes extends DataMap<{
      * 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.
+     * @return {boolean} Whether the given render object requires a refresh or not.
      */
     needsRefresh(renderObject: RenderObject): boolean;
     /**
-     * Frees the intenral resources.
+     * Frees the internal resources.
      */
     dispose(): void;
 }

three/src/renderers/webgl/WebGLState.d.ts

@@ -11,14 +11,14 @@ import { Vector4 } from "../../math/Vector4.js";
 import { WebGLRenderTarget } from "../WebGLRenderTarget.js";
 import { WebGLExtensions } from "./WebGLExtensions.js";
 
-declare class ColorBuffer {
+declare class WebGLColorBuffer {
     setMask(colorMask: boolean): void;
     setLocked(lock: boolean): void;
     setClear(r: number, g: number, b: number, a: number, premultipliedAlpha: boolean): void;
     reset(): void;
 }
 
-declare class DepthBuffer {
+declare class WebGLDepthBuffer {
     constructor();
 
     setReversed(value: boolean): void;
@@ -31,7 +31,7 @@ declare class DepthBuffer {
     reset(): void;
 }
 
-declare class StencilBuffer {
+declare class WebGLStencilBuffer {
     constructor();
 
     setTest(stencilTest: boolean): void;
@@ -47,9 +47,9 @@ declare class WebGLState {
     constructor(gl: WebGLRenderingContext, extensions: WebGLExtensions);
 
     buffers: {
-        color: ColorBuffer;
-        depth: DepthBuffer;
-        stencil: StencilBuffer;
+        color: WebGLColorBuffer;
+        depth: WebGLDepthBuffer;
+        stencil: WebGLStencilBuffer;
     };
 
     enable(id: number): void;
@@ -117,3 +117,4 @@ declare class WebGLState {
 }
 
 export { WebGLState };
+export type { WebGLColorBuffer, WebGLDepthBuffer, WebGLStencilBuffer };

three/src/renderers/webgpu/WebGPUBackend.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="@webgpu/types" />
 
-import { CoordinateSystem } from "../../constants.js";
+import { CoordinateSystem, HalfFloatType, UnsignedByteType } from "../../constants.js";
 import Backend, { BackendParameters } from "../common/Backend.js";
 
 export interface WebGPUBackendParameters extends BackendParameters {
@@ -10,6 +10,7 @@ export interface WebGPUBackendParameters extends BackendParameters {
     device?: GPUDevice | undefined;
     powerPreference?: GPUPowerPreference | undefined;
     context?: GPUCanvasContext | undefined;
+    outputType?: typeof UnsignedByteType | typeof HalfFloatType | undefined;
 }
 
 export default class WebGPUBackend extends Backend {

three/src/textures/Texture.d.ts

@@ -455,11 +455,8 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
     updateMatrix(): void;
 
     /**
-     * Make copy of the texture
-     * @remarks Note this is not a **"deep copy"**, the image is shared
-     * @remarks
-     * Besides, cloning a texture does not automatically mark it for a texture upload
-     * You have to set {@link needsUpdate | .needsUpdate} to `true` as soon as it's image property (the data source) is fully loaded or ready.
+     * Make copy of the texture. Note this is not a "deep copy", the image is shared. Cloning the texture automatically
+     * marks it for texture upload.
      */
     clone(): this;
 

three/src/textures/VideoFrameTexture.d.ts

@@ -0,0 +1,27 @@
+import {
+    MagnificationTextureFilter,
+    Mapping,
+    MinificationTextureFilter,
+    PixelFormat,
+    TextureDataType,
+    Wrapping,
+} from "../constants.js";
+import { VideoTexture } from "./VideoTexture.js";
+
+declare class VideoFrameTexture extends VideoTexture {
+    constructor(
+        mapping?: Mapping,
+        wrapS?: Wrapping,
+        wrapT?: Wrapping,
+        magFilter?: MagnificationTextureFilter,
+        minFilter?: MinificationTextureFilter,
+        format?: PixelFormat,
+        type?: TextureDataType,
+        anisotropy?: number,
+    );
+
+    // FIXME Replace with VideoFrame when we no longer need to support TypeScript 5.0
+    setFrame(frane: unknown): void;
+}
+
+export { VideoFrameTexture };

three/examples/jsm/geometries/InstancedPointsGeometry.d.ts

@@ -1,13 +0,0 @@
-import { InstancedBufferGeometry } from "three";
-
-declare class InstancedPointsGeometry extends InstancedBufferGeometry {
-    readonly isInstancedPointsGeometry: true;
-
-    constructor();
-
-    setPositions(array: Float32Array | ArrayLike<number>): this;
-
-    setColors(array: Float32Array | ArrayLike<number>): this;
-}
-
-export default InstancedPointsGeometry;

three/examples/jsm/objects/InstancedPoints.d.ts

@@ -1,10 +0,0 @@
-import { InstancedPointsNodeMaterial, Mesh } from "three/webgpu";
-import InstancedPointsGeometry from "../geometries/InstancedPointsGeometry.js";
-
-declare class InstancedPoints extends Mesh<InstancedPointsGeometry, InstancedPointsNodeMaterial> {
-    readonly isInstancedPoints: true;
-
-    constructor(geometry?: InstancedPointsGeometry, material?: InstancedPointsNodeMaterial);
-}
-
-export default InstancedPoints;

three/src/materials/nodes/InstancedPointsNodeMaterial.d.ts

@@ -1,33 +0,0 @@
-import { Color } from "../../math/Color.js";
-import Node from "../../nodes/core/Node.js";
-import { Texture } from "../../textures/Texture.js";
-import { PointsMaterialParameters } from "../PointsMaterial.js";
-import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
-
-export interface InstancedPointsNodeMaterialParameters extends NodeMaterialParameters, PointsMaterialParameters {
-    useAlphaToCoverage?: boolean | undefined;
-    useColor?: boolean | undefined;
-    pointWidth?: number | undefined;
-    pointColorNode?: Node | null | undefined;
-    pointWidthNode?: Node | null | undefined;
-}
-
-declare class InstancedPointsNodeMaterial extends NodeMaterial {
-    useAlphaToCoverage: boolean;
-    useColor: boolean | undefined;
-    pointWidth: number;
-    pointColorNode: Node | null;
-    pointWidthNode: Node | null;
-
-    // Properties from LineDashedMaterial
-    readonly isPointsMaterial: true;
-    color: Color;
-    map: Texture | null;
-    alphaMap: Texture | null;
-    size: number;
-    sizeAttenuation: boolean;
-
-    constructor(params?: InstancedPointsNodeMaterialParameters);
-}
-
-export default InstancedPointsNodeMaterial;