@types/three 0.184.0 → 0.185.0

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

@@ -1,125 +0,0 @@
-import { RenderTarget } from "../../core/RenderTarget.js";
-import { Vector3 } from "../../math/Vector3.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";
-
-interface TextureOptions {
-    width?: number;
-    height?: number;
-    depth?: number;
-    needsMipmaps?: boolean;
-    levels?: number;
-}
-
-/**
- * This module manages the textures of the renderer.
- *
- * @private
- * @augments DataMap
- */
-declare class Textures extends DataMap {
-    /**
-     * Constructs a new texture management component.
-     *
-     * @param {Renderer} renderer - The renderer.
-     * @param {Backend} backend - The renderer's backend.
-     * @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.
-     *
-     * @param {RenderTarget} renderTarget - The render target to update.
-     * @param {number} [activeMipmapLevel=0] - The active mipmap level.
-     */
-    updateRenderTarget(renderTarget: RenderTarget, activeMipmapLevel?: number): void;
-    /**
-     * Updates the given texture. Depending on the texture state, this method
-     * triggers the upload of texture data to the GPU memory. If the texture data are
-     * not yet ready for the upload, it uses default texture data for as a placeholder.
-     *
-     * @param {Texture} texture - The texture to update.
-     * @param {Object} [options={}] - The options.
-     */
-    updateTexture(texture: Texture, options?: TextureOptions): void;
-    /**
-     * Updates the sampler for the given texture. This method has no effect
-     * for the WebGL backend since it has no concept of samplers. Texture
-     * parameters are configured with the `texParameter()` command for each
-     * texture.
-     *
-     * In WebGPU, samplers are objects like textures and it's possible to share
-     * them when the texture parameters match.
-     *
-     * @param {Texture} texture - The texture to update the sampler for.
-     * @return {string} The current sampler key.
-     */
-    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
-     * method.
-     *
-     * If no texture data are available for the compute yet, the method
-     * returns default size values.
-     *
-     * @param {Texture} texture - The texture to compute the size for.
-     * @param {Vector3} target - The target vector.
-     * @return {Vector3} The target vector.
-     */
-    getSize(texture: Texture, target?: Vector3): Vector3;
-    /**
-     * Computes the number of mipmap levels for the given texture.
-     *
-     * @param {Texture} texture - The texture.
-     * @param {number} width - The texture's width.
-     * @param {number} height - The texture's height.
-     * @return {number} The number of mipmap levels.
-     */
-    getMipLevels(texture: Texture, width: number, height: number): number;
-    /**
-     * Returns `true` if the given texture makes use of mipmapping.
-     *
-     * @param {Texture} texture - The texture.
-     * @return {boolean} Whether mipmaps are required or not.
-     */
-    needsMipmaps(texture: Texture): boolean;
-    /**
-     * Frees internal resources when the given render target isn't
-     * required anymore.
-     *
-     * @param {RenderTarget} renderTarget - The render target to destroy.
-     */
-    _destroyRenderTarget(renderTarget: RenderTarget): void;
-    /**
-     * Frees internal resource when the given texture isn't
-     * required anymore.
-     *
-     * @param {Texture} texture - The texture to destroy.
-     */
-    _destroyTexture(texture: Texture): void;
-}
-
-export default Textures;

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

