@types/three 0.184.1 → 0.185.0

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

@@ -9,9 +9,7 @@ import { Quaternion } from "../../math/Quaternion.js";
 import { Vector3 } from "../../math/Vector3.js";
 import { Mesh } from "../../objects/Mesh.js";
 import { XRGripSpace, XRHandSpace, XRTargetRaySpace } from "../webxr/WebXRController.js";
-import QuadMesh from "./QuadMesh.js";
 import Renderer from "./Renderer.js";
-import { XRRenderTarget } from "./XRRenderTarget.js";
 
 export interface XRManagerEventMap {
     sessionstart: {};
@@ -25,11 +23,11 @@ export interface LayerAttributes {
     stencil?: boolean | undefined;
 }
 
+interface XRGPUBinding {}
+
 /**
  * The XR manager is built on top of the WebXR Device API to
- * manage XR sessions with `WebGPURenderer`.
- *
- * XR is currently only supported with a WebGL 2 backend.
+ * manage XR sessions with renderer backends.
  *
  * @augments EventDispatcher
  */
@@ -63,291 +61,6 @@ declare class XRManager<TEventMap extends XRManagerEventMap = XRManagerEventMap>
      * @default true
      */
     cameraAutoUpdate: boolean;
-    /**
-     * The renderer.
-     *
-     * @private
-     * @type {Renderer}
-     */
-    private _renderer;
-    /**
-     * Represents the camera for the left eye.
-     *
-     * @private
-     * @type {PerspectiveCamera}
-     */
-    private _cameraL;
-    /**
-     * Represents the camera for the right eye.
-     *
-     * @private
-     * @type {PerspectiveCamera}
-     */
-    private _cameraR;
-    /**
-     * A list of cameras used for rendering the XR views.
-     *
-     * @private
-     * @type {Array<Camera>}
-     */
-    private _cameras;
-    /**
-     * The main XR camera.
-     *
-     * @private
-     * @type {ArrayCamera}
-     */
-    private _cameraXR;
-    /**
-     * The current near value of the XR camera.
-     *
-     * @private
-     * @type {?number}
-     * @default null
-     */
-    private _currentDepthNear;
-    /**
-     * The current far value of the XR camera.
-     *
-     * @private
-     * @type {?number}
-     * @default null
-     */
-    private _currentDepthFar;
-    /**
-     * A list of WebXR controllers requested by the application.
-     *
-     * @private
-     * @type {Array<WebXRController>}
-     */
-    private _controllers;
-    /**
-     * A list of XR input source. Each input source belongs to
-     * an instance of WebXRController.
-     *
-     * @private
-     * @type {Array<XRInputSource?>}
-     */
-    private _controllerInputSources;
-    /**
-     * The XR render target that represents the rendering destination
-     * during an active XR session.
-     *
-     * @private
-     * @type {?RenderTarget}
-     * @default null
-     */
-    private _xrRenderTarget;
-    /**
-     * An array holding all the non-projection layers
-     *
-     * @private
-     * @type {Array<Object>}
-     * @default []
-     */
-    private _layers;
-    /**
-     * Whether the XR session uses layers.
-     *
-     * @private
-     * @type {boolean}
-     * @default false
-     */
-    private _sessionUsesLayers;
-    /**
-     * Whether the device supports binding gl objects.
-     *
-     * @private
-     * @type {boolean}
-     * @readonly
-     */
-    private readonly _supportsGlBinding;
-    /**
-     * Helper function to create native WebXR Layer.
-     *
-     * @private
-     * @type {Function}
-     */
-    private _createXRLayer;
-    /**
-     * The current WebGL context.
-     *
-     * @private
-     * @type {?WebGL2RenderingContext}
-     * @default null
-     */
-    private _gl;
-    /**
-     * The current animation context.
-     *
-     * @private
-     * @type {?Window}
-     * @default null
-     */
-    private _currentAnimationContext;
-    /**
-     * The current animation loop.
-     *
-     * @private
-     * @type {?Function}
-     * @default null
-     */
-    private _currentAnimationLoop;
-    /**
-     * The current pixel ratio.
-     *
-     * @private
-     * @type {?number}
-     * @default null
-     */
-    private _currentPixelRatio;
-    /**
-     * The current size of the renderer's canvas
-     * in logical pixel unit.
-     *
-     * @private
-     * @type {Vector2}
-     */
-    private _currentSize;
-    /**
-     * The default event listener for handling events inside a XR session.
-     *
-     * @private
-     * @type {Function}
-     */
-    private _onSessionEvent;
-    /**
-     * The event listener for handling the end of a XR session.
-     *
-     * @private
-     * @type {Function}
-     */
-    private _onSessionEnd;
-    /**
-     * The event listener for handling the `inputsourceschange` event.
-     *
-     * @private
-     * @type {Function}
-     */
-    private _onInputSourcesChange;
-    /**
-     * The animation loop which is used as a replacement for the default
-     * animation loop of the application. It is only used when a XR session
-     * is active.
-     *
-     * @private
-     * @type {Function}
-     */
-    private _onAnimationFrame;
-    /**
-     * The current XR reference space.
-     *
-     * @private
-     * @type {?XRReferenceSpace}
-     * @default null
-     */
-    private _referenceSpace;
-    /**
-     * The current XR reference space type.
-     *
-     * @private
-     * @type {XRReferenceSpaceType}
-     * @default 'local-floor'
-     */
-    private _referenceSpaceType;
-    /**
-     * A custom reference space defined by the application.
-     *
-     * @private
-     * @type {?XRReferenceSpace}
-     * @default null
-     */
-    private _customReferenceSpace;
-    /**
-     * The framebuffer scale factor.
-     *
-     * @private
-     * @type {number}
-     * @default 1
-     */
-    private _framebufferScaleFactor;
-    /**
-     * The foveation factor.
-     *
-     * @private
-     * @type {number}
-     * @default 1
-     */
-    private _foveation;
-    /**
-     * A reference to the current XR session.
-     *
-     * @private
-     * @type {?XRSession}
-     * @default null
-     */
-    private _session;
-    /**
-     * A reference to the current XR base layer.
-     *
-     * @private
-     * @type {?XRWebGLLayer}
-     * @default null
-     */
-    private _glBaseLayer;
-    /**
-     * A reference to the current XR binding.
-     *
-     * @private
-     * @type {?XRWebGLBinding}
-     * @default null
-     */
-    private _glBinding;
-    /**
-     * A reference to the current XR projection layer.
-     *
-     * @private
-     * @type {?XRProjectionLayer}
-     * @default null
-     */
-    private _glProjLayer;
-    /**
-     * A reference to the current XR frame.
-     *
-     * @private
-     * @type {?XRFrame}
-     * @default null
-     */
-    private _xrFrame;
-    /**
-     * Whether the browser supports the APIs necessary to use XRProjectionLayers.
-     *
-     * Note: this does not represent XRSession explicitly requesting
-     * `'layers'` as a feature - see `_sessionUsesLayers` and #30112
-     *
-     * @private
-     * @type {boolean}
-     * @readonly
-     */
-    private readonly _supportsLayers;
-    /**
-     * Whether the usage of multiview has been requested by the application or not.
-     *
-     * @private
-     * @type {boolean}
-     * @default false
-     * @readonly
-     */
-    private readonly _useMultiviewIfPossible;
-    /**
-     * Whether the usage of multiview is actually enabled. This flag only evaluates to `true`
-     * if multiview has been requested by the application and the `OVR_multiview2` is available.
-     *
-     * @private
-     * @type {boolean}
-     * @readonly
-     */
-    private readonly _useMultiview;
     /**
      * Returns an instance of `THREE.Group` that represents the transformation
      * of a XR controller in target ray space. The requested controller is defined
@@ -378,7 +91,7 @@ declare class XRManager<TEventMap extends XRManagerEventMap = XRManagerEventMap>
     /**
      * Returns the foveation value.
      *
-     * @return {number|undefined} The foveation value. Returns `undefined` if no base or projection layer is defined.
+     * @return {number|undefined} The foveation value.
      */
     getFoveation(): number | undefined;
     /**
@@ -440,6 +153,15 @@ declare class XRManager<TEventMap extends XRManagerEventMap = XRManagerEventMap>
      * @return {'opaque'|'additive'|'alpha-blend'|undefined} The environment blend mode. Returns `undefined` when used outside of a XR session.
      */
     getEnvironmentBlendMode(): XREnvironmentBlendMode | undefined;
+    /**
+     * Returns the current base layer.
+     *
+     * This is an `XRProjectionLayer` when the targeted XR device supports the
+     * WebXR Layers API, or an `XRWebGLLayer` otherwise.
+     *
+     * @return {?(XRWebGLLayer|XRProjectionLayer)} The XR base layer.
+     */
+    getBaseLayer(): (XRWebGLLayer | XRProjectionLayer) | null;
     /**
      * Returns the current XR binding.
      *
@@ -449,6 +171,25 @@ declare class XRManager<TEventMap extends XRManagerEventMap = XRManagerEventMap>
      * @return {?XRWebGLBinding} The XR binding. Returns `null` if one cannot be created.
      */
     getBinding(): XRWebGLBinding | null;
+    /**
+     * Applies WebXR fixed foveation to the internal post-processing render target
+     * used by the first XR render pass before compositing into a projection layer.
+     *
+     * Browser-side `XRWebGLBinding.foveateBoundTexture()` failures are treated as
+     * non-fatal so they do not interrupt rendering.
+     *
+     * @param {RenderTarget} renderTarget - The internal render target.
+     */
+    foveateBoundTexture(renderTarget: RenderTarget): void;
+    /**
+     * Returns the current XR WebGPU binding.
+     *
+     * Creates a new binding if needed and the browser is
+     * capable of doing so.
+     *
+     * @return {?XRGPUBinding} The XR WebGPU binding. Returns `null` if one cannot be created.
+     */
+    getWebGPUBinding(): XRGPUBinding | null;
     /**
      * Returns the current XR frame.
      *
@@ -544,14 +285,6 @@ declare class XRManager<TEventMap extends XRManagerEventMap = XRManagerEventMap>
      * @param {PerspectiveCamera} camera - The camera.
      */
     updateCamera(camera: PerspectiveCamera): void;
-    /**
-     * Returns a WebXR controller for the given controller index.
-     *
-     * @private
-     * @param {number} index - The controller index.
-     * @return {WebXRController} The XR controller.
-     */
-    private _getController;
 }
 
 export default XRManager;

