@types/three 0.184.0 → 0.185.0

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

@@ -1,132 +0,0 @@
-import ComputeNode from "../../nodes/gpgpu/ComputeNode.js";
-import Attributes from "./Attributes.js";
-import Backend from "./Backend.js";
-import BindGroup from "./BindGroup.js";
-import DataMap from "./DataMap.js";
-import Info from "./Info.js";
-import NodeManager from "./nodes/NodeManager.js";
-import Pipelines from "./Pipelines.js";
-import RenderObject from "./RenderObject.js";
-import Textures from "./Textures.js";
-
-/**
- * This renderer module manages the bindings of the renderer.
- *
- * @private
- * @augments DataMap
- */
-declare class Bindings extends DataMap {
-    /**
-     * Constructs a new bindings management component.
-     *
-     * @param {Backend} backend - The renderer's backend.
-     * @param {NodeManager} nodes - Renderer component for managing nodes related logic.
-     * @param {Textures} textures - Renderer component for managing textures.
-     * @param {Attributes} attributes - Renderer component for managing attributes.
-     * @param {Pipelines} pipelines - Renderer component for managing pipelines.
-     * @param {Info} info - Renderer component for managing metrics and monitoring data.
-     */
-    constructor(
-        backend: Backend,
-        nodes: NodeManager,
-        textures: Textures,
-        attributes: Attributes,
-        pipelines: Pipelines,
-        info: Info,
-    );
-    /**
-     * The renderer's backend.
-     *
-     * @type {Backend}
-     */
-    backend: Backend;
-    /**
-     * Renderer component for managing textures.
-     *
-     * @type {Textures}
-     */
-    textures: Textures;
-    /**
-     * Renderer component for managing pipelines.
-     *
-     * @type {Pipelines}
-     */
-    pipelines: Pipelines;
-    /**
-     * Renderer component for managing attributes.
-     *
-     * @type {Attributes}
-     */
-    attributes: Attributes;
-    /**
-     * Renderer component for managing nodes related logic.
-     *
-     * @type {NodeManager}
-     */
-    nodes: NodeManager;
-    /**
-     * Renderer component for managing metrics and monitoring data.
-     *
-     * @type {Info}
-     */
-    info: Info;
-    /**
-     * Returns the bind groups for the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     * @return {Array<BindGroup>} The bind groups.
-     */
-    getForRender(renderObject: RenderObject): BindGroup[];
-    /**
-     * Returns the bind groups for the given compute node.
-     *
-     * @param {Node} computeNode - The compute node.
-     * @return {Array<BindGroup>} The bind groups.
-     */
-    getForCompute(computeNode: ComputeNode): BindGroup[];
-    /**
-     * Updates the bindings for the given compute node.
-     *
-     * @param {Node} computeNode - The compute node.
-     */
-    updateForCompute(computeNode: ComputeNode): void;
-    /**
-     * Updates the bindings for the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     */
-    updateForRender(renderObject: RenderObject): void;
-    /**
-     * Deletes the bindings for the given compute node.
-     *
-     * @param {Node} computeNode - The compute node.
-     */
-    deleteForCompute(computeNode: ComputeNode): void;
-    /**
-     * Deletes the bindings for the given renderObject node.
-     *
-     * @param {RenderObject} renderObject - The renderObject.
-     */
-    deleteForRender(renderObject: RenderObject): void;
-    /**
-     * Updates the given array of bindings.
-     *
-     * @param {Array<BindGroup>} bindings - The bind groups.
-     */
-    _updateBindings(bindings: BindGroup[]): void;
-    /**
-     * Initializes the given bind group.
-     *
-     * @param {BindGroup} bindGroup - The bind group to initialize.
-     */
-    _init(bindGroup: BindGroup): void;
-    /**
-     * Updates the given bind group.
-     *
-     * @param {BindGroup} bindGroup - The bind group to update.
-     * @param {Array<BindGroup>} bindings - The bind groups.
-     */
-    _update(bindGroup: BindGroup, bindings: BindGroup[]): void;
-}
-
-export default Bindings;

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

