@types/three 0.182.0 → 0.183.1

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

@@ -1,41 +1,11 @@
 import { RenderTarget } from "../../core/RenderTarget.js";
 import { Vector3 } from "../../math/Vector3.js";
-import { DepthTexture } from "../../textures/DepthTexture.js";
 import { Texture } from "../../textures/Texture.js";
 import Backend from "./Backend.js";
 import DataMap from "./DataMap.js";
 import Info from "./Info.js";
 import Renderer from "./Renderer.js";
-type SizeVector3Uninitialized = Vector3 & {
-    width?: number;
-    height?: number;
-    depth?: number;
-};
-type SizeVector3 = Vector3 & {
-    width: number;
-    height: number;
-    depth: number;
-};
-interface RenderTargetData {
-    depthTextureMips?: {
-        [activeMipmapLevel: number]: DepthTexture;
-    };
-    width?: number;
-    height?: number;
-    textures?: Texture[];
-    depthTexture?: DepthTexture;
-    depth?: boolean;
-    stencil?: boolean;
-    renderTarget?: RenderTarget;
-    sampleCount?: number;
-    initialized?: boolean;
-}
-interface TextureData {
-    initialized?: boolean;
-    version?: number;
-    isDefaultTexture?: boolean;
-    generation?: number;
-}
+
 interface TextureOptions {
     width?: number;
     height?: number;
@@ -43,25 +13,14 @@ interface TextureOptions {
     needsMipmaps?: boolean;
     levels?: number;
 }
+
 /**
  * This module manages the textures of the renderer.
  *
  * @private
  * @augments DataMap
  */
-declare class Textures extends DataMap<{
-    renderTarget: {
-        key: RenderTarget;
-        value: RenderTargetData;
-    };
-    texture: {
-        key: Texture;
-        value: TextureData;
-    };
-}> {
-    renderer: Renderer;
-    backend: Backend;
-    info: Info;
+declare class Textures extends DataMap {
     /**
      * Constructs a new texture management component.
      *
@@ -70,6 +29,24 @@ declare class Textures extends DataMap<{
      * @param {Info} info - Renderer component for managing metrics and monitoring data.
      */
     constructor(renderer: Renderer, backend: Backend, info: Info);
+    /**
+     * The renderer.
+     *
+     * @type {Renderer}
+     */
+    renderer: Renderer;
+    /**
+     * The backend.
+     *
+     * @type {Backend}
+     */
+    backend: Backend;
+    /**
+     * Renderer component for managing metrics and monitoring data.
+     *
+     * @type {Info}
+     */
+    info: Info;
     /**
      * Updates the given render target. Based on the given render target configuration,
      * it updates the texture states representing the attachments of the framebuffer.
@@ -99,7 +76,7 @@ declare class Textures extends DataMap<{
      * @param {Texture} texture - The texture to update the sampler for.
      * @return {string} The current sampler key.
      */
-    updateSampler(texture: Texture): void;
+    updateSampler(texture: Texture): string;
     /**
      * Computes the size of the given texture and writes the result
      * into the target vector. This vector is also returned by the
@@ -112,7 +89,7 @@ declare class Textures extends DataMap<{
      * @param {Vector3} target - The target vector.
      * @return {Vector3} The target vector.
      */
-    getSize(texture: Texture, target?: SizeVector3Uninitialized): SizeVector3;
+    getSize(texture: Texture, target?: Vector3): Vector3;
     /**
      * Computes the number of mipmap levels for the given texture.
      *
@@ -144,4 +121,5 @@ declare class Textures extends DataMap<{
      */
     _destroyTexture(texture: Texture): void;
 }
+
 export default Textures;

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

@@ -4,21 +4,74 @@
  * @abstract
  */
 declare abstract class TimestampQueryPool {
+    /**
+     * Creates a new timestamp query pool.
+     *
+     * @param {number} [maxQueries=256] - Maximum number of queries this pool can hold.
+     */
+    constructor(maxQueries?: number);
+    /**
+     * Whether to track timestamps or not.
+     *
+     * @type {boolean}
+     * @default true
+     */
     trackTimestamp: boolean;
+    /**
+     * Maximum number of queries this pool can hold.
+     *
+     * @type {number}
+     * @default 256
+     */
     maxQueries: number;
+    /**
+     * How many queries allocated so far.
+     *
+     * @type {number}
+     * @default 0
+     */
     currentQueryIndex: number;
-    queryOffsets: Map<number, number>;
+    /**
+     * Tracks offsets for different contexts.
+     *
+     * @type {Map<string, number>}
+     */
+    queryOffsets: Map<string, number>;
+    /**
+     * Whether the pool has been disposed or not.
+     *
+     * @type {boolean}
+     * @default false
+     */
     isDisposed: boolean;
+    /**
+     * The total frame duration until the next update.
+     *
+     * @type {number}
+     * @default 0
+     */
     lastValue: number;
+    /**
+     * Stores all timestamp frames.
+     *
+     * @type {Array<number>}
+     */
     frames: number[];
-    pendingResolve: boolean;
-    timestamps: Map<string, number>;
     /**
-     * Creates a new timestamp query pool.
+     * This property is used to avoid multiple concurrent resolve operations.
+     * The WebGL backend uses it as a boolean flag. In context of WebGPU, it holds
+     * the promise of the current resolve operation.
      *
-     * @param {number} [maxQueries=256] - Maximum number of queries this pool can hold.
+     * @type {boolean|Promise<number>}
+     * @default false
      */
-    constructor(maxQueries?: number);
+    pendingResolve: boolean | Promise<number>;
+    /**
+     * Stores the latest timestamp for each render context.
+     *
+     * @type {Map<string, number>}
+     */
+    timestamps: Map<string, number>;
     /**
      * Returns all timestamp frames.
      *
@@ -31,7 +84,7 @@ declare abstract class TimestampQueryPool {
      * @param {string} uid - A unique identifier for the render context.
      * @return {?number} The timestamp, or undefined if not available.
      */
-    getTimestamp(uid: string): number;
+    getTimestamp(uid: string): number | null;
     /**
      * Returns whether a timestamp is available for a given render context.
      *
@@ -55,7 +108,7 @@ declare abstract class TimestampQueryPool {
      * @async
      * @returns {Promise<number>|number} The resolved timestamp value.
      */
-    abstract resolveQueriesAsync(): Promise<number>;
+    abstract resolveQueriesAsync(): Promise<number> | number;
     /**
      * Dispose of the query pool.
      *
@@ -63,4 +116,5 @@ declare abstract class TimestampQueryPool {
      */
     abstract dispose(): void;
 }
+
 export default TimestampQueryPool;

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

@@ -5,46 +5,14 @@ import { Matrix4 } from "../../math/Matrix4.js";
 import { Vector2 } from "../../math/Vector2.js";
 import { Vector3 } from "../../math/Vector3.js";
 import { Vector4 } from "../../math/Vector4.js";
-/**
- * Abstract base class for uniforms.
- *
- * @abstract
- * @private
- */
-declare class Uniform<TValue> {
-    name: string;
-    value: TValue;
-    boundary: number;
-    itemSize: number;
-    offset: number;
-    /**
-     * Constructs a new uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @param {any} value - The uniform's value.
-     */
-    constructor(name: string, value: TValue);
-    /**
-     * Sets the uniform's value.
-     *
-     * @param {any} value - The value to set.
-     */
-    setValue(value: TValue): void;
-    /**
-     * Returns the uniform's value.
-     *
-     * @return {any} The value.
-     */
-    getValue(): TValue;
-}
+
 /**
  * Represents a Number uniform.
  *
  * @private
  * @augments Uniform
  */
-declare class NumberUniform extends Uniform<number> {
-    readonly isNumberUniform: true;
+export class NumberUniform extends Uniform<number> {
     /**
      * Constructs a new Number uniform.
      *
@@ -52,6 +20,14 @@ declare class NumberUniform extends Uniform<number> {
      * @param {number} value - The uniform's value.
      */
     constructor(name: string, value?: number);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isNumberUniform: boolean;
 }
 /**
  * Represents a Vector2 uniform.
@@ -59,8 +35,7 @@ declare class NumberUniform extends Uniform<number> {
  * @private
  * @augments Uniform
  */
-declare class Vector2Uniform extends Uniform<Vector2> {
-    readonly isVector2Uniform: true;
+export class Vector2Uniform extends Uniform<Vector2> {
     /**
      * Constructs a new Number uniform.
      *
@@ -68,6 +43,14 @@ declare class Vector2Uniform extends Uniform<Vector2> {
      * @param {Vector2} value - The uniform's value.
      */
     constructor(name: string, value?: Vector2);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isVector2Uniform: boolean;
 }
 /**
  * Represents a Vector3 uniform.
@@ -75,8 +58,7 @@ declare class Vector2Uniform extends Uniform<Vector2> {
  * @private
  * @augments Uniform
  */
-declare class Vector3Uniform extends Uniform<Vector3> {
-    readonly isVector3Uniform: true;
+export class Vector3Uniform extends Uniform<Vector3> {
     /**
      * Constructs a new Number uniform.
      *
@@ -84,6 +66,14 @@ declare class Vector3Uniform extends Uniform<Vector3> {
      * @param {Vector3} value - The uniform's value.
      */
     constructor(name: string, value?: Vector3);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isVector3Uniform: boolean;
 }
 /**
  * Represents a Vector4 uniform.
@@ -91,8 +81,7 @@ declare class Vector3Uniform extends Uniform<Vector3> {
  * @private
  * @augments Uniform
  */
-declare class Vector4Uniform extends Uniform<Vector4> {
-    readonly isVector4Uniform: true;
+export class Vector4Uniform extends Uniform<Vector4> {
     /**
      * Constructs a new Number uniform.
      *
@@ -100,6 +89,14 @@ declare class Vector4Uniform extends Uniform<Vector4> {
      * @param {Vector4} value - The uniform's value.
      */
     constructor(name: string, value?: Vector4);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isVector4Uniform: boolean;
 }
 /**
  * Represents a Color uniform.
@@ -107,8 +104,7 @@ declare class Vector4Uniform extends Uniform<Vector4> {
  * @private
  * @augments Uniform
  */
-declare class ColorUniform extends Uniform<Color> {
-    readonly isColorUniform: true;
+export class ColorUniform extends Uniform<Color> {
     /**
      * Constructs a new Number uniform.
      *
@@ -116,6 +112,14 @@ declare class ColorUniform extends Uniform<Color> {
      * @param {Color} value - The uniform's value.
      */
     constructor(name: string, value?: Color);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isColorUniform: boolean;
 }
 /**
  * Represents a Matrix2 uniform.
@@ -123,8 +127,7 @@ declare class ColorUniform extends Uniform<Color> {
  * @private
  * @augments Uniform
  */
-declare class Matrix2Uniform extends Uniform<Matrix2> {
-    readonly isMatrix2Uniform: true;
+export class Matrix2Uniform extends Uniform<Matrix2> {
     /**
      * Constructs a new Number uniform.
      *
@@ -132,6 +135,14 @@ declare class Matrix2Uniform extends Uniform<Matrix2> {
      * @param {Matrix2} value - The uniform's value.
      */
     constructor(name: string, value?: Matrix2);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isMatrix2Uniform: boolean;
 }
 /**
  * Represents a Matrix3 uniform.
@@ -139,8 +150,7 @@ declare class Matrix2Uniform extends Uniform<Matrix2> {
  * @private
  * @augments Uniform
  */
-declare class Matrix3Uniform extends Uniform<Matrix3> {
-    readonly isMatrix3Uniform: true;
+export class Matrix3Uniform extends Uniform<Matrix3> {
     /**
      * Constructs a new Number uniform.
      *
@@ -148,6 +158,14 @@ declare class Matrix3Uniform extends Uniform<Matrix3> {
      * @param {Matrix3} value - The uniform's value.
      */
     constructor(name: string, value?: Matrix3);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isMatrix3Uniform: boolean;
 }
 /**
  * Represents a Matrix4 uniform.
@@ -155,8 +173,7 @@ declare class Matrix3Uniform extends Uniform<Matrix3> {
  * @private
  * @augments Uniform
  */
-declare class Matrix4Uniform extends Uniform<Matrix4> {
-    readonly isMatrix4Uniform: true;
+export class Matrix4Uniform extends Uniform<Matrix4> {
     /**
      * Constructs a new Number uniform.
      *
@@ -164,14 +181,82 @@ declare class Matrix4Uniform extends Uniform<Matrix4> {
      * @param {Matrix4} value - The uniform's value.
      */
     constructor(name: string, value?: Matrix4);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isMatrix4Uniform: boolean;
+}
+/**
+ * Abstract base class for uniforms.
+ *
+ * @abstract
+ * @private
+ */
+declare class Uniform<TValue> {
+    /**
+     * Constructs a new uniform.
+     *
+     * @param {string} name - The uniform's name.
+     * @param {any} value - The uniform's value.
+     */
+    constructor(name: string, value: TValue);
+    /**
+     * The uniform's name.
+     *
+     * @type {string}
+     */
+    name: string;
+    /**
+     * The uniform's value.
+     *
+     * @type {any}
+     */
+    value: TValue;
+    /**
+     * Used to build the uniform buffer according to the STD140 layout.
+     * Derived uniforms will set this property to a data type specific
+     * value.
+     *
+     * @type {number}
+     */
+    boundary: number;
+    /**
+     * The item size. Derived uniforms will set this property to a data
+     * type specific value.
+     *
+     * @type {number}
+     */
+    itemSize: number;
+    /**
+     * This property is set by {@link UniformsGroup} and marks
+     * the start position in the uniform buffer.
+     *
+     * @type {number}
+     */
+    offset: number;
+    /**
+     * This property is set by {@link UniformsGroup} and marks
+     * the index position in the uniform array.
+     *
+     * @type {number}
+     */
+    index: number;
+    /**
+     * Sets the uniform's value.
+     *
+     * @param {any} value - The value to set.
+     */
+    setValue(value: TValue): void;
+    /**
+     * Returns the uniform's value.
+     *
+     * @return {any} The value.
+     */
+    getValue(): TValue;
 }
-export {
-    ColorUniform,
-    Matrix2Uniform,
-    Matrix3Uniform,
-    Matrix4Uniform,
-    NumberUniform,
-    Vector2Uniform,
-    Vector3Uniform,
-    Vector4Uniform,
-};
+
+export type { Uniform };

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

@@ -1,4 +1,5 @@
 import Buffer from "./Buffer.js";
+
 /**
  * Represents a uniform buffer binding type.
  *
@@ -6,13 +7,14 @@ import Buffer from "./Buffer.js";
  * @augments Buffer
  */
 declare class UniformBuffer extends Buffer {
-    readonly isUniformBuffer: true;
     /**
-     * Constructs a new uniform buffer.
+     * This flag can be used for type testing.
      *
-     * @param {string} name - The buffer's name.
-     * @param {TypedArray} [buffer=null] - The buffer.
+     * @type {boolean}
+     * @readonly
+     * @default true
      */
-    constructor(name?: string, buffer?: null);
+    readonly isUniformBuffer: boolean;
 }
+
 export default UniformBuffer;