three/src/renderers/common/nodes/NodeLibrary.d.ts

@@ -1,10 +1,3 @@
-import { ToneMapping } from "../../../constants.js";
-import { Light } from "../../../lights/Light.js";
-import { Material } from "../../../materials/Material.js";
-import NodeMaterial from "../../../materials/nodes/NodeMaterial.js";
-import Node from "../../../nodes/core/Node.js";
-import AnalyticLightNode from "../../../nodes/lighting/AnalyticLightNode.js";
-
 /**
  * The purpose of a node library is to assign node implementations
  * to existing library features. In `WebGPURenderer` lights, materials
@@ -14,116 +7,6 @@ import AnalyticLightNode from "../../../nodes/lighting/AnalyticLightNode.js";
  * @private
  */
 declare class NodeLibrary {
-    /**
-     * A weak map that maps lights to light nodes.
-     *
-     * @type {WeakMap<Light.constructor,AnalyticLightNode.constructor>}
-     */
-    lightNodes: WeakMap<{
-        new(): Light;
-    }, {
-        new(light: Light): AnalyticLightNode<Light>;
-    }>;
-    /**
-     * A map that maps materials to node materials.
-     *
-     * @type {Map<string,NodeMaterial.constructor>}
-     */
-    materialNodes: Map<string, {
-        new(): NodeMaterial;
-    }>;
-    /**
-     * A map that maps tone mapping techniques (constants)
-     * to tone mapping node functions.
-     *
-     * @type {Map<number,Function>}
-     */
-    toneMappingNodes: Map<ToneMapping, (color: Node, exposure: Node) => Node>;
-    /**
-     * Returns a matching node material instance for the given material object.
-     *
-     * This method also assigns/copies the properties of the given material object
-     * to the node material. This is done to make sure the current material
-     * configuration carries over to the node version.
-     *
-     * @param {Material} material - A material.
-     * @return {NodeMaterial} The corresponding node material.
-     */
-    fromMaterial(material: Material): NodeMaterial;
-    /**
-     * Adds a tone mapping node function for a tone mapping technique (constant).
-     *
-     * @param {Function} toneMappingNode - The tone mapping node function.
-     * @param {number} toneMapping - The tone mapping.
-     */
-    addToneMapping(toneMappingNode: (color: Node, exposure: Node) => Node, toneMapping: ToneMapping): void;
-    /**
-     * Returns a tone mapping node function for a tone mapping technique (constant).
-     *
-     * @param {number} toneMapping - The tone mapping.
-     * @return {?Function} The tone mapping node function. Returns `null` if no node function is found.
-     */
-    getToneMappingFunction(toneMapping: ToneMapping): ((color: Node, exposure: Node) => Node) | null;
-    /**
-     * Returns a node material class definition for a material type.
-     *
-     * @param {string} materialType - The material type.
-     * @return {?NodeMaterial.constructor} The node material class definition. Returns `null` if no node material is found.
-     */
-    getMaterialNodeClass(materialType: string): (new() => NodeMaterial) | null;
-    /**
-     * Adds a node material class definition for a given material type.
-     *
-     * @param {NodeMaterial.constructor} materialNodeClass - The node material class definition.
-     * @param {string} materialClassType - The material type.
-     */
-    addMaterial(materialNodeClass: {
-        new(): NodeMaterial;
-    }, materialClassType: string): void;
-    /**
-     * Returns a light node class definition for a light class definition.
-     *
-     * @param {Light.constructor} light - The light class definition.
-     * @return {?AnalyticLightNode.constructor} The light node class definition. Returns `null` if no light node is found.
-     */
-    getLightNodeClass(light: {
-        new(): Light;
-    }):
-        | ({
-            new(light: Light): AnalyticLightNode<Light>;
-        })
-        | null;
-    /**
-     * Adds a light node class definition for a given light class definition.
-     *
-     * @param {AnalyticLightNode.constructor} lightNodeClass - The light node class definition.
-     * @param {Light.constructor} lightClass - The light class definition.
-     */
-    addLight<TLight extends Light>(lightNodeClass: {
-        new(light: TLight): AnalyticLightNode<TLight>;
-    }, lightClass: {
-        new(): TLight;
-    }): void;
-    /**
-     * Adds a node class definition for the given type to the provided type library.
-     *
-     * @param {Node.constructor} nodeClass - The node class definition.
-     * @param {number|string} type - The object type.
-     * @param {Map<number|string,Node.constructor>} library - The type library.
-     */
-    addType<TNodeClass, TType>(nodeClass: TNodeClass, type: TType, library: Map<TType, TNodeClass>): void;
-    /**
-     * Adds a node class definition for the given class definition to the provided type library.
-     *
-     * @param {Node.constructor} nodeClass - The node class definition.
-     * @param {Node.constructor} baseClass - The class definition.
-     * @param {WeakMap<Node.constructor, Node.constructor>} library - The type library.
-     */
-    addClass<TNodeClass, TBaseClass extends object>(
-        nodeClass: TNodeClass,
-        baseClass: TBaseClass,
-        library: WeakMap<TBaseClass, TNodeClass>,
-    ): void;
 }
 
 export default NodeLibrary;