@@ -1,90 +0,0 @@
-import { TypedArray } from "../../core/BufferAttribute.js";
-import Binding from "./Binding.js";
-
-/**
- * Represents a buffer binding type.
- *
- * @private
- * @abstract
- * @augments Binding
- */
-declare class Buffer extends Binding {
-    /**
-     * Constructs a new buffer.
-     *
-     * @param {string} name - The buffer's name.
-     * @param {TypedArray} [buffer=null] - The buffer.
-     */
-    constructor(name: string, buffer?: TypedArray);
-    /**
-     * This flag can be used for type testing.
-     *
-     * @type {boolean}
-     * @readonly
-     * @default true
-     */
-    readonly isBuffer: boolean;
-    /**
-     * The bytes per element.
-     *
-     * @type {number}
-     */
-    bytesPerElement: number;
-    /**
-     * A reference to the internal buffer.
-     *
-     * @private
-     * @type {TypedArray}
-     */
-    private _buffer;
-    /**
-     * An array of update ranges.
-     *
-     * @private
-     * @type {Array<{start: number, count: number}>}
-     */
-    private _updateRanges;
-    /**
-     * The array of update ranges.
-     *
-     * @type {Array<{start: number, count: number}>}
-     */
-    get updateRanges(): Array<{
-        start: number;
-        count: number;
-    }>;
-    /**
-     * Adds an update range.
-     *
-     * @param {number} start - The start index.
-     * @param {number} count - The number of elements.
-     */
-    addUpdateRange(start: number, count: number): void;
-    /**
-     * Clears all update ranges.
-     */
-    clearUpdateRanges(): void;
-    /**
-     * The buffer's byte length.
-     *
-     * @type {number}
-     * @readonly
-     */
-    get byteLength(): number;
-    /**
-     * A reference to the internal buffer.
-     *
-     * @type {Float32Array}
-     * @readonly
-     */
-    get buffer(): TypedArray;
-    /**
-     * Updates the binding.
-     *
-     * @return {boolean} Whether the buffer has been updated and must be
-     * uploaded to the GPU.
-     */
-    update(): boolean;
-}
-
-export default Buffer;

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

@@ -1,49 +0,0 @@
-/**
- * Data structure for the renderer. It allows defining values
- * with chained, hierarchical keys. Keys are meant to be
- * objects since the module internally works with Weak Maps
- * for performance reasons.
- *
- * @private
- */
-declare class ChainMap {
-    /**
-     * A map of Weak Maps by their key length.
-     *
-     * @type {Object<number, WeakMap>}
-     */
-    weakMaps: {
-        [x: number]: WeakMap<object, unknown>;
-    };
-    /**
-     * Returns the Weak Map for the given keys.
-     *
-     * @param {Array<Object>} keys - List of keys.
-     * @return {WeakMap} The weak map.
-     */
-    _getWeakMap(keys: object[]): WeakMap<object, unknown>;
-    /**
-     * Returns the value for the given array of keys.
-     *
-     * @param {Array<Object>} keys - List of keys.
-     * @return {any} The value. Returns `undefined` if no value was found.
-     */
-    get(keys: object[]): unknown;
-    /**
-     * Sets the value for the given keys.
-     *
-     * @param {Array<Object>} keys - List of keys.
-     * @param {any} value - The value to set.
-     * @return {ChainMap} A reference to this Chain Map.
-     */
-    set(keys: object[], value: unknown): ChainMap;
-    /**
-     * Deletes a value for the given keys.
-     *
-     * @param {Array<Object>} keys - The keys.
-     * @return {boolean} Returns `true` if the value has been removed successfully and `false` if the value has not be found.
-     */
-    delete(keys: object[]): boolean;
-}
-
-export default ChainMap;

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