@@ -1,262 +0,0 @@
-import { Color } from "../../math/Color.js";
-import { Matrix2 } from "../../math/Matrix2.js";
-import { Matrix3 } from "../../math/Matrix3.js";
-import { Matrix4 } from "../../math/Matrix4.js";
-import { Vector2 } from "../../math/Vector2.js";
-import { Vector3 } from "../../math/Vector3.js";
-import { Vector4 } from "../../math/Vector4.js";
-
-/**
- * Represents a Number uniform.
- *
- * @private
- * @augments Uniform
- */
-export class NumberUniform extends Uniform<number> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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.
- *
- * @private
- * @augments Uniform
- */
-export class Vector2Uniform extends Uniform<Vector2> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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.
- *
- * @private
- * @augments Uniform
- */
-export class Vector3Uniform extends Uniform<Vector3> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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.
- *
- * @private
- * @augments Uniform
- */
-export class Vector4Uniform extends Uniform<Vector4> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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.
- *
- * @private
- * @augments Uniform
- */
-export class ColorUniform extends Uniform<Color> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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.
- *
- * @private
- * @augments Uniform
- */
-export class Matrix2Uniform extends Uniform<Matrix2> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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.
- *
- * @private
- * @augments Uniform
- */
-export class Matrix3Uniform extends Uniform<Matrix3> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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.
- *
- * @private
- * @augments Uniform
- */
-export class Matrix4Uniform extends Uniform<Matrix4> {
-    /**
-     * Constructs a new Number uniform.
-     *
-     * @param {string} name - The uniform's name.
-     * @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 type { Uniform };

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

@@ -1,20 +0,0 @@
-import Buffer from "./Buffer.js";
-
-/**
- * Represents a uniform buffer binding type.
- *
- * @private
- * @augments Buffer
- */
-declare class UniformBuffer extends Buffer {
-    /**
-     * This flag can be used for type testing.
-     *
-     * @type {boolean}
-     * @readonly
-     * @default true
-     */
-    readonly isUniformBuffer: boolean;
-}
-
-export default UniformBuffer;

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

@@ -1,152 +0,0 @@
-import {
-    ColorNodeUniform,
-    Matrix3NodeUniform,
-    Matrix4NodeUniform,
-    NodeUniformGPU,
-    NumberNodeUniform,
-    Vector2NodeUniform,
-    Vector3NodeUniform,
-    Vector4NodeUniform,
-} from "./nodes/NodeUniform.js";
-import { Uniform } from "./Uniform.js";
-import UniformBuffer from "./UniformBuffer.js";
-
-/**
- * This class represents a uniform buffer binding but with
- * an API that allows to maintain individual uniform objects.
- *
- * @private
- * @augments UniformBuffer
- */
-declare class UniformsGroup extends UniformBuffer {
-    /**
-     * Constructs a new uniforms group.
-     *
-     * @param {string} name - The group's name.
-     */
-    constructor(name: string);
-    /**
-     * This flag can be used for type testing.
-     *
-     * @type {boolean}
-     * @readonly
-     * @default true
-     */
-    readonly isUniformsGroup: boolean;
-    /**
-     * An array with the raw uniform values.
-     *
-     * @private
-     * @type {?Array<number>}
-     * @default null
-     */
-    private _values;
-    /**
-     * An array of uniform objects.
-     *
-     * The order of uniforms in this array must match the order of uniforms in the shader.
-     *
-     * @type {Array<Uniform>}
-     */
-    uniforms: NodeUniformGPU[];
-    /**
-     * A cache for the uniform update ranges.
-     *
-     * @private
-     * @type {Map<number, {start: number, count: number}>}
-     */
-    private _updateRangeCache;
-    /**
-     * Adds a uniform's update range to this buffer.
-     *
-     * @param {Uniform} uniform - The uniform.
-     */
-    addUniformUpdateRange(uniform: Uniform<unknown>): void;
-    /**
-     * Adds a uniform to this group.
-     *
-     * @param {Uniform} uniform - The uniform to add.
-     * @return {UniformsGroup} A reference to this group.
-     */
-    addUniform(uniform: NodeUniformGPU): this;
-    /**
-     * Removes a uniform from this group.
-     *
-     * @param {Uniform} uniform - The uniform to remove.
-     * @return {UniformsGroup} A reference to this group.
-     */
-    removeUniform(uniform: NodeUniformGPU): this;
-    /**
-     * An array with the raw uniform values.
-     *
-     * @type {Array<number>}
-     */
-    get values(): number[];
-    /**
-     * Updates a given uniform by calling an update method matching
-     * the uniforms type.
-     *
-     * @param {Uniform} uniform - The uniform to update.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateByType(uniform: NodeUniformGPU): boolean;
-    /**
-     * Updates a given Number uniform.
-     *
-     * @param {NumberUniform} uniform - The Number uniform.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateNumber(uniform: NumberNodeUniform<unknown>): boolean;
-    /**
-     * Updates a given Vector2 uniform.
-     *
-     * @param {Vector2Uniform} uniform - The Vector2 uniform.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateVector2(uniform: Vector2NodeUniform<unknown>): boolean;
-    /**
-     * Updates a given Vector3 uniform.
-     *
-     * @param {Vector3Uniform} uniform - The Vector3 uniform.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateVector3(uniform: Vector3NodeUniform<unknown>): boolean;
-    /**
-     * Updates a given Vector4 uniform.
-     *
-     * @param {Vector4Uniform} uniform - The Vector4 uniform.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateVector4(uniform: Vector4NodeUniform<unknown>): boolean;
-    /**
-     * Updates a given Color uniform.
-     *
-     * @param {ColorUniform} uniform - The Color uniform.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateColor(uniform: ColorNodeUniform<unknown>): boolean;
-    /**
-     * Updates a given Matrix3 uniform.
-     *
-     * @param {Matrix3Uniform} uniform - The Matrix3 uniform.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateMatrix3(uniform: Matrix3NodeUniform<unknown>): boolean;
-    /**
-     * Updates a given Matrix4 uniform.
-     *
-     * @param {Matrix4Uniform} uniform - The Matrix4 uniform.
-     * @return {boolean} Whether the uniform has been updated or not.
-     */
-    updateMatrix4(uniform: Matrix4NodeUniform<unknown>): boolean;
-    /**
-     * Returns a typed array that matches the given data type.
-     *
-     * @private
-     * @param {string} type - The data type.
-     * @return {TypedArray} The typed array.
-     */
-    private _getBufferForType;
-}
-
-export default UniformsGroup;

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

@@ -1,67 +0,0 @@
-import { RenderTarget, RenderTargetOptions } from "../../core/RenderTarget.js";
-
-/**
- * A special type of render target that is used when rendering
- * with the WebXR Device API.
- *
- * @private
- * @augments RenderTarget
- */
-export class XRRenderTarget extends RenderTarget {
-    /**
-     * Constructs a new XR render target.
-     *
-     * @param {number} [width=1] - The width of the render target.
-     * @param {number} [height=1] - The height of the render target.
-     * @param {Object} [options={}] - The configuration options.
-     */
-    constructor(width?: number, height?: number, options?: RenderTargetOptions);
-    /**
-     * This flag can be used for type testing.
-     *
-     * @type {boolean}
-     * @readonly
-     * @default true
-     */
-    readonly isXRRenderTarget: boolean;
-    /**
-     * Whether the attachments of the render target
-     * are defined by external textures. This flag is
-     * set to `true` when using the WebXR Layers API.
-     *
-     * @private
-     * @type {boolean}
-     * @default false
-     */
-    private _hasExternalTextures;
-    /**
-     * Whether a depth buffer should automatically be allocated
-     * for this XR render target or not.
-     *
-     * Allocating a depth buffer is the default behavior of XR render
-     * targets. However, when using the WebXR Layers API, this flag
-     * must be set to `false` when the `ignoreDepthValues` property of
-     * the projection layers evaluates to `false`.
-     *
-     * Reference: {@link https://www.w3.org/TR/webxrlayers-1/#dom-xrprojectionlayer-ignoredepthvalues}.
-     *
-     * @private
-     * @type {boolean}
-     * @default true
-     */
-    private _autoAllocateDepthBuffer;
-    /**
-     * Whether this render target is associated with a XRWebGLLayer.
-     *
-     * A XRWebGLLayer points to an opaque framebuffer. Basically,
-     * this means that you don't have access to its bound color,
-     * stencil and depth buffers. We need to handle this framebuffer
-     * differently since its textures are always bound.
-     *
-     * @private
-     * @type {boolean}
-     * @default false
-     */
-    private _isOpaqueFramebuffer;
-    copy(source: XRRenderTarget): this;
-}