@types/three 0.181.0 → 0.183.0

three/src/renderers/WebGLRenderer.d.ts

@@ -1,7 +1,7 @@
 import { Camera } from "../cameras/Camera.js";
-import { CullFace, ShadowMapType, ToneMapping, WebGLCoordinateSystem } from "../constants.js";
+import { TextureDataType, ToneMapping, WebGLCoordinateSystem } from "../constants.js";
 import { TypedArray } from "../core/BufferAttribute.js";
-import { BufferGeometry } from "../core/BufferGeometry.js";
+import { BufferGeometry, GeometryGroup } from "../core/BufferGeometry.js";
 import { Object3D } from "../core/Object3D.js";
 import { Material } from "../materials/Material.js";
 import { Box2 } from "../math/Box2.js";
@@ -76,6 +76,11 @@ export interface WebGLRendererParameters extends WebGLCapabilitiesParameters {
      * default is false.
      */
     failIfMajorPerformanceCaveat?: boolean | undefined;
+
+    /**
+     * @default UnsignedByteType
+     */
+    outputBufferType?: TextureDataType | undefined;
 }
 
 export interface WebGLDebug {
@@ -100,6 +105,17 @@ export interface WebGLDebug {
         | null;
 }
 
+export interface Effect {
+    setSize(width: number, height: number): void;
+    render(
+        renderer: WebGLRenderer,
+        writeBuffer: WebGLRenderTarget,
+        readBuffer: WebGLRenderTarget,
+        deltaTime: number,
+        maskActive: boolean,
+    ): void;
+}
+
 /**
  * The WebGL renderer displays your beautifully crafted scenes using WebGL, if your device supports it.
  * This renderer has way better performance than CanvasRenderer.
@@ -211,26 +227,13 @@ export class WebGLRenderer {
      * Return the WebGL context.
      */
     getContext(): WebGLRenderingContext | WebGL2RenderingContext;
-    getContextAttributes(): any;
+    getContextAttributes(): WebGLContextAttributes;
     forceContextLoss(): void;
     forceContextRestore(): void;
 
-    /**
-     * @deprecated Use {@link WebGLCapabilities#getMaxAnisotropy .capabilities.getMaxAnisotropy()} instead.
-     */
-    getMaxAnisotropy(): number;
-
-    /**
-     * @deprecated Use {@link WebGLCapabilities#precision .capabilities.precision} instead.
-     */
-    getPrecision(): string;
-
     getPixelRatio(): number;
     setPixelRatio(value: number): void;
 
-    getDrawingBufferSize(target: Vector2): Vector2;
-    setDrawingBufferSize(width: number, height: number, pixelRatio: number): void;
-
     getSize(target: Vector2): Vector2;
 
     /**
@@ -238,6 +241,11 @@ export class WebGLRenderer {
      */
     setSize(width: number, height: number, updateStyle?: boolean): void;
 
+    getDrawingBufferSize(target: Vector2): Vector2;
+    setDrawingBufferSize(width: number, height: number, pixelRatio: number): void;
+
+    setEffects(effects: Effect[] | null): void;
+
     getCurrentViewport(target: Vector4): Vector4;
 
     /**
@@ -309,10 +317,6 @@ export class WebGLRenderer {
     clearStencil(): void;
     clearTarget(renderTarget: WebGLRenderTarget, color: boolean, depth: boolean, stencil: boolean): void;
 
-    /**
-     * @deprecated Use {@link WebGLState#reset .state.reset()} instead.
-     */
-    resetGLState(): void;
     dispose(): void;
 
     renderBufferDirect(
@@ -321,7 +325,7 @@ export class WebGLRenderer {
         geometry: BufferGeometry,
         material: Material,
         object: Object3D,
-        geometryGroup: any,
+        group: GeometryGroup,
     ): void;
 
     /**
@@ -330,11 +334,6 @@ export class WebGLRenderer {
      */
     setAnimationLoop(callback: XRFrameRequestCallback | null): void;
 
-    /**
-     * @deprecated Use {@link WebGLRenderer#setAnimationLoop .setAnimationLoop()} instead.
-     */
-    animate(callback: () => void): void;
-
     /**
      * Compiles all materials in the scene with the camera. This is useful to precompile shaders before the first
      * rendering. If you want to add a 3D object to an existing scene, use the third optional parameter for applying the
@@ -378,11 +377,6 @@ export class WebGLRenderer {
      */
     getRenderTarget(): WebGLRenderTarget | null;
 
-    /**
-     * @deprecated Use {@link WebGLRenderer#getRenderTarget .getRenderTarget()} instead.
-     */
-    getCurrentRenderTarget(): WebGLRenderTarget | null;
-
     /**
      * Sets the active render target.
      *
@@ -472,69 +466,4 @@ export class WebGLRenderer {
      * Can be used to reset the internal WebGL state.
      */
     resetState(): void;
-
-    /**
-     * @deprecated Use {@link WebGLRenderer#xr .xr} instead.
-     */
-    vr: boolean;
-
-    /**
-     * @deprecated Use {@link WebGLShadowMap#enabled .shadowMap.enabled} instead.
-     */
-    shadowMapEnabled: boolean;
-
-    /**
-     * @deprecated Use {@link WebGLShadowMap#type .shadowMap.type} instead.
-     */
-    shadowMapType: ShadowMapType;
-
-    /**
-     * @deprecated Use {@link WebGLShadowMap#cullFace .shadowMap.cullFace} instead.
-     */
-    shadowMapCullFace: CullFace;
-
-    /**
-     * @deprecated Use {@link WebGLExtensions#get .extensions.get( 'OES_texture_float' )} instead.
-     */
-    supportsFloatTextures(): any;
-
-    /**
-     * @deprecated Use {@link WebGLExtensions#get .extensions.get( 'OES_texture_half_float' )} instead.
-     */
-    supportsHalfFloatTextures(): any;
-
-    /**
-     * @deprecated Use {@link WebGLExtensions#get .extensions.get( 'OES_standard_derivatives' )} instead.
-     */
-    supportsStandardDerivatives(): any;
-
-    /**
-     * @deprecated Use {@link WebGLExtensions#get .extensions.get( 'WEBGL_compressed_texture_s3tc' )} instead.
-     */
-    supportsCompressedTextureS3TC(): any;
-
-    /**
-     * @deprecated Use {@link WebGLExtensions#get .extensions.get( 'WEBGL_compressed_texture_pvrtc' )} instead.
-     */
-    supportsCompressedTexturePVRTC(): any;
-
-    /**
-     * @deprecated Use {@link WebGLExtensions#get .extensions.get( 'EXT_blend_minmax' )} instead.
-     */
-    supportsBlendMinMax(): any;
-
-    /**
-     * @deprecated Use {@link WebGLCapabilities#vertexTextures .capabilities.vertexTextures} instead.
-     */
-    supportsVertexTextures(): any;
-
-    /**
-     * @deprecated Use {@link WebGLExtensions#get .extensions.get( 'ANGLE_instanced_arrays' )} instead.
-     */
-    supportsInstancedArrays(): any;
-
-    /**
-     * @deprecated Use {@link WebGLRenderer#setScissorTest .setScissorTest()} instead.
-     */
-    enableScissorTest(boolean: any): any;
 }

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

@@ -1,22 +1,18 @@
 import Info from "./Info.js";
-import Nodes from "./nodes/Nodes.js";
+import NodeManager from "./nodes/NodeManager.js";
 import Renderer from "./Renderer.js";
+
 export interface AnimationContext {
     requestAnimationFrame(callback: FrameRequestCallback, xrFrame?: XRFrame): number;
     cancelAnimationFrame(handle: number): void;
 }
+
 /**
  * This module manages the internal animation loop of the renderer.
  *
  * @private
  */
 declare class Animation {
-    renderer: Renderer;
-    nodes: Nodes;
-    info: Info;
-    _context: AnimationContext | null;
-    _animationLoop: ((time: DOMHighResTimeStamp, xrFrame?: XRFrame) => void) | null;
-    _requestId: number | null;
     /**
      * Constructs a new animation loop management component.
      *
@@ -24,7 +20,47 @@ declare class Animation {
      * @param {Nodes} nodes - Renderer component for managing nodes related logic.
      * @param {Info} info - Renderer component for managing metrics and monitoring data.
      */
-    constructor(renderer: Renderer, nodes: Nodes, info: Info);
+    constructor(renderer: Renderer, nodes: NodeManager, info: Info);
+    /**
+     * A reference to the main renderer.
+     *
+     * @type {Renderer}
+     */
+    renderer: Renderer;
+    /**
+     * Renderer component for managing nodes related logic.
+     *
+     * @type {Nodes}
+     */
+    nodes: NodeManager;
+    /**
+     * Renderer component for managing metrics and monitoring data.
+     *
+     * @type {Info}
+     */
+    info: Info;
+    /**
+     * A reference to the context from `requestAnimationFrame()` can
+     * be called (usually `window`).
+     *
+     * @type {?(Window|XRSession)}
+     */
+    _context: AnimationContext | null;
+    /**
+     * The user-defined animation loop.
+     *
+     * @type {?Function}
+     * @default null
+     */
+    _animationLoop: ((time: DOMHighResTimeStamp, xrFrame?: XRFrame) => void) | null;
+    /**
+     * The requestId which is returned from the `requestAnimationFrame()` call.
+     * Can be used to cancel the stop the animation loop.
+     *
+     * @type {?number}
+     * @default null
+     */
+    _requestId: number | null;
     /**
      * Starts the internal animation loop.
      */
@@ -50,7 +86,7 @@ declare class Animation {
      *
      * @return {Window|XRSession} The animation context.
      */
-    getContext(): AnimationContext | null;
+    getContext(): AnimationContext;
     /**
      * Defines the context in which `requestAnimationFrame()` is executed.
      *
@@ -62,4 +98,5 @@ declare class Animation {
      */
     dispose(): void;
 }
+
 export default Animation;

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

@@ -2,37 +2,34 @@ import { BufferAttribute } from "../../core/BufferAttribute.js";
 import { InterleavedBuffer } from "../../core/InterleavedBuffer.js";
 import { InterleavedBufferAttribute } from "../../core/InterleavedBufferAttribute.js";
 import Backend from "./Backend.js";
-import { AttributeType } from "./Constants.js";
 import DataMap from "./DataMap.js";
-interface Data {
-    version?: number | undefined;
-}
+
 /**
  * This renderer module manages geometry attributes.
  *
  * @private
  * @augments DataMap
  */
-declare class Attributes extends DataMap<{
-    attribute: {
-        key: BufferAttribute | InterleavedBufferAttribute;
-        value: Data;
-    };
-}> {
-    backend: Backend;
+declare class Attributes extends DataMap {
     /**
      * Constructs a new attribute management component.
      *
      * @param {Backend} backend - The renderer's backend.
      */
     constructor(backend: Backend);
+    /**
+     * The renderer's backend.
+     *
+     * @type {Backend}
+     */
+    backend: Backend;
     /**
      * Deletes the data for the given attribute.
      *
      * @param {BufferAttribute} attribute - The attribute.
      * @return {?Object} The deleted attribute data.
      */
-    delete(attribute: BufferAttribute | InterleavedBufferAttribute): Data;
+    delete(attribute: BufferAttribute | InterleavedBufferAttribute): unknown;
     /**
      * Updates the given attribute. This method creates attribute buffers
      * for new attributes and updates data for existing ones.
@@ -40,7 +37,7 @@ declare class Attributes extends DataMap<{
      * @param {BufferAttribute} attribute - The attribute to update.
      * @param {number} type - The attribute type.
      */
-    update(attribute: BufferAttribute | InterleavedBufferAttribute, type: AttributeType): void;
+    update(attribute: BufferAttribute | InterleavedBufferAttribute, type: number): void;
     /**
      * Utility method for handling interleaved buffer attributes correctly.
      * To process them, their `InterleavedBuffer` is returned.
@@ -50,4 +47,5 @@ declare class Attributes extends DataMap<{
      */
     _getBufferAttribute(attribute: BufferAttribute | InterleavedBufferAttribute): BufferAttribute | InterleavedBuffer;
 }
+
 export default Attributes;

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

@@ -7,8 +7,6 @@ declare module "../../core/Object3D.js" {
         count?: number | undefined;
         // See https://github.com/mrdoob/three.js/pull/26335
         occlusionTest?: boolean | undefined;
-        // https://github.com/mrdoob/three.js/pull/29386
-        static?: boolean | undefined;
     }
 }
 

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

@@ -1,35 +1,36 @@
-import { Mesh } from "../../objects/Mesh.js";
 import { Scene } from "../../scenes/Scene.js";
 import DataMap from "./DataMap.js";
-import Nodes from "./nodes/Nodes.js";
+import NodeManager from "./nodes/NodeManager.js";
 import RenderContext from "./RenderContext.js";
 import Renderer from "./Renderer.js";
 import RenderList from "./RenderList.js";
-interface SceneData {
-    backgroundMesh?: Mesh;
-    backgroundCacheKey: string;
-}
+
 /**
  * This renderer module manages the background.
  *
  * @private
  * @augments DataMap
  */
-declare class Background extends DataMap<{
-    scene: {
-        key: Scene;
-        value: SceneData;
-    };
-}> {
-    renderer: Renderer;
-    nodes: Nodes;
+declare class Background extends DataMap {
     /**
      * Constructs a new background management component.
      *
      * @param {Renderer} renderer - The renderer.
      * @param {Nodes} nodes - Renderer component for managing nodes related logic.
      */
-    constructor(renderer: Renderer, nodes: Nodes);
+    constructor(renderer: Renderer, nodes: NodeManager);
+    /**
+     * The renderer.
+     *
+     * @type {Renderer}
+     */
+    renderer: Renderer;
+    /**
+     * Renderer component for managing nodes related logic.
+     *
+     * @type {Nodes}
+     */
+    nodes: NodeManager;
     /**
      * Updates the background for the given scene. Depending on how `Scene.background`
      * or `Scene.backgroundNode` are configured, this method might configure a simple clear
@@ -42,4 +43,5 @@ declare class Background extends DataMap<{
      */
     update(scene: Scene, renderList: RenderList, renderContext: RenderContext): void;
 }
+
 export default Background;

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

@@ -1,5 +1,5 @@
 import Binding from "./Binding.js";
-import NodeUniformsGroup from "./nodes/NodeUniformsGroup.js";
+
 /**
  * A bind group represents a collection of bindings and thus a collection
  * or resources. Bind groups are assigned to pipelines to provide them
@@ -8,24 +8,38 @@ import NodeUniformsGroup from "./nodes/NodeUniformsGroup.js";
  * @private
  */
 declare class BindGroup {
-    name: string;
-    bindings: NodeUniformsGroup[] | Binding[];
-    index: number;
-    bindingsReference: NodeUniformsGroup[] | BindGroup;
-    id: number;
     /**
      * Constructs a new bind group.
      *
      * @param {string} name - The bind group's name.
      * @param {Array<Binding>} bindings - An array of bindings.
      * @param {number} index - The group index.
-     * @param {Array<Binding>} bindingsReference - An array of reference bindings.
      */
-    constructor(
-        name?: string,
-        bindings?: NodeUniformsGroup[],
-        index?: number,
-        bindingsReference?: NodeUniformsGroup[] | BindGroup,
-    );
+    constructor(name?: string, bindings?: Binding[], index?: number);
+    /**
+     * The bind group's name.
+     *
+     * @type {string}
+     */
+    name: string;
+    /**
+     * An array of bindings.
+     *
+     * @type {Array<Binding>}
+     */
+    bindings: Binding[];
+    /**
+     * The group index.
+     *
+     * @type {number}
+     */
+    index: number;
+    /**
+     * The group's ID.
+     *
+     * @type {number}
+     */
+    id: number;
 }
+
 export default BindGroup;

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

@@ -8,25 +8,43 @@
  * @private
  */
 declare class Binding {
-    name: string;
-    visibility: number;
     /**
      * Constructs a new binding.
      *
      * @param {string} [name=''] - The binding's name.
      */
     constructor(name?: string);
+    /**
+     * The binding's name.
+     *
+     * @type {string}
+     */
+    name: string;
+    /**
+     * A bitmask that defines in what shader stages the
+     * binding's resource is accessible.
+     *
+     * @type {number}
+     */
+    visibility: number;
     /**
      * Makes sure binding's resource is visible for the given shader stage.
      *
      * @param {number} visibility - The shader stage.
      */
     setVisibility(visibility: number): void;
+    /**
+     * The shader stages in which the binding's resource is visible.
+     *
+     * @return {number} The visibility bitmask.
+     */
+    getVisibility(): number;
     /**
      * Clones the binding.
      *
      * @return {Binding} The cloned binding.
      */
-    clone(): Binding & this;
+    clone(): Binding;
 }
+
 export default Binding;

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

@@ -4,20 +4,18 @@ import Backend from "./Backend.js";
 import BindGroup from "./BindGroup.js";
 import DataMap from "./DataMap.js";
 import Info from "./Info.js";
-import Nodes from "./nodes/Nodes.js";
+import NodeManager from "./nodes/NodeManager.js";
 import Pipelines from "./Pipelines.js";
 import RenderObject from "./RenderObject.js";
 import Textures from "./Textures.js";
-interface BindGroupData {
-    bindGroup?: BindGroup | undefined;
-}
+
 /**
  * This renderer module manages the bindings of the renderer.
  *
  * @private
  * @augments DataMap
  */
-declare class Bindings extends DataMap<{
+declare class Bindings extends DataMap {
     /**
      * Constructs a new bindings management component.
      *
@@ -28,25 +26,50 @@ declare class Bindings extends DataMap<{
      * @param {Pipelines} pipelines - Renderer component for managing pipelines.
      * @param {Info} info - Renderer component for managing metrics and monitoring data.
      */
-    bindGroup: {
-        key: BindGroup;
-        value: BindGroupData;
-    };
-}> {
-    backend: Backend;
-    textures: Textures;
-    pipelines: Pipelines;
-    attributes: Attributes;
-    nodes: Nodes;
-    info: Info;
     constructor(
         backend: Backend,
-        nodes: Nodes,
+        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 {Nodes}
+     */
+    nodes: NodeManager;
+    /**
+     * Renderer component for managing metrics and monitoring data.
+     *
+     * @type {Info}
+     */
+    info: Info;
     /**
      * Returns the bind groups for the given render object.
      *
@@ -105,4 +128,5 @@ declare class Bindings extends DataMap<{
      */
     _update(bindGroup: BindGroup, bindings: BindGroup[]): void;
 }
+
 export default Bindings;

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

@@ -0,0 +1,22 @@
+import { Blending, BlendingDstFactor, BlendingEquation, BlendingSrcFactor } from "../../constants.js";
+
+declare class BlendMode {
+    blending: Blending;
+
+    blendSrc: BlendingSrcFactor;
+    blendDst: BlendingDstFactor;
+    blendEquation: BlendingEquation;
+
+    blendSrcAlpha: BlendingSrcFactor | null;
+    blendDstAlpha: BlendingDstFactor | null;
+    blendEquationAlpha: BlendingEquation | null;
+    premultiplyAlpha: boolean;
+
+    constructor(blending: Blending);
+
+    copy(source: BlendMode): this;
+
+    clone(): BlendMode;
+}
+
+export default BlendMode;