@@ -1,55 +0,0 @@
-import { Color, ColorRepresentation } from "../../math/Color.js";
-
-/**
- * A four-component version of {@link Color} which is internally
- * used by the renderer to represents clear color with alpha as
- * one object.
- *
- * @private
- * @augments Color
- */
-declare class Color4 extends Color {
-    /**
-     * Constructs a new four-component color.
-     * You can pass a single THREE.Color, hex or
-     * string argument to this constructor.
-     */
-    constructor(color?: ColorRepresentation);
-    /**
-     * Constructs a new four-component color.
-     *
-     * @param {number} [r=1] - The red value.
-     * @param {number} [g=1] - The green value.
-     * @param {number} [b=1] - The blue value.
-     * @param {number} [a=1] - The alpha value.
-     */
-    constructor(r: number, g: number, b: number, a?: number);
-    a: number;
-    /**
-     * Overwrites the default to honor alpha.
-     * You can also pass a single THREE.Color, hex or
-     * string argument to this method.
-     *
-     * @param {number|string|Color} r - The red value.
-     * @param {number} [g] - The green value.
-     * @param {number} [b] - The blue value.
-     * @param {number} [a=1] - The alpha value.
-     * @return {Color4} A reference to this object.
-     */
-    set(...args: [color: ColorRepresentation] | [r: number, g: number, b: number, a?: number]): this;
-    /**
-     * Overwrites the default to honor alpha.
-     *
-     * @param {Color4} color - The color to copy.
-     * @return {Color4} A reference to this object.
-     */
-    copy(color: Color4): this;
-    /**
-     * Overwrites the default to honor alpha.
-     *
-     * @return {Color4} The cloned color.
-     */
-    clone(): this;
-}
-
-export default Color4;

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

@@ -1,34 +0,0 @@
-import Pipeline from "./Pipeline.js";
-import ProgrammableStage from "./ProgrammableStage.js";
-
-/**
- * Class for representing compute pipelines.
- *
- * @private
- * @augments Pipeline
- */
-declare class ComputePipeline extends Pipeline {
-    /**
-     * Constructs a new compute pipeline.
-     *
-     * @param {string} cacheKey - The pipeline's cache key.
-     * @param {ProgrammableStage} computeProgram - The pipeline's compute shader.
-     */
-    constructor(cacheKey: string, computeProgram: ProgrammableStage);
-    /**
-     * The pipeline's compute shader.
-     *
-     * @type {ProgrammableStage}
-     */
-    computeProgram: ProgrammableStage;
-    /**
-     * This flag can be used for type testing.
-     *
-     * @type {boolean}
-     * @readonly
-     * @default true
-     */
-    readonly isComputePipeline: boolean;
-}
-
-export default ComputePipeline;

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

@@ -1,42 +0,0 @@
-/**
- * Data structure for the renderer. It is intended to manage
- * data of objects in dictionaries.
- *
- * @private
- */
-declare class DataMap {
-    /**
-     * `DataMap` internally uses a weak map
-     * to manage its data.
-     *
-     * @type {WeakMap<Object, Object>}
-     */
-    data: WeakMap<object, unknown>;
-    /**
-     * Returns the dictionary for the given object.
-     *
-     * @param {Object} object - The object.
-     * @return {Object} The dictionary.
-     */
-    get(object: object): unknown;
-    /**
-     * Deletes the dictionary for the given object.
-     *
-     * @param {Object} object - The object.
-     * @return {?Object} The deleted dictionary.
-     */
-    delete(object: object): unknown | null;
-    /**
-     * Returns `true` if the given object has a dictionary defined.
-     *
-     * @param {Object} object - The object to test.
-     * @return {boolean} Whether a dictionary is defined or not.
-     */
-    has(object: object): boolean;
-    /**
-     * Frees internal resources.
-     */
-    dispose(): void;
-}
-
-export default DataMap;

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

