@types/three 0.184.0 → 0.185.0

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

@@ -1,186 +0,0 @@
-import ComputeNode from "../../nodes/gpgpu/ComputeNode.js";
-import Backend from "./Backend.js";
-import BindGroup from "./BindGroup.js";
-import Bindings from "./Bindings.js";
-import ComputePipeline from "./ComputePipeline.js";
-import DataMap from "./DataMap.js";
-import Info from "./Info.js";
-import NodeManager from "./nodes/NodeManager.js";
-import Pipeline from "./Pipeline.js";
-import ProgrammableStage from "./ProgrammableStage.js";
-import RenderObject from "./RenderObject.js";
-import RenderObjectPipeline from "./RenderObjectPipeline.js";
-
-/**
- * This renderer module manages the pipelines of the renderer.
- *
- * @private
- * @augments DataMap
- */
-declare class Pipelines extends DataMap {
-    /**
-     * Constructs a new pipeline management component.
-     *
-     * @param {Backend} backend - The renderer's backend.
-     * @param {NodeManager} nodes - Renderer component for managing nodes related logic.
-     * @param {Info} info - Renderer component for managing metrics and monitoring data.
-     */
-    constructor(backend: Backend, nodes: NodeManager, info: Info);
-    /**
-     * The renderer's backend.
-     *
-     * @type {Backend}
-     */
-    backend: Backend;
-    /**
-     * Renderer component for managing nodes related logic.
-     *
-     * @type {NodeManager}
-     */
-    nodes: NodeManager;
-    /**
-     * Renderer component for managing metrics and monitoring data.
-     *
-     * @type {Info}
-     */
-    info: Info;
-    /**
-     * A references to the bindings management component.
-     * This reference will be set inside the `Bindings`
-     * constructor.
-     *
-     * @type {?Bindings}
-     * @default null
-     */
-    bindings: Bindings | null;
-    /**
-     * Internal cache for maintaining pipelines.
-     * The key of the map is a cache key, the value the pipeline.
-     *
-     * @type {Map<string,Pipeline>}
-     */
-    caches: Map<string, Pipeline>;
-    /**
-     * This dictionary maintains for each shader stage type (vertex,
-     * fragment and compute) the programmable stage objects which
-     * represent the actual shader code.
-     *
-     * @type {Object<string,Map<string, ProgrammableStage>>}
-     */
-    programs: {
-        vertex: Map<string, ProgrammableStage>;
-        fragment: Map<string, ProgrammableStage>;
-        compute: Map<string, ProgrammableStage>;
-    };
-    /**
-     * Returns a compute pipeline for the given compute node.
-     *
-     * @param {Node} computeNode - The compute node.
-     * @param {Array<BindGroup>} bindings - The bindings.
-     * @return {ComputePipeline} The compute pipeline.
-     */
-    getForCompute(computeNode: ComputeNode, bindings: BindGroup[]): ComputePipeline;
-    /**
-     * Returns a render pipeline for the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     * @param {?Array<Promise>} [promises=null] - An array of compilation promises which is only relevant in context of `Renderer.compileAsync()`.
-     * @return {RenderObjectPipeline} The render pipeline.
-     */
-    getForRender(renderObject: RenderObject, promises?: Promise<void>[] | null): RenderObjectPipeline;
-    /**
-     * Checks if the render pipeline for the given render object is ready for drawing.
-     * Returns false if the GPU pipeline is still being compiled asynchronously.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     * @return {boolean} True if the pipeline is ready for drawing.
-     */
-    isReady(renderObject: RenderObject): boolean;
-    /**
-     * Deletes the pipeline for the given render object.
-     *
-     * @param {RenderObject} object - The render object.
-     * @return {?Object} The deleted dictionary.
-     */
-    delete(object: RenderObject): unknown;
-    /**
-     * Updates the pipeline for the given render object.
-     *
-     * @param {RenderObject} renderObject - The render object.
-     */
-    updateForRender(renderObject: RenderObject): void;
-    /**
-     * Returns a compute pipeline for the given parameters.
-     *
-     * @private
-     * @param {Node} computeNode - The compute node.
-     * @param {ProgrammableStage} stageCompute - The programmable stage representing the compute shader.
-     * @param {string} cacheKey - The cache key.
-     * @param {Array<BindGroup>} bindings - The bindings.
-     * @return {ComputePipeline} The compute pipeline.
-     */
-    private _getComputePipeline;
-    /**
-     * Returns a render pipeline for the given parameters.
-     *
-     * @private
-     * @param {RenderObject} renderObject - The render object.
-     * @param {ProgrammableStage} stageVertex - The programmable stage representing the vertex shader.
-     * @param {ProgrammableStage} stageFragment - The programmable stage representing the fragment shader.
-     * @param {string} cacheKey - The cache key.
-     * @param {?Array<Promise>} promises - An array of compilation promises which is only relevant in context of `Renderer.compileAsync()`.
-     * @return {RenderObjectPipeline} The render pipeline.
-     */
-    private _getRenderPipeline;
-    /**
-     * Computes a cache key representing a compute pipeline.
-     *
-     * @private
-     * @param {Node} computeNode - The compute node.
-     * @param {ProgrammableStage} stageCompute - The programmable stage representing the compute shader.
-     * @return {string} The cache key.
-     */
-    private _getComputeCacheKey;
-    /**
-     * Computes a cache key representing a render pipeline.
-     *
-     * @private
-     * @param {RenderObject} renderObject - The render object.
-     * @param {ProgrammableStage} stageVertex - The programmable stage representing the vertex shader.
-     * @param {ProgrammableStage} stageFragment - The programmable stage representing the fragment shader.
-     * @return {string} The cache key.
-     */
-    private _getRenderCacheKey;
-    /**
-     * Releases the given pipeline.
-     *
-     * @private
-     * @param {Pipeline} pipeline - The pipeline to release.
-     */
-    private _releasePipeline;
-    /**
-     * Releases the shader program.
-     *
-     * @private
-     * @param {Object} program - The shader program to release.
-     */
-    private _releaseProgram;
-    /**
-     * Returns `true` if the compute pipeline for the given compute node requires an update.
-     *
-     * @private
-     * @param {Node} computeNode - The compute node.
-     * @return {boolean} Whether the compute pipeline for the given compute node requires an update or not.
-     */
-    private _needsComputeUpdate;
-    /**
-     * Returns `true` if the render pipeline for the given render object requires an update.
-     *
-     * @private
-     * @param {RenderObject} renderObject - The render object.
-     * @return {boolean} Whether the render object for the given render object requires an update or not.
-     */
-    private _needsRenderUpdate;
-}
-
-export default Pipelines;

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

