@types/three 0.166.0 → 0.167.0

three/{examples/jsm → src}/renderers/webgpu/nodes/WGSLNodeBuilder.d.ts

@@ -1,10 +1,11 @@
-import { Texture } from "three";
+import CodeNode from "../../../nodes/code/CodeNode.js";
 import { NodeShaderStage } from "../../../nodes/core/constants.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/shadernode/ShaderNode.js";
+import { Texture } from "../../../textures/Texture.js";
 import NodeUniformsGroup from "../../common/nodes/NodeUniformsGroup.js";
 
 type BuiltinStage = NodeShaderStage | "attribute" | "output";
@@ -18,7 +19,7 @@ export default class WGSLNodeBuilder extends NodeBuilder {
     builtins: { [key in BuiltinStage]: Map<string, BuiltinType> };
     uniformGroups: { [key in NodeShaderStage]: NodeUniformsGroup };
 
-    needsColorSpaceToLinear(texture: Texture);
+    needsColorSpaceToLinear(texture: Texture): boolean;
     _generateTextureSample(
         texture: Texture,
         textureProperty: string,
@@ -93,6 +94,7 @@ export default class WGSLNodeBuilder extends NodeBuilder {
     getBuiltin(name: string, property: string, type: string, shaderStage: BuiltinStage): string;
     getVertexIndex(): string;
     getInstanceIndex(): string;
+    getDrawIndex(): null;
 
     buildFunctionCode(shaderNode: ShaderNode): string;
 
@@ -113,8 +115,8 @@ export default class WGSLNodeBuilder extends NodeBuilder {
     buildCode(): void;
     getMethod(method: string, output?: string | null): string;
 
-    _getWGSLMethod(method: string);
-    // _include(name: string): CodeNode
+    _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;

three/src/scenes/Fog.d.ts

@@ -1,28 +1,11 @@
 import { Color, ColorRepresentation } from "../math/Color.js";
 
-export interface FogBase {
-    /**
-     * Optional name of the `Fog` object
-     * @remarks _(doesn't need to be unique)_.
-     * @defaultValue `""`
-     */
+export interface FogJSON {
+    type: string;
     name: string;
-
-    /**
-     * Fog color.
-     * @remarks If set to black, far away objects will be rendered black.
-     */
-    color: Color;
-
-    /**
-     * Returns a new Fog instance with the same parameters as this one.
-     */
-    clone(): FogBase;
-
-    /**
-     * Return Fog data in JSON format.
-     */
-    toJSON(): any;
+    color: number;
+    near: number;
+    far: number;
 }
 
 /**
@@ -35,7 +18,7 @@ export interface FogBase {
  * @see {@link https://threejs.org/docs/index.html#api/en/scenes/Fog | Official Documentation}
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/scenes/Fog.js | Source}
  */
-export class Fog implements FogBase {
+export class Fog {
     /**
      * The color parameter is passed to the {@link THREE.Color | Color} constructor to set the color property
      * @remarks
@@ -90,5 +73,5 @@ export class Fog implements FogBase {
     /**
      * Return {@link Fog} data in JSON format.
      */
-    toJSON(): any;
+    toJSON(): FogJSON;
 }

three/src/scenes/FogExp2.d.ts

@@ -1,5 +1,11 @@
 import { Color, ColorRepresentation } from "../math/Color.js";
-import { FogBase } from "./Fog.js";
+
+export interface FogExp2JSON {
+    type: string;
+    name: string;
+    color: number;
+    density: number;
+}
 
 /**
  * This class contains the parameters that define exponential squared fog, which gives a clear view near the camera and a faster than exponentially densening fog farther from the camera.
@@ -12,7 +18,7 @@ import { FogBase } from "./Fog.js";
  * @see {@link https://threejs.org/docs/index.html#api/en/scenes/FogExp2 | Official Documentation}
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/scenes/FogExp2.js | Source}
  */
-export class FogExp2 implements FogBase {
+export class FogExp2 {
     /**
      * The color parameter is passed to the {@link THREE.Color | Color} constructor to set the color property
      * @remarks Color can be a hexadecimal integer or a CSS-style string.
@@ -56,5 +62,5 @@ export class FogExp2 implements FogBase {
     /**
      * Return {@link FogExp2} data in JSON format.
      */
-    toJSON(): any;
+    toJSON(): FogExp2JSON;
 }

three/src/scenes/Scene.d.ts

@@ -1,10 +1,26 @@
-import { Object3D } from "../core/Object3D.js";
+import { JSONMeta, Object3D, Object3DJSON, Object3DJSONObject } from "../core/Object3D.js";
 import { Material } from "../materials/Material.js";
 import { Color } from "../math/Color.js";
-import { Euler } from "../math/Euler.js";
+import { Euler, EulerTuple } from "../math/Euler.js";
 import { CubeTexture } from "../textures/CubeTexture.js";
 import { Texture } from "../textures/Texture.js";
-import { FogBase } from "./Fog.js";
+import { Fog, FogJSON } from "./Fog.js";
+import { FogExp2, FogExp2JSON } from "./FogExp2.js";
+
+export interface SceneJSONObject extends Object3DJSONObject {
+    fog?: FogJSON | FogExp2JSON;
+
+    backgroundBlurriness?: number;
+    backgroundIntensity?: number;
+    backgroundRotation: EulerTuple;
+
+    environmentIntensity?: number;
+    environmentRotation: EulerTuple;
+}
+
+export interface SceneJSON extends Object3DJSON {
+    object: SceneJSONObject;
+}
 
 /**
  * Scenes allow you to set up what and where is to be rendered by three.js
@@ -37,7 +53,7 @@ export class Scene extends Object3D {
      * A {@link Fog | fog} instance defining the type of fog that affects everything rendered in the scene.
      * @defaultValue `null`
      */
-    fog: FogBase | null;
+    fog: Fog | FogExp2 | null;
 
     /**
      * Sets the blurriness of the background. Only influences environment maps assigned to {@link THREE.Scene.background | Scene.background}.
@@ -98,5 +114,5 @@ export class Scene extends Object3D {
      * Convert the {@link Scene} to three.js {@link https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 | JSON Object/Scene format}.
      * @param meta Object containing metadata such as textures or images for the scene.
      */
-    toJSON(meta?: any): any;
+    toJSON(meta?: JSONMeta): SceneJSON;
 }

three/src/textures/Source.d.ts

@@ -1,3 +1,17 @@
+export type SerializedImage =
+    | string
+    | {
+        data: number[];
+        width: number;
+        height: number;
+        type: string;
+    };
+
+export class SourceJSON {
+    uuid: string;
+    url: SerializedImage | SerializedImage[];
+}
+
 /**
  * Represents the data {@link Source} of a texture.
  * @see {@link https://threejs.org/docs/index.html#api/en/textures/Source | Official Documentation}
@@ -57,5 +71,5 @@ export class Source {
      * Convert the data {@link Source} to three.js {@link https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 | JSON Object/Scene format}.
      * @param meta Optional object containing metadata.
      */
-    toJSON(meta?: string | {}): {};
+    toJSON(meta?: string | {}): SourceJSON;
 }

three/src/textures/Texture.d.ts

@@ -17,6 +17,42 @@ import { CompressedTextureMipmap } from "./CompressedTexture.js";
 import { CubeTexture } from "./CubeTexture.js";
 import { Source } from "./Source.js";
 
+export interface TextureJSON {
+    metadata: { version: number; type: string; generator: string };
+
+    uuid: string;
+    name: string;
+
+    image: string;
+
+    mapping: AnyMapping;
+    channel: number;
+
+    repeat: [x: number, y: number];
+    offset: [x: number, y: number];
+    center: [x: number, y: number];
+    rotation: number;
+
+    wrap: [wrapS: number, wrapT: number];
+
+    format: AnyPixelFormat;
+    internalFormat: PixelFormatGPU | null;
+    type: TextureDataType;
+    colorSpace: ColorSpace;
+
+    minFilter: MinificationTextureFilter;
+    magFilter: MagnificationTextureFilter;
+    anisotropy: number;
+
+    flipY: boolean;
+
+    generateMipmaps: boolean;
+    premultiplyAlpha: boolean;
+    unpackAlignment: number;
+
+    userData?: Record<string, unknown>;
+}
+
 /** Shim for OffscreenCanvas. */
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface OffscreenCanvas extends EventTarget {}
@@ -431,7 +467,7 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
      * Convert the texture to three.js {@link https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 | JSON Object/Scene format}.
      * @param meta Optional object containing metadata.
      */
-    toJSON(meta?: string | {}): {};
+    toJSON(meta?: string | {}): TextureJSON;
 
     /**
      * Frees the GPU-related resources allocated by this instance

three/examples/jsm/deprecated/Geometry.d.ts

@@ -1,341 +0,0 @@
-import {
-    AnimationClip,
-    Bone,
-    Box3,
-    BufferGeometry,
-    Color,
-    EventDispatcher,
-    Matrix,
-    Matrix4,
-    Mesh,
-    Object3D,
-    Sphere,
-    Vector2,
-    Vector3,
-    Vector4,
-} from "three";
-
-/**
- * @deprecated Use Face3 instead.
- */
-
-export interface MorphTarget {
-    name: string;
-    vertices: Vector3[];
-}
-
-export interface MorphColor {
-    name: string;
-    colors: Color[];
-}
-
-export interface MorphNormals {
-    name: string;
-    normals: Vector3[];
-}
-
-/**
- * Base class for geometries
- */
-export class Geometry extends EventDispatcher {
-    constructor();
-
-    /**
-     * Unique number of this geometry instance
-     */
-    id: number;
-
-    uuid: string;
-
-    readonly isGeometry: true;
-
-    /**
-     * Name for this geometry. Default is an empty string.
-     * @default ''
-     */
-    name: string;
-
-    /**
-     * @default 'Geometry'
-     */
-    type: string;
-
-    /**
-     * The array of vertices hold every position of points of the model.
-     * To signal an update in this array, Geometry.verticesNeedUpdate needs to be set to true.
-     * @default []
-     */
-    vertices: Vector3[];
-
-    /**
-     * Array of vertex colors, matching number and order of vertices.
-     * Used in ParticleSystem, Line and Ribbon.
-     * Meshes use per-face-use-of-vertex colors embedded directly in faces.
-     * To signal an update in this array, Geometry.colorsNeedUpdate needs to be set to true.
-     * @default []
-     */
-    colors: Color[];
-
-    /**
-     * Array of triangles or/and quads.
-     * The array of faces describe how each vertex in the model is connected with each other.
-     * To signal an update in this array, Geometry.elementsNeedUpdate needs to be set to true.
-     * @default []
-     */
-    faces: Face3[];
-
-    /**
-     * Array of face UV layers.
-     * Each UV layer is an array of UV matching order and number of vertices in faces.
-     * To signal an update in this array, Geometry.uvsNeedUpdate needs to be set to true.
-     * @default [[]]
-     */
-    faceVertexUvs: Vector2[][][];
-
-    /**
-     * Array of morph targets. Each morph target is a Javascript object:
-     *
-     * { name: "targetName", vertices: [ new THREE.Vector3(), ... ] }
-     *
-     * Morph vertices match number and order of primary vertices.
-     * @default []
-     */
-    morphTargets: MorphTarget[];
-
-    /**
-     * Array of morph normals. Morph normals have similar structure as morph targets, each normal set is a Javascript object:
-     *
-     * morphNormal = { name: "NormalName", normals: [ new THREE.Vector3(), ... ] }
-     * @default []
-     */
-    morphNormals: MorphNormals[];
-
-    /**
-     * Array of skinning weights, matching number and order of vertices.
-     * @default []
-     */
-    skinWeights: Vector4[];
-
-    /**
-     * Array of skinning indices, matching number and order of vertices.
-     * @default []
-     */
-    skinIndices: Vector4[];
-
-    /**
-     * @default []
-     */
-    lineDistances: number[];
-
-    /**
-     * Bounding box.
-     * @default null
-     */
-    boundingBox: Box3 | null;
-
-    /**
-     * Bounding sphere.
-     * @default null
-     */
-    boundingSphere: Sphere | null;
-
-    /**
-     * Set to true if the vertices array has been updated.
-     * @default false
-     */
-    verticesNeedUpdate: boolean;
-
-    /**
-     * Set to true if the faces array has been updated.
-     * @default false
-     */
-    elementsNeedUpdate: boolean;
-
-    /**
-     * Set to true if the uvs array has been updated.
-     * @default false
-     */
-    uvsNeedUpdate: boolean;
-
-    /**
-     * Set to true if the normals array has been updated.
-     * @default false
-     */
-    normalsNeedUpdate: boolean;
-
-    /**
-     * Set to true if the colors array has been updated.
-     * @default false
-     */
-    colorsNeedUpdate: boolean;
-
-    /**
-     * Set to true if the linedistances array has been updated.
-     * @default false
-     */
-    lineDistancesNeedUpdate: boolean;
-
-    /**
-     * @default false
-     */
-    groupsNeedUpdate: boolean;
-
-    /**
-     * Bakes matrix transform directly into vertex coordinates.
-     */
-    applyMatrix4(matrix: Matrix4): Geometry;
-
-    rotateX(angle: number): Geometry;
-    rotateY(angle: number): Geometry;
-    rotateZ(angle: number): Geometry;
-
-    translate(x: number, y: number, z: number): Geometry;
-    scale(x: number, y: number, z: number): Geometry;
-    lookAt(vector: Vector3): void;
-
-    fromBufferGeometry(geometry: BufferGeometry): Geometry;
-
-    center(): Geometry;
-
-    normalize(): Geometry;
-
-    /**
-     * Computes face normals.
-     */
-    computeFaceNormals(): void;
-
-    /**
-     * Computes vertex normals by averaging face normals.
-     * Face normals must be existing / computed beforehand.
-     */
-    computeVertexNormals(areaWeighted?: boolean): void;
-
-    /**
-     * Compute vertex normals, but duplicating face normals.
-     */
-    computeFlatVertexNormals(): void;
-
-    /**
-     * Computes morph normals.
-     */
-    computeMorphNormals(): void;
-
-    /**
-     * Computes bounding box of the geometry, updating {@link Geometry.boundingBox} attribute.
-     */
-    computeBoundingBox(): void;
-
-    /**
-     * Computes bounding sphere of the geometry, updating Geometry.boundingSphere attribute.
-     * Neither bounding boxes or bounding spheres are computed by default. They need to be explicitly computed, otherwise they are null.
-     */
-    computeBoundingSphere(): void;
-
-    merge(geometry: Geometry, matrix?: Matrix, materialIndexOffset?: number): void;
-
-    mergeMesh(mesh: Mesh): void;
-
-    /**
-     * Checks for duplicate vertices using hashmap for specified number of decimal points, e.g. 4 for epsilon of 0.0001
-     * Duplicated vertices are removed and faces' vertices are updated.
-     */
-    mergeVertices(precisionPoints?: number): number;
-
-    setFromPoints(points: Vector2[] | Vector3[]): this;
-
-    sortFacesByMaterialIndex(): void;
-
-    toBufferGeometry(): BufferGeometry;
-
-    static createBufferGeometryFromObject(object: Object3D): BufferGeometry;
-
-    toJSON(): any;
-
-    /**
-     * Creates a new clone of the Geometry.
-     */
-    clone(): Geometry;
-
-    copy(source: Geometry): this;
-
-    /**
-     * Removes The object from memory.
-     * Don't forget to call this method when you remove an geometry because it can cuase meomory leaks.
-     */
-    dispose(): void;
-
-    // These properties do not exist in a normal Geometry class, but if you use the instance that was passed by JSONLoader, it will be added.
-    bones: Bone[];
-    animation: AnimationClip;
-    animations: AnimationClip[];
-}
-
-/**
- * Triangle face.
- */
-export class Face3 {
-    /**
-     * @param a Vertex A index.
-     * @param b Vertex B index.
-     * @param c Vertex C index.
-     * @param normal Face normal or array of vertex normals.
-     * @param color Face color or array of vertex colors.
-     * @param materialIndex Material index.
-     */
-    constructor(
-        a: number,
-        b: number,
-        c: number,
-        normal?: Vector3 | Vector3[],
-        color?: Color | Color[],
-        materialIndex?: number,
-    );
-
-    /**
-     * Vertex A index.
-     */
-    a: number;
-
-    /**
-     * Vertex B index.
-     */
-    b: number;
-
-    /**
-     * Vertex C index.
-     */
-    c: number;
-
-    /**
-     * Face normal.
-     * @default new THREE.Vector3()
-     */
-    normal: Vector3;
-
-    /**
-     * Array of 3 vertex normals.
-     * @default []
-     */
-    vertexNormals: Vector3[];
-
-    /**
-     * Face color.
-     * @default new THREE.Color()
-     */
-    color: Color;
-
-    /**
-     * Array of 3 vertex colors.
-     * @default []
-     */
-    vertexColors: Color[];
-
-    /**
-     * Material index (points to {@link Mesh.material}).
-     * @default 0
-     */
-    materialIndex: number;
-
-    clone(): this;
-    copy(source: Face3): this;
-}

three/examples/jsm/lights/IESSpotLight.d.ts

@@ -1,5 +0,0 @@
-import { SpotLight, Texture } from "three";
-
-export default class IESSpotLight extends SpotLight {
-    iesMap: Texture | null;
-}

three/examples/jsm/nodes/display/PassNode.d.ts

@@ -1,46 +0,0 @@
-import { Camera, RenderTarget, Scene, Texture } from "three";
-import TextureNode from "../accessors/TextureNode.js";
-import Node from "../core/Node.js";
-import TempNode from "../core/TempNode.js";
-import { ShaderNodeObject } from "../shadernode/ShaderNode.js";
-
-declare class PassTextureNode extends TextureNode {
-    passNode: PassNode;
-
-    constructor(passNode: PassNode, texture: Texture);
-}
-
-export default class PassNode extends TempNode {
-    scope: PassNodeScope;
-    scene: Scene;
-    camera: Camera;
-
-    renderTarget: RenderTarget;
-
-    readonly isPassNode: true;
-
-    constructor(scope: PassNodeScope, scene: Scene, camera: Camera);
-
-    getTextureNode(): ShaderNodeObject<PassTextureNode>;
-
-    getTextureDepthNode(): ShaderNodeObject<PassTextureNode>;
-
-    getViewZNode(): ShaderNodeObject<Node>;
-
-    getLinearDepthNode(): ShaderNodeObject<Node>;
-
-    setSize(width: number, height: number): void;
-
-    setPixelRatio(pixelRatio: number): void;
-
-    dispose(): void;
-
-    static COLOR: "color";
-    static DEPTH: "depth";
-}
-
-export type PassNodeScope = typeof PassNode.COLOR | typeof PassNode.DEPTH;
-
-export const pass: (scene: Scene, camera: Camera) => ShaderNodeObject<PassNode>;
-export const texturePass: (pass: PassNode, texture: Texture) => ShaderNodeObject<PassTextureNode>;
-export const depthPass: (scene: Scene, camera: Camera) => ShaderNodeObject<PassNode>;

three/examples/jsm/nodes/functions/PhongLightingModel.d.ts

@@ -1,7 +0,0 @@
-import LightingModel from "../core/LightingModel.js";
-
-export default class PhongLightingModel extends LightingModel {
-    specular: boolean;
-
-    constructor(specular?: boolean);
-}

three/examples/jsm/nodes/lighting/RectAreaLightNode.d.ts

@@ -1,10 +0,0 @@
-import { RectAreaLight } from "three";
-import Node from "../core/Node.js";
-import AnalyticLightNode from "./AnalyticLightNode.js";
-
-export default class RectAreaLightNode extends AnalyticLightNode<RectAreaLight> {
-    halfHeight: Node;
-    halfWidth: Node;
-
-    constructor(light?: RectAreaLight | null);
-}