@@ -1,111 +0,0 @@
-import { BufferAttribute } from "../../core/BufferAttribute.js";
-import { BufferGeometry } from "../../core/BufferGeometry.js";
-import Attributes from "./Attributes.js";
-import { AttributeType } from "./Constants.js";
-import DataMap from "./DataMap.js";
-import Info from "./Info.js";
-import RenderObject from "./RenderObject.js";
-
-/**
- * This renderer module manages geometries.
- *
- * @private
- * @augments DataMap
- */
-declare class Geometries extends DataMap {
-    /**
-     * Constructs a new geometry management component.
-     *
-     * @param {Attributes} attributes - Renderer component for managing attributes.
-     * @param {Info} info - Renderer component for managing metrics and monitoring data.
-     */
-    constructor(attributes: Attributes, info: Info);
-    /**
-     * Renderer component for managing attributes.
-     *
-     * @type {Attributes}
-     */
-    attributes: Attributes;
-    /**
-     * Renderer component for managing metrics and monitoring data.
-     *
-     * @type {Info}
-     */
-    info: Info;
-    /**
-     * Weak Map for managing attributes for wireframe rendering.
-     *
-     * @type {WeakMap<BufferGeometry,BufferAttribute>}
-     */
-    wireframes: WeakMap<BufferGeometry, BufferAttribute>;
-    /**
-     * This Weak Map is used to make sure buffer attributes are
-     * updated only once per render call.
-     *
-     * @type {WeakMap<BufferAttribute,number>}
-     */
-    attributeCall: WeakMap<BufferAttribute, number>;
-    /**
-     * Stores the event listeners attached to geometries.
-     *
-     * @private
-     * @type {Map<BufferGeometry,Function>}
-     */
-    private _geometryDisposeListeners;
-    /**
-     * Returns `true` if the given render object has an initialized geometry.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     * @return {boolean} Whether if the given render object has an initialized geometry or not.
-     */
-    has(renderObject: RenderObject): boolean;
-    /**
-     * Prepares the geometry of the given render object for rendering.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     */
-    updateForRender(renderObject: RenderObject): void;
-    /**
-     * Initializes the geometry of the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     */
-    initGeometry(renderObject: RenderObject): void;
-    /**
-     * Updates the geometry attributes of the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     */
-    updateAttributes(renderObject: RenderObject): void;
-    /**
-     * Updates the given attribute.
-     *
-     * @param {BufferAttribute} attribute - The attribute to update.
-     * @param {number} type - The attribute type.
-     */
-    updateAttribute(attribute: BufferAttribute, type: AttributeType): void;
-    /**
-     * Returns the indirect buffer attribute of the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     * @return {?BufferAttribute} The indirect attribute. `null` if no indirect drawing is used.
-     */
-    getIndirect(renderObject: RenderObject): BufferAttribute | null;
-    /**
-     * Returns the byte offset into the indirect attribute buffer of the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     * @return {number} The byte offset into the indirect attribute buffer.
-     */
-    getIndirectOffset(renderObject: RenderObject): number;
-    /**
-     * Returns the index of the given render object's geometry. This is implemented
-     * in a method to return a wireframe index if necessary.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     * @return {?BufferAttribute} The index. Returns `null` for non-indexed geometries.
-     */
-    getIndex(renderObject: RenderObject): BufferAttribute | null;
-}
-
-export default Geometries;

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

@@ -1,29 +0,0 @@
-/**
- * Abstract class for representing pipelines.
- *
- * @private
- * @abstract
- */
-declare class Pipeline {
-    /**
-     * Constructs a new pipeline.
-     *
-     * @param {string} cacheKey - The pipeline's cache key.
-     */
-    constructor(cacheKey: string);
-    /**
-     * The pipeline's cache key.
-     *
-     * @type {string}
-     */
-    cacheKey: string;
-    /**
-     * How often the pipeline is currently in use.
-     *
-     * @type {number}
-     * @default 0
-     */
-    usedTimes: number;
-}
-
-export default Pipeline;