@@ -1,73 +0,0 @@
-import NodeAttribute from "../../nodes/core/NodeAttribute.js";
-
-/**
- * Class for representing programmable stages which are vertex,
- * fragment or compute shaders. Unlike fixed-function states (like blending),
- * they represent the programmable part of a pipeline.
- *
- * @private
- */
-declare class ProgrammableStage {
-    /**
-     * Constructs a new programmable stage.
-     *
-     * @param {string} code - The shader code.
-     * @param {('vertex'|'fragment'|'compute')} stage - The type of stage.
-     * @param {string} name - The name of the shader.
-     * @param {?Array<Object>} [transforms=null] - The transforms (only relevant for compute stages with WebGL 2 which uses Transform Feedback).
-     * @param {?Array<Object>} [attributes=null] - The attributes (only relevant for compute stages with WebGL 2 which uses Transform Feedback).
-     */
-    constructor(
-        code: string,
-        stage: "vertex" | "fragment" | "compute",
-        name: string,
-        transforms?: unknown[] | null,
-        attributes?: NodeAttribute[] | null,
-    );
-    /**
-     * The id of the programmable stage.
-     *
-     * @type {number}
-     */
-    id: number;
-    /**
-     * The shader code.
-     *
-     * @type {string}
-     */
-    code: string;
-    /**
-     * The type of stage.
-     *
-     * @type {string}
-     */
-    stage: "vertex" | "fragment" | "compute";
-    /**
-     * The name of the stage.
-     * This is used for debugging purposes.
-     *
-     * @type {string}
-     */
-    name: string;
-    /**
-     * The transforms (only relevant for compute stages with WebGL 2 which uses Transform Feedback).
-     *
-     * @type {?Array<Object>}
-     */
-    transforms: unknown[] | null;
-    /**
-     * The attributes (only relevant for compute stages with WebGL 2 which uses Transform Feedback).
-     *
-     * @type {?Array<Object>}
-     */
-    attributes: NodeAttribute[] | null;
-    /**
-     * How often the programmable stage is currently in use.
-     *
-     * @type {number}
-     * @default 0
-     */
-    usedTimes: number;
-}
-
-export default ProgrammableStage;

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