three/src/renderers/webgl/WebGLPrograms.d.ts

@@ -152,6 +152,8 @@ export interface WebGLProgramParameters {
 
     skinning: boolean;
 
+    hasPositionAttribute: boolean;
+
     morphTargets: boolean;
     morphNormals: boolean;
     morphColors: boolean;

three/src/renderers/webgl/WebGLRenderLists.d.ts

@@ -52,7 +52,11 @@ export class WebGLRenderList {
         z: number,
         group: Group | null,
     ): void;
-    sort(opaqueSort: (a: any, b: any) => number, transparentSort: (a: any, b: any) => number): void;
+    sort(
+        opaqueSort: (a: any, b: any) => number,
+        transparentSort: (a: any, b: any) => number,
+        reversedDepth: boolean,
+    ): void;
     finish(): void;
 }
 

three/src/renderers/webgl/WebGLState.d.ts

@@ -76,6 +76,8 @@ declare class WebGLState {
     activeTexture(webglSlot: number): void;
     bindTexture(webglType: number, webglTexture: WebGLTexture, webglSlot?: number): void;
     unbindTexture(): void;
+    pixelStorei(name: GLenum, value: GLint | GLboolean): void;
+    getParameter(name: GLenum): unknown;
 
     // Same interface as https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/compressedTexImage2D
     compressedTexImage2D(

three/src/renderers/webgl-fallback/WebGLBackend.d.ts

@@ -8,7 +8,7 @@ export interface WebGLBackendParameters extends BackendParameters {
 export default class WebGLBackend extends Backend {
     readonly isWebGLBackend: boolean;
 
-    constructor(parameters?: BackendParameters);
+    constructor(parameters?: WebGLBackendParameters);
 
     get coordinateSystem(): CoordinateSystem;
 

three/src/renderers/webgl-fallback/nodes/GLSLNodeBuilder.d.ts

@@ -1,19 +1,9 @@
 import { Object3D } from "../../../core/Object3D.js";
-import { NodeShaderStage } from "../../../nodes/core/constants.js";
 import NodeBuilder from "../../../nodes/core/NodeBuilder.js";
 import Renderer from "../../common/Renderer.js";
 
 declare class GLSLNodeBuilder extends NodeBuilder {
     constructor(object: Object3D, renderer: Renderer);
-
-    getUniforms(shaderStage: NodeShaderStage): string;
-    getAttributes(shaderStage: NodeShaderStage): string;
-    getVaryings(shaderStage: NodeShaderStage): string;
-    getInstanceIndex(): string;
-    getDrawIndex(): string | null;
-    getFrontFacing(): string;
-    getFragCoord(): string;
-    buildCode(): void;
 }
 
 export default GLSLNodeBuilder;

three/src/renderers/webgpu/nodes/StandardNodeLibrary.d.ts

@@ -18,7 +18,6 @@ import NodeLibrary from "../../common/nodes/NodeLibrary.js";
  * used in {@link WebGPURenderer}. It maps lights, tone mapping
  * techniques and materials to node-based implementations.
  *
- * @private
  * @augments NodeLibrary
  */
 declare class StandardNodeLibrary extends NodeLibrary {