@types/three 0.165.0 → 0.167.0

three/src/textures/CompressedArrayTexture.d.ts

@@ -1,5 +1,5 @@
 import { CompressedPixelFormat, TextureDataType, Wrapping } from "../constants.js";
-import { CompressedTexture } from "./CompressedTexture.js";
+import { CompressedTexture, CompressedTextureMipmap } from "./CompressedTexture.js";
 
 /**
  * Creates an texture 2D array based on data in compressed form, for example from a
@@ -37,8 +37,8 @@ export class CompressedArrayTexture extends CompressedTexture {
 
     /**
      * Create a new instance of {@link CompressedArrayTexture}
-     * @param mipmaps The mipmaps array should contain objects with data, width and height.
-     * The mipmaps should be of the correct {@link format} and {@link type}. See {@link THREE.mipmaps}.
+     * @param mipmaps The mipmaps array should contain objects with data, width and height. The mipmaps should be of the
+     * correct format and type.
      * @param width The width of the biggest mipmap.
      * @param height The height of the biggest mipmap.
      * @param depth The number of layers of the 2D array texture
@@ -46,7 +46,7 @@ export class CompressedArrayTexture extends CompressedTexture {
      * @param type See {@link Texture.type | .type}. Default {@link THREE.UnsignedByteType}
      */
     constructor(
-        mipmaps: ImageData[],
+        mipmaps: CompressedTextureMipmap[],
         width: number,
         height: number,
         depth: number,

three/src/textures/CompressedTexture.d.ts

@@ -7,8 +7,15 @@ import {
     TextureDataType,
     Wrapping,
 } from "../constants.js";
+import { TypedArray } from "../core/BufferAttribute.js";
 import { Texture } from "./Texture.js";
 
+export interface CompressedTextureMipmap {
+    data: TypedArray;
+    width: number;
+    height: number;
+}
+
 /**
  * Creates a texture based on data in compressed form, for example from a {@link https://en.wikipedia.org/wiki/DirectDraw_Surface | DDS} file.
  * @remarks For use with the {@link THREE.CompressedTextureLoader | CompressedTextureLoader}.
@@ -18,8 +25,8 @@ import { Texture } from "./Texture.js";
 export class CompressedTexture extends Texture {
     /**
      * This creates a new {@link THREE.CompressedTexture | CompressedTexture} object.
-     * @param mipmaps The mipmaps array should contain objects with data, width and height.
-     * The mipmaps should be of the correct {@link format} and {@link type}. See {@link THREE.mipmaps}.
+     * @param mipmaps The mipmaps array should contain objects with data, width and height. The mipmaps should be of the
+     * correct format and type.
      * @param width The width of the biggest mipmap.
      * @param height The height of the biggest mipmap.
      * @param format The format used in the mipmaps. See {@link THREE.CompressedPixelFormat}.
@@ -33,10 +40,10 @@ export class CompressedTexture extends Texture {
      * @param colorSpace See {@link Texture.colorSpace .colorSpace}. Default {@link NoColorSpace}
      */
     constructor(
-        mipmaps: ImageData[],
-        width: number,
-        height: number,
-        format: CompressedPixelFormat,
+        mipmaps?: CompressedTextureMipmap[],
+        width?: number,
+        height?: number,
+        format?: CompressedPixelFormat,
         type?: TextureDataType,
         mapping?: Mapping,
         wrapS?: Wrapping,
@@ -62,9 +69,10 @@ export class CompressedTexture extends Texture {
     set image(value: { width: number; height: number });
 
     /**
-     *  The mipmaps array should contain objects with data, width and height. The mipmaps should be of the correct {@link format} and {@link type}.
+     *  The mipmaps array should contain objects with data, width and height. The mipmaps should be of the correct
+     *  format and type.
      */
-    mipmaps: ImageData[];
+    mipmaps: CompressedTextureMipmap[] | undefined;
 
     /**
      * @override

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

@@ -13,8 +13,46 @@ import {
 import { EventDispatcher } from "../core/EventDispatcher.js";
 import { Matrix3 } from "../math/Matrix3.js";
 import { Vector2 } from "../math/Vector2.js";
+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 {}
@@ -127,7 +165,7 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
      * Array of user-specified mipmaps
      * @defaultValue `[]`
      */
-    mipmaps: any[]; // ImageData[] for 2D textures and CubeTexture[] for cube textures;
+    mipmaps: CompressedTextureMipmap[] | CubeTexture[] | HTMLCanvasElement[] | undefined;
 
     /**
      * How the image is applied to the object.
@@ -429,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>;
-
-    getDepthNode(): 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/materials/MeshSSSNodeMaterial.d.ts

@@ -1,17 +0,0 @@
-import ConstNode from "../core/ConstNode.js";
-import Node from "../core/Node.js";
-import { ShaderNodeObject } from "../shadernode/ShaderNode.js";
-import MeshPhysicalNodeMaterial, { MeshPhysicalNodeMaterialParameters } from "./MeshPhysicalNodeMaterial.js";
-
-export default class MeshSSSNodeMaterial extends MeshPhysicalNodeMaterial {
-    thicknessColorNode: ShaderNodeObject<Node> | null;
-    thicknessDistortionNode: ShaderNodeObject<ConstNode<number>>;
-    thicknessAmbientNode: ShaderNodeObject<ConstNode<number>>;
-    thicknessAttenuationNode: ShaderNodeObject<ConstNode<number>>;
-    thicknessPowerNode: ShaderNodeObject<ConstNode<number>>;
-    thicknessScaleNode: ShaderNodeObject<ConstNode<number>>;
-
-    constructor(parameters?: MeshPhysicalNodeMaterialParameters);
-
-    get useSSS(): boolean;
-}