@types/three 0.184.0 → 0.185.0

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

@@ -1,125 +1,9 @@
-import CodeNode from "../../../nodes/code/CodeNode.js";
-import { NodeShaderStage } from "../../../nodes/core/constants.js";
+import { Object3D } from "../../../core/Object3D.js";
 import NodeBuilder from "../../../nodes/core/NodeBuilder.js";
-import NodeUniform from "../../../nodes/core/NodeUniform.js";
-import NodeVar from "../../../nodes/core/NodeVar.js";
-import StructTypeNode from "../../../nodes/core/StructTypeNode.js";
-import { ShaderNode } from "../../../nodes/tsl/TSLCore.js";
-import { Texture } from "../../../textures/Texture.js";
-import NodeUniformsGroup from "../../common/nodes/NodeUniformsGroup.js";
+import Renderer from "../../common/Renderer.js";
 
-type BuiltinStage = NodeShaderStage | "attribute" | "output";
-interface BuiltinType {
-    name: string;
-    property: string;
-    type: string;
+declare class WGSLNodeBuilder extends NodeBuilder {
+    constructor(object: Object3D, renderer: Renderer);
 }
 
-export default class WGSLNodeBuilder extends NodeBuilder {
-    builtins: { [key in BuiltinStage]: Map<string, BuiltinType> };
-    uniformGroups: { [key in NodeShaderStage]: NodeUniformsGroup };
-
-    _generateTextureSample(
-        texture: Texture,
-        textureProperty: string,
-        uvSnippet: string,
-        depthSnippet: string | null,
-        shaderStage: NodeShaderStage,
-    ): string;
-    _generateVideoSample(textureProperty: string, uvSnippet: string, shaderStage: NodeShaderStage): string;
-    _generateTextureSampleLevel(
-        texture: Texture,
-        textureProperty: string,
-        uvSnippet: string,
-        levelSnippet: string,
-        depthSnippet: string | null,
-        shaderStage: NodeShaderStage,
-    ): string;
-    generateTextureLod(texture: Texture, textureProperty: string, uvSnippet: string, levelSnippet: string): string;
-    generateTextureLoad(
-        texture: Texture,
-        textureProperty: string,
-        uvIndexSnippet: string,
-        depthSnippet: string | null,
-        shaderStage: NodeShaderStage,
-    ): string;
-    generateTextureStore(
-        texture: Texture,
-        textureProperty: string,
-        uvIndexSnippet: string,
-        depthSnippet: string | null,
-        valueSnippet: string,
-    ): string;
-    isUnfilterable(texture: Texture): boolean;
-    generateTexture(
-        texture: Texture,
-        textureProperty: string,
-        uvSnippet: string,
-        depthSnippet: string | null,
-        shaderStage: NodeShaderStage,
-    ): string;
-    generateTextureGrad(
-        texture: Texture,
-        textureProperty: string,
-        uvSnippet: string,
-        gradSnippet: string[],
-        depthSnippet: string | null,
-        shaderStage: NodeShaderStage,
-    ): string;
-    generateTextureCompare(
-        texture: Texture,
-        textureProperty: string,
-        uvSnippet: string,
-        compareSnippet: String,
-        shaderStage: NodeShaderStage,
-    ): string;
-    generateTextureLevel(
-        texture: Texture,
-        textureProperty: string,
-        uvSnippet: string,
-        levelSnippet: string,
-        depthSnippet: string | null,
-        shaderStage: NodeShaderStage,
-    ): string;
-
-    getPropertyName(node: NodeVar | NodeUniform<unknown, unknown>, shaderStage: NodeShaderStage): string;
-
-    getOutputStructName(): string;
-
-    _getUniformGroupCount(shaderStage: NodeShaderStage): number;
-
-    getFunctionOperator(op: string): string | null;
-    // getStorageAccess(node: StorageTextureNode | StorageBufferNode): string;
-
-    getBuiltin(name: string, property: string, type: string, shaderStage: BuiltinStage): string;
-    getVertexIndex(): string;
-    getInstanceIndex(): string;
-    getDrawIndex(): null;
-
-    buildFunctionCode(shaderNode: ShaderNode): string;
-
-    getFragDepth(): string;
-    getFragCoord(): string;
-    getFrontFacing(): string;
-
-    getBuiltins(shaderStage: BuiltinStage): string;
-    getAttributes(shaderStage: NodeShaderStage): string;
-
-    getStructMembers(struct: StructTypeNode): string;
-    getStructs(shaderStage: NodeShaderStage): string;
-
-    getVar(type: string, name: string): string;
-    getVars(shaderStage: NodeShaderStage): string;
-    getVaryings(shaderStage: NodeShaderStage): string;
-    getUniforms(shaderStage: NodeShaderStage): string;
-    buildCode(): void;
-    getMethod(method: string, output?: string | null): string;
-
-    _getWGSLMethod(method: string): CodeNode | string;
-    _include(name: string): CodeNode;
-    _getWGSLVertexCode(shaderData: { [key: string]: string }): string;
-    _getWGSLFragmentCode(shaderData: { [key: string]: string }): string;
-    _getWGSLComputeCode(shaderData: { [key: string]: string }, workgroupSize: string): string;
-    _getWGSLStruct(name: string, vars: string): string;
-    _getWGSLStructBinding(name: string, vars: string, access: string, binding: number, group: number): string;
-}
+export default WGSLNodeBuilder;

three/src/textures/CubeDepthTexture.d.ts

@@ -6,10 +6,9 @@ import {
     TextureDataType,
     Wrapping,
 } from "../constants.js";
-import { DepthTextureImageData } from "./DepthTexture.js";
-import { Texture } from "./Texture.js";
+import { DepthTexture, DepthTextureImageData } from "./DepthTexture.js";
 
-declare class CubeDepthTexture extends Texture<CubeDepthTextureImageData> {
+declare class CubeDepthTexture extends DepthTexture<CubeDepthTextureImageData> {
     readonly isCubeDepthTexture: true;
     readonly isCubeTexture: true;
 

three/src/textures/DataTexture.d.ts

@@ -1,4 +1,5 @@
 import {
+    ColorSpace,
     MagnificationTextureFilter,
     Mapping,
     MinificationTextureFilter,
@@ -63,7 +64,7 @@ export class DataTexture extends Texture<DataTextureImageData> {
         magFilter?: MagnificationTextureFilter,
         minFilter?: MinificationTextureFilter,
         anisotropy?: number,
-        colorSpace?: string,
+        colorSpace?: ColorSpace,
     );
 
     /**

three/src/textures/DepthTexture.d.ts

@@ -15,7 +15,7 @@ import { Texture } from "./Texture.js";
  * @see {@link https://threejs.org/docs/index.html#api/en/textures/DepthTexture | Official Documentation}
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/textures/DepthTexture.js | Source}
  */
-export class DepthTexture extends Texture<DepthTextureImageData> {
+export class DepthTexture<TImage = DepthTextureImageData> extends Texture<TImage> {
     /**
      * Create a new instance of {@link DepthTexture}
      * @param width Width of the texture.
@@ -31,8 +31,8 @@ export class DepthTexture extends Texture<DepthTextureImageData> {
      * @param {number} [depth=1] - The depth of the texture.
      */
     constructor(
-        width: number,
-        height: number,
+        width?: number,
+        height?: number,
         type?: TextureDataType,
         mapping?: Mapping,
         wrapS?: Wrapping,
@@ -99,7 +99,7 @@ export class DepthTexture extends Texture<DepthTextureImageData> {
 }
 
 export interface DepthTextureImageData {
-    width: number;
-    height: number;
+    width: number | undefined;
+    height: number | undefined;
     depth: number;
 }

three/examples/jsm/lighting/TiledLighting.d.ts

@@ -1,9 +0,0 @@
-import { Lighting } from "three/webgpu";
-import { Light } from "../../../src/lights/Light.js";
-import TiledLightsNode from "../tsl/lighting/TiledLightsNode.js";
-
-export class TiledLighting extends Lighting {
-    constructor();
-
-    createNode(lights?: Light[]): TiledLightsNode;
-}

three/examples/jsm/tsl/display/AnamorphicNode.d.ts

@@ -1,31 +0,0 @@
-import { Node, TempNode, Vector2 } from "three/webgpu";
-
-export default class AnamorphicNode extends TempNode<"vec4"> {
-    textureNode: Node;
-    thresholdNode: Node;
-    scaleNode: Node;
-    samples: number;
-    resolutionScale: number;
-
-    constructor(textureNode: Node, thresholdNode: Node, scaleNode: Node, samples: number);
-
-    getTextureNode(): Node;
-
-    setSize(width: number, height: number): void;
-
-    /**
-     * @deprecated The "resolution" property has been renamed to "resolutionScale" and is now of type `number`.
-     */
-    get resolution(): Vector2;
-    /**
-     * @deprecated The "resolution" property has been renamed to "resolutionScale" and is now of type `number`.
-     */
-    set resolution(value: Vector2);
-}
-
-export const anamorphic: (
-    node: Node,
-    threshold?: Node,
-    scale?: Node,
-    samples?: Node | number,
-) => AnamorphicNode;

three/examples/jsm/tsl/lighting/TiledLightsNode.d.ts

@@ -1,22 +0,0 @@
-import { LightsNode, Node } from "three/webgpu";
-
-export const circleIntersectsAABB: (
-    circleCenter: Node,
-    radius: Node,
-    minBounds: Node,
-    maxBounds: Node,
-) => Node;
-
-declare class TiledLightsNode extends LightsNode {
-    constructor(maxLights?: number, tileSize?: number);
-
-    updateLightsTexture(): void;
-
-    getBlock(block?: number): Node<"ivec4">;
-
-    setSize(width: number, height: number): this;
-}
-
-export default TiledLightsNode;
-
-export const tiledLights: (maxLights?: number, tileSize?: number) => TiledLightsNode;

three/src/nodes/accessors/BatchNode.d.ts

@@ -1,12 +0,0 @@
-import { BatchedMesh } from "../../objects/BatchedMesh.js";
-import Node from "../core/Node.js";
-
-export default class BatchNode extends Node {
-    batchMesh: BatchedMesh;
-
-    batchingIdNode: Node | null;
-
-    constructor(batchMesh: BatchedMesh);
-}
-
-export const batch: (batchMesh: BatchedMesh) => BatchNode;

three/src/nodes/accessors/InstanceNode.d.ts

@@ -1,30 +0,0 @@
-import { InstancedBufferAttribute } from "../../core/InstancedBufferAttribute.js";
-import { InstancedInterleavedBuffer } from "../../core/InstancedInterleavedBuffer.js";
-import StorageInstancedBufferAttribute from "../../renderers/common/StorageInstancedBufferAttribute.js";
-import Node from "../core/Node.js";
-
-export default class InstanceNode extends Node {
-    count: number;
-    instanceMatrix: InstancedBufferAttribute | StorageInstancedBufferAttribute;
-    instanceColor: InstancedBufferAttribute | StorageInstancedBufferAttribute | null;
-
-    instanceMatrixNode: Node | null;
-    instanceColorNode: Node | null;
-
-    buffer: InstancedInterleavedBuffer | null;
-    bufferColor: InstancedBufferAttribute | null;
-
-    previousInstancedMatrixNode: Node | null;
-
-    constructor(
-        count: number,
-        instanceMatrix: InstancedBufferAttribute | StorageInstancedBufferAttribute,
-        instanceColor?: InstancedBufferAttribute | StorageInstancedBufferAttribute | null,
-    );
-}
-
-export const instance: (
-    count: number,
-    instanceMatrix: InstancedBufferAttribute | StorageInstancedBufferAttribute,
-    instanceColor?: InstancedBufferAttribute | StorageInstancedBufferAttribute | null,
-) => InstanceNode;

three/src/nodes/accessors/InstancedMeshNode.d.ts

@@ -1,10 +0,0 @@
-import { InstancedMesh } from "../../objects/InstancedMesh.js";
-import InstanceNode from "./InstanceNode.js";
-
-declare class InstancedMeshNode extends InstanceNode {
-    constructor(instanceMesh: InstancedMesh);
-}
-
-export default InstancedMeshNode;
-
-export const instancedMesh: (instancedMesh: InstancedMesh) => InstancedMeshNode;

three/src/nodes/accessors/MorphNode.d.ts

@@ -1,14 +0,0 @@
-import { Mesh } from "../../objects/Mesh.js";
-import Node from "../core/Node.js";
-import UniformNode from "../core/UniformNode.js";
-
-declare class MorphNode extends Node {
-    mesh: Mesh;
-    morphBaseInfluence: UniformNode<"float", number>;
-
-    constructor(mesh: Mesh);
-}
-
-export default MorphNode;
-
-export const morphReference: (mesh: Mesh) => MorphNode;

three/src/nodes/accessors/SkinningNode.d.ts

@@ -1,32 +0,0 @@
-import { SkinnedMesh } from "../../objects/SkinnedMesh.js";
-import Node from "../core/Node.js";
-import NodeBuilder from "../core/NodeBuilder.js";
-
-export default class SkinningNode extends Node {
-    skinnedMesh: SkinnedMesh;
-
-    skinIndexNode: Node;
-    skinWeightNode: Node;
-
-    bindMatrixNode: Node;
-    bindMatrixInverseNode: Node;
-    boneMatricesNode: Node;
-    positionNode: Node;
-    toPositionNode: Node;
-    previousBoneMatricesNode: Node | null;
-
-    constructor(skinnedMesh: SkinnedMesh);
-
-    getSkinnedPosition(boneMatrices?: Node, position?: Node): Node;
-
-    getSkinnedNormalAndTangent(
-        boneMatrices?: Node,
-        normal?: Node,
-        tangent?: Node,
-    ): { skinNormal: Node; skinTangent: Node };
-
-    getPreviousSkinnedPosition(builder: NodeBuilder): Node;
-}
-
-export const skinning: (skinnedMesh: SkinnedMesh) => SkinningNode;
-export const computeSkinning: (skinnedMesh: SkinnedMesh, toPosition?: Node | null) => SkinningNode;

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

@@ -1,102 +0,0 @@
-import Info from "./Info.js";
-import NodeManager from "./nodes/NodeManager.js";
-import Renderer from "./Renderer.js";
-
-export interface AnimationContext {
-    requestAnimationFrame(callback: FrameRequestCallback, xrFrame?: XRFrame): number;
-    cancelAnimationFrame(handle: number): void;
-}
-
-/**
- * This module manages the internal animation loop of the renderer.
- *
- * @private
- */
-declare class Animation {
-    /**
-     * Constructs a new animation loop management component.
-     *
-     * @param {Renderer} renderer - A reference to the main renderer.
-     * @param {NodeManager} nodes - Renderer component for managing nodes related logic.
-     * @param {Info} info - Renderer component for managing metrics and monitoring data.
-     */
-    constructor(renderer: Renderer, nodes: NodeManager, info: Info);
-    /**
-     * A reference to the main renderer.
-     *
-     * @type {Renderer}
-     */
-    renderer: Renderer;
-    /**
-     * Renderer component for managing nodes related logic.
-     *
-     * @type {NodeManager}
-     */
-    nodes: NodeManager;
-    /**
-     * Renderer component for managing metrics and monitoring data.
-     *
-     * @type {Info}
-     */
-    info: Info;
-    /**
-     * A reference to the context from `requestAnimationFrame()` can
-     * be called (usually `window`).
-     *
-     * @type {?(Window|XRSession)}
-     */
-    _context: AnimationContext | null;
-    /**
-     * The user-defined animation loop.
-     *
-     * @type {?Function}
-     * @default null
-     */
-    _animationLoop: ((time: DOMHighResTimeStamp, xrFrame?: XRFrame) => void) | null;
-    /**
-     * The requestId which is returned from the `requestAnimationFrame()` call.
-     * Can be used to cancel the stop the animation loop.
-     *
-     * @type {?number}
-     * @default null
-     */
-    _requestId: number | null;
-    /**
-     * Starts the internal animation loop.
-     */
-    start(): void;
-    /**
-     * Stops the internal animation loop.
-     */
-    stop(): void;
-    /**
-     * Returns the user-level animation loop.
-     *
-     * @return {?Function} The animation loop.
-     */
-    getAnimationLoop(): ((time: DOMHighResTimeStamp, xrFrame?: XRFrame) => void) | null;
-    /**
-     * Defines the user-level animation loop.
-     *
-     * @param {?Function} callback - The animation loop.
-     */
-    setAnimationLoop(callback: ((time: DOMHighResTimeStamp, xrFrame?: XRFrame) => void) | null): void;
-    /**
-     * Returns the animation context.
-     *
-     * @return {Window|XRSession} The animation context.
-     */
-    getContext(): AnimationContext;
-    /**
-     * Defines the context in which `requestAnimationFrame()` is executed.
-     *
-     * @param {Window|XRSession} context - The context to set.
-     */
-    setContext(context: AnimationContext): void;
-    /**
-     * Frees all internal resources and stops the animation loop.
-     */
-    dispose(): void;
-}
-
-export default Animation;

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

@@ -1,59 +0,0 @@
-import { BufferAttribute } from "../../core/BufferAttribute.js";
-import { InterleavedBuffer } from "../../core/InterleavedBuffer.js";
-import { InterleavedBufferAttribute } from "../../core/InterleavedBufferAttribute.js";
-import Backend from "./Backend.js";
-import DataMap from "./DataMap.js";
-import Info from "./Info.js";
-
-/**
- * This renderer module manages geometry attributes.
- *
- * @private
- * @augments DataMap
- */
-declare class Attributes extends DataMap {
-    /**
-     * Constructs a new attribute management component.
-     *
-     * @param {Backend} backend - The renderer's backend.
-     * @param {Info} info - Renderer component for managing metrics and monitoring data.
-     */
-    constructor(backend: Backend, info: Info);
-    /**
-     * The renderer's backend.
-     *
-     * @type {Backend}
-     */
-    backend: Backend;
-    /**
-     * Renderer component for managing metrics and monitoring data.
-     *
-     * @type {Info}
-     */
-    info: Info;
-    /**
-     * Deletes the data for the given attribute.
-     *
-     * @param {BufferAttribute} attribute - The attribute.
-     * @return {?Object} The deleted attribute data.
-     */
-    delete(attribute: BufferAttribute | InterleavedBufferAttribute): unknown;
-    /**
-     * Updates the given attribute. This method creates attribute buffers
-     * for new attributes and updates data for existing ones.
-     *
-     * @param {BufferAttribute} attribute - The attribute to update.
-     * @param {number} type - The attribute type.
-     */
-    update(attribute: BufferAttribute | InterleavedBufferAttribute, type: number): void;
-    /**
-     * Utility method for handling interleaved buffer attributes correctly.
-     * To process them, their `InterleavedBuffer` is returned.
-     *
-     * @param {BufferAttribute} attribute - The attribute.
-     * @return {BufferAttribute|InterleavedBuffer}
-     */
-    _getBufferAttribute(attribute: BufferAttribute | InterleavedBufferAttribute): BufferAttribute | InterleavedBuffer;
-}
-
-export default Attributes;

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

@@ -1,47 +0,0 @@
-import { Scene } from "../../scenes/Scene.js";
-import DataMap from "./DataMap.js";
-import NodeManager from "./nodes/NodeManager.js";
-import RenderContext from "./RenderContext.js";
-import Renderer from "./Renderer.js";
-import RenderList from "./RenderList.js";
-
-/**
- * This renderer module manages the background.
- *
- * @private
- * @augments DataMap
- */
-declare class Background extends DataMap {
-    /**
-     * Constructs a new background management component.
-     *
-     * @param {Renderer} renderer - The renderer.
-     * @param {NodeManager} nodes - Renderer component for managing nodes related logic.
-     */
-    constructor(renderer: Renderer, nodes: NodeManager);
-    /**
-     * The renderer.
-     *
-     * @type {Renderer}
-     */
-    renderer: Renderer;
-    /**
-     * Renderer component for managing nodes related logic.
-     *
-     * @type {NodeManager}
-     */
-    nodes: NodeManager;
-    /**
-     * Updates the background for the given scene. Depending on how `Scene.background`
-     * or `Scene.backgroundNode` are configured, this method might configure a simple clear
-     * or add a mesh to the render list for rendering the background as a textured plane
-     * or skybox.
-     *
-     * @param {Scene} scene - The scene.
-     * @param {RenderList} renderList - The current render list.
-     * @param {RenderContext} renderContext - The current render context.
-     */
-    update(scene: Scene, renderList: RenderList, renderContext: RenderContext): void;
-}
-
-export default Background;

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

@@ -1,39 +0,0 @@
-import Binding from "./Binding.js";
-
-/**
- * A bind group represents a collection of bindings and thus a collection
- * or resources. Bind groups are assigned to pipelines to provide them
- * with the required resources (like uniform buffers or textures).
- *
- * @private
- */
-declare class BindGroup {
-    /**
-     * Constructs a new bind group.
-     *
-     * @param {string} name - The bind group's name.
-     * @param {Array<Binding>} bindings - An array of bindings.
-     * @param {number} index - The group index.
-     */
-    constructor(name?: string, bindings?: Binding[], index?: number);
-    /**
-     * The bind group's name.
-     *
-     * @type {string}
-     */
-    name: string;
-    /**
-     * An array of bindings.
-     *
-     * @type {Array<Binding>}
-     */
-    bindings: Binding[];
-    /**
-     * The group's ID.
-     *
-     * @type {number}
-     */
-    id: number;
-}
-
-export default BindGroup;

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

@@ -1,50 +0,0 @@
-/**
- * A binding represents the connection between a resource (like a texture, sampler
- * or uniform buffer) and the resource definition in a shader stage.
- *
- * This module is an abstract base class for all concrete bindings types.
- *
- * @abstract
- * @private
- */
-declare class Binding {
-    /**
-     * Constructs a new binding.
-     *
-     * @param {string} [name=''] - The binding's name.
-     */
-    constructor(name?: string);
-    /**
-     * The binding's name.
-     *
-     * @type {string}
-     */
-    name: string;
-    /**
-     * A bitmask that defines in what shader stages the
-     * binding's resource is accessible.
-     *
-     * @type {number}
-     */
-    visibility: number;
-    /**
-     * Makes sure binding's resource is visible for the given shader stage.
-     *
-     * @param {number} visibility - The shader stage.
-     */
-    setVisibility(visibility: number): void;
-    /**
-     * The shader stages in which the binding's resource is visible.
-     *
-     * @return {number} The visibility bitmask.
-     */
-    getVisibility(): number;
-    /**
-     * Clones the binding.
-     *
-     * @return {Binding} The cloned binding.
-     */
-    clone(): Binding;
-}
-
-export default Binding;