@types/three 0.175.0 → 0.177.0

three/src/textures/Source.d.ts

@@ -1,3 +1,5 @@
+import { Vector3 } from "../math/Vector3.js";
+
 export type SerializedImage =
     | string
     | {
@@ -18,12 +20,6 @@ export class SourceJSON {
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/textures/Source.js | Source}
  */
 export class Source {
-    /**
-     * Create a new instance of {@link Source}
-     * @param data The data definition of a texture. Default `null`
-     */
-    constructor(data: any);
-
     /**
      * Flag to check if a given object is of type {@link Source}.
      * @remarks This is a _constant_ value
@@ -33,6 +29,12 @@ export class Source {
 
     readonly id: number;
 
+    /**
+     * {@link http://en.wikipedia.org/wiki/Universally_unique_identifier | UUID} of this object instance.
+     * @remarks This gets automatically assigned and shouldn't be edited.
+     */
+    uuid: string;
+
     /**
      * The actual data of a texture.
      * @remarks The type of this property depends on the texture that uses this instance.
@@ -49,23 +51,25 @@ export class Source {
     dataReady: boolean;
 
     /**
-     * When the property is set to `true`, the engine allocates the memory for the texture (if necessary) and triggers
-     * the actual texture upload to the GPU next time the source is used.
+     * This starts at `0` and counts how many times {@link needsUpdate | .needsUpdate} is set to `true`.
+     * @remarks Expects a `Integer`
+     * @defaultValue `0`
      */
-    set needsUpdate(value: boolean);
+    version: number;
 
     /**
-     * {@link http://en.wikipedia.org/wiki/Universally_unique_identifier | UUID} of this object instance.
-     * @remarks This gets automatically assigned and shouldn't be edited.
+     * Create a new instance of {@link Source}
+     * @param data The data definition of a texture. Default `null`
      */
-    uuid: string;
+    constructor(data: any);
+
+    getSize(target: Vector3): Vector3;
 
     /**
-     * This starts at `0` and counts how many times {@link needsUpdate | .needsUpdate} is set to `true`.
-     * @remarks Expects a `Integer`
-     * @defaultValue `0`
+     * When the property is set to `true`, the engine allocates the memory for the texture (if necessary) and triggers
+     * the actual texture upload to the GPU next time the source is used.
      */
-    version: number;
+    set needsUpdate(value: boolean);
 
     /**
      * 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}.

three/src/textures/Texture.d.ts

@@ -1,6 +1,7 @@
 import {
     AnyMapping,
     AnyPixelFormat,
+    ColorSpace,
     MagnificationTextureFilter,
     Mapping,
     MinificationTextureFilter,
@@ -17,6 +18,32 @@ import { CompressedTextureMipmap } from "./CompressedTexture.js";
 import { CubeTexture } from "./CubeTexture.js";
 import { Source } from "./Source.js";
 
+// NOTE: DOM upload fields are not implemented where parameters are accepted.
+export interface TextureParameters {
+    mapping?: AnyMapping | undefined;
+    // image?: TexImageSource | OffscreenCanvas | undefined;
+    // channel?: number | undefined;
+
+    wrapS?: Wrapping | undefined;
+    wrapT?: Wrapping | undefined;
+    wrapR?: Wrapping | undefined;
+
+    format?: PixelFormat | undefined;
+    internalFormat?: PixelFormatGPU | null | undefined;
+    type?: TextureDataType | undefined;
+    colorSpace?: ColorSpace | undefined;
+
+    magFilter?: MagnificationTextureFilter | undefined;
+    minFilter?: MinificationTextureFilter | undefined;
+    anisotropy?: number | undefined;
+
+    flipY?: boolean | undefined;
+
+    generateMipmaps?: boolean | undefined;
+    // premultiplyAlpha?: boolean | undefined;
+    // unpackAlignment?: number | undefined;
+}
+
 export interface TextureJSON {
     metadata: { version: number; type: string; generator: string };
 
@@ -99,7 +126,7 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
         format?: PixelFormat,
         type?: TextureDataType,
         anisotropy?: number,
-        colorSpace?: string,
+        colorSpace?: ColorSpace,
     );
 
     /**
@@ -151,6 +178,21 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
      */
     source: Source;
 
+    /**
+     * The width of the texture in pixels.
+     */
+    get width(): number;
+
+    /**
+     * The height of the texture in pixels.
+     */
+    get height(): number;
+
+    /**
+     * The depth of the texture in pixels.
+     */
+    get depth(): number;
+
     /**
      * An image object, typically created using the {@link THREE.TextureLoader.load | TextureLoader.load()} method.
      * @remarks This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.
@@ -377,6 +419,13 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
      */
     isRenderTargetTexture: boolean;
 
+    /**
+     * Indicates if a texture should be handled like a texture array.
+     *
+     * @default false
+     */
+    isArrayTexture: boolean;
+
     /**
      * An object that can be used to store custom data about the texture.
      * @remarks It should not hold references to functions as these will not be cloned.
@@ -384,6 +433,12 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
      */
     userData: Record<string, any>;
 
+    /**
+     * This can be used to only update a subregion or specific rows of the texture (for example, just the
+     * first 3 rows). Use the `addUpdateRange()` function to add ranges to this array.
+     */
+    updateRanges: Array<{ start: number; count: number }>;
+
     /**
      * This starts at `0` and counts how many times {@link needsUpdate | .needsUpdate} is set to `true`.
      * @remarks Expects a `Integer`
@@ -432,7 +487,7 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
     /**
      * A callback function, called when the texture is updated _(e.g., when needsUpdate has been set to true and then the texture is used)_.
      */
-    onUpdate: () => void;
+    onUpdate: ((texture: Texture) => void) | null;
 
     /**
      * Transform the **UV** based on the value of this texture's
@@ -454,6 +509,19 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
      */
     updateMatrix(): void;
 
+    /**
+     * Adds a range of data in the data texture to be updated on the GPU.
+     *
+     * @param {number} start - Position at which to start update.
+     * @param {number} count - The number of components to update.
+     */
+    addUpdateRange(start: number, count: number): void;
+
+    /**
+     * Clears the update ranges.
+     */
+    clearUpdateRanges(): void;
+
     /**
      * 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.
@@ -462,6 +530,12 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
 
     copy(source: Texture): this;
 
+    /**
+     * Sets this texture's properties based on `values`.
+     * @param values - A container with texture parameters.
+     */
+    setValues(values: TextureParameters): void;
+
     /**
      * 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.

three/src/textures/VideoFrameTexture.d.ts

@@ -21,7 +21,7 @@ declare class VideoFrameTexture extends VideoTexture {
     );
 
     // FIXME Replace with VideoFrame when we no longer need to support TypeScript 5.0
-    setFrame(frane: unknown): void;
+    setFrame(frame: unknown): void;
 }
 
 export { VideoFrameTexture };

three/examples/jsm/effects/PeppersGhostEffect.d.ts

@@ -1,10 +0,0 @@
-import { Camera, Scene, WebGLRenderer } from "three";
-
-export class PeppersGhostEffect {
-    constructor(renderer: WebGLRenderer);
-    cameraDistance: number;
-    reflectFromAbove: boolean;
-
-    render(scene: Scene, camera: Camera): void;
-    setSize(width: number, height: number): void;
-}

three/src/core/RenderTargetArray.d.ts

@@ -1,9 +0,0 @@
-import { RenderTarget, RenderTargetOptions } from "./RenderTarget.js";
-
-declare class RenderTargetArray extends RenderTarget {
-    readonly isRenderTargetArray: true;
-
-    constructor(width?: number, height?: number, depth?: number, options?: RenderTargetOptions);
-}
-
-export { RenderTargetArray };