@@ -1,25 +0,0 @@
-import { Camera } from "../../cameras/Camera.js";
-import BundleGroup from "./BundleGroup.js";
-import RenderContext from "./RenderContext.js";
-
-/**
- * This module is used to represent render bundles inside the renderer
- * for further processing.
- *
- * @private
- */
-declare class RenderBundle {
-    /**
-     * Constructs a new bundle group.
-     *
-     * @param {BundleGroup} bundleGroup - The bundle group.
-     * @param {Camera} camera - The camera the bundle group is rendered with.
-     * @param {RenderContext} renderContext - The render context the bundle is rendered with.
-     */
-    constructor(bundleGroup: BundleGroup, camera: Camera, renderContext: RenderContext);
-    bundleGroup: BundleGroup;
-    camera: Camera;
-    renderContext: RenderContext;
-}
-
-export default RenderBundle;

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

@@ -1,34 +0,0 @@
-import { Camera } from "../../cameras/Camera.js";
-import BundleGroup from "./BundleGroup.js";
-import ChainMap from "./ChainMap.js";
-import RenderBundle from "./RenderBundle.js";
-import RenderContext from "./RenderContext.js";
-
-/**
- * This renderer module manages render bundles.
- *
- * @private
- */
-declare class RenderBundles {
-    /**
-     * A chain map for maintaining the render bundles.
-     *
-     * @type {ChainMap}
-     */
-    bundles: ChainMap;
-    /**
-     * Returns a render bundle for the given bundle group and camera.
-     *
-     * @param {BundleGroup} bundleGroup - The bundle group.
-     * @param {Camera} camera - The camera the bundle group is rendered with.
-     * @param {RenderContext} renderContext - The render context the bundle is rendered with.
-     * @return {RenderBundle} The render bundle.
-     */
-    get(bundleGroup: BundleGroup, camera: Camera, renderContext: RenderContext): RenderBundle;
-    /**
-     * Frees all internal resources.
-     */
-    dispose(): void;
-}
-
-export default RenderBundles;

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

@@ -1,235 +0,0 @@
-import { Camera } from "../../cameras/Camera.js";
-import { RenderTarget } from "../../core/RenderTarget.js";
-import { Vector4 } from "../../math/Vector4.js";
-import MRTNode from "../../nodes/core/MRTNode.js";
-import { DepthTexture } from "../../textures/DepthTexture.js";
-import { Texture } from "../../textures/Texture.js";
-import ClippingContext from "./ClippingContext.js";
-
-/**
- * Any render or compute command is executed in a specific context that defines
- * the state of the renderer and its backend. Typical examples for such context
- * data are the current clear values or data from the active framebuffer. This
- * module is used to represent these contexts as objects.
- *
- * @private
- */
-declare class RenderContext {
-    /**
-     * The context's ID.
-     *
-     * @type {number}
-     */
-    id: number;
-    /**
-     * The MRT configuration.
-     *
-     * @type {?MRTNode}
-     * @default null
-     */
-    mrt: MRTNode | null;
-    /**
-     * Whether the current active framebuffer has a color attachment.
-     *
-     * @type {boolean}
-     * @default true
-     */
-    color: boolean;
-    /**
-     * Whether the color attachment should be cleared or not.
-     *
-     * @type {boolean}
-     * @default true
-     */
-    clearColor: boolean;
-    /**
-     * The clear color value.
-     *
-     * @type {Object}
-     * @default true
-     */
-    clearColorValue: {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    };
-    /**
-     * Whether the current active framebuffer has a depth attachment.
-     *
-     * @type {boolean}
-     * @default true
-     */
-    depth: boolean;
-    /**
-     * Whether the depth attachment should be cleared or not.
-     *
-     * @type {boolean}
-     * @default true
-     */
-    clearDepth: boolean;
-    /**
-     * The clear depth value.
-     *
-     * @type {number}
-     * @default 1
-     */
-    clearDepthValue: number;
-    /**
-     * Whether the current active framebuffer has a stencil attachment.
-     *
-     * @type {boolean}
-     * @default false
-     */
-    stencil: boolean;
-    /**
-     * Whether the stencil attachment should be cleared or not.
-     *
-     * @type {boolean}
-     * @default true
-     */
-    clearStencil: boolean;
-    /**
-     * The clear stencil value.
-     *
-     * @type {number}
-     * @default 1
-     */
-    clearStencilValue: number;
-    /**
-     * By default the viewport encloses the entire framebuffer If a smaller
-     * viewport is manually defined, this property is to `true` by the renderer.
-     *
-     * @type {boolean}
-     * @default false
-     */
-    viewport: boolean;
-    /**
-     * The viewport value. This value is in physical pixels meaning it incorporates
-     * the renderer's pixel ratio. The viewport property of render targets or
-     * the renderer is in logical pixels.
-     *
-     * @type {Vector4}
-     */
-    viewportValue: Vector4;
-    /**
-     * When the scissor test is active and scissor rectangle smaller than the
-     * framebuffers dimensions, this property is to `true` by the renderer.
-     *
-     * @type {boolean}
-     * @default false
-     */
-    scissor: boolean;
-    /**
-     * The scissor rectangle.
-     *
-     * @type {Vector4}
-     */
-    scissorValue: Vector4;
-    /**
-     * The active render target.
-     *
-     * @type {?RenderTarget}
-     * @default null
-     */
-    renderTarget: RenderTarget | null;
-    /**
-     * The textures of the active render target.
-     * `null` when no render target is set.
-     *
-     * @type {?Array<Texture>}
-     * @default null
-     */
-    textures: Texture[] | null;
-    /**
-     * The depth texture of the active render target.
-     * `null` when no render target is set.
-     *
-     * @type {?DepthTexture}
-     * @default null
-     */
-    depthTexture: DepthTexture | null;
-    /**
-     * The active cube face.
-     *
-     * @type {number}
-     * @default 0
-     */
-    activeCubeFace: number;
-    /**
-     * The active mipmap level.
-     *
-     * @type {number}
-     * @default 0
-     */
-    activeMipmapLevel: number;
-    /**
-     * The number of MSAA samples. This value is always `1` when
-     * MSAA isn't used.
-     *
-     * @type {number}
-     * @default 1
-     */
-    sampleCount: number;
-    /**
-     * The active render target's width in physical pixels.
-     *
-     * @type {number}
-     * @default 0
-     */
-    width: number;
-    /**
-     * The active render target's height in physical pixels.
-     *
-     * @type {number}
-     * @default 0
-     */
-    height: number;
-    /**
-     * The occlusion query count.
-     *
-     * @type {number}
-     * @default 0
-     */
-    occlusionQueryCount: number;
-    /**
-     * The current clipping context.
-     *
-     * @type {?ClippingContext}
-     * @default null
-     */
-    clippingContext: ClippingContext | null;
-    /**
-     * The current camera.
-     *
-     * @type {?Camera}
-     * @default null
-     */
-    camera: Camera | null;
-    /**
-     * This flag can be used for type testing.
-     *
-     * @type {boolean}
-     * @readonly
-     * @default true
-     */
-    readonly isRenderContext: boolean;
-    /**
-     * Returns the cache key of this render context.
-     *
-     * @return {number} The cache key.
-     */
-    getCacheKey(): number;
-}
-
-/**
- * Computes a cache key for the given render context. This key
- * should identify the render target state so it is possible to
- * configure the correct attachments in the respective backend.
- *
- * @param {RenderContext} renderContext - The render context.
- * @return {number} The cache key.
- */
-export function getCacheKey(renderContext: RenderContext): number;
-
-export default RenderContext;

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

@@ -1,47 +0,0 @@
-import { RenderTarget } from "../../core/RenderTarget.js";
-import MRTNode from "../../nodes/core/MRTNode.js";
-import RenderContext from "./RenderContext.js";
-import Renderer from "./Renderer.js";
-
-/**
- * This module manages the render contexts of the renderer.
- *
- * @private
- */
-declare class RenderContexts {
-    /**
-     * Constructs a new render context management component.
-     *
-     * @param {Renderer} renderer - The renderer.
-     */
-    constructor(renderer: Renderer);
-    /**
-     * The renderer.
-     *
-     * @type {Renderer}
-     */
-    renderer: Renderer;
-    /**
-     * A dictionary that manages render contexts.
-     *
-     * @type {Object<string,RenderContext>}
-     */
-    _renderContexts: {
-        [x: string]: RenderContext;
-    };
-    /**
-     * Returns a render context for the given scene, camera and render target.
-     *
-     * @param {?RenderTarget} [renderTarget=null] - The active render target.
-     * @param {?MRTNode} [mrt=null] - The MRT configuration
-     * @param {?number} [callDepth=0] - The call depth of the renderer.
-     * @return {RenderContext} The render context.
-     */
-    get(renderTarget?: RenderTarget | null, mrt?: MRTNode | null, callDepth?: number | null): RenderContext;
-    /**
-     * Frees internal resources.
-     */
-    dispose(): void;
-}
-
-export default RenderContexts;