@types/three 0.144.0 → 0.147.0

three/src/objects/LOD.d.ts

@@ -8,17 +8,37 @@ export class LOD extends Object3D {
 
     type: 'LOD';
 
-    levels: Array<{ distance: number; object: Object3D }>;
+    /**
+     *
+     * An array of level objects
+     *
+     * Each level is an object with the following properties:
+     *
+     * - object - The Object3D to display at this level.
+     * - distance - The distance at which to display this level of detail.
+     * - hysteresis - Threshold used to avoid flickering at LOD boundaries, as a fraction of distance.
+     */
+    levels: Array<{ distance: number; hysteresis: number; object: Object3D }>;
+
     autoUpdate: boolean;
     readonly isLOD: true;
 
-    addLevel(object: Object3D, distance?: number): this;
+    /**
+     * Adds a mesh that will display at a certain distance and greater. Typically the further away the distance, the lower the detail on the mesh.
+     *
+     * @param object The Object3D to display at this level.
+     * @param distance The distance at which to display this level of detail. Default 0.0.
+     * @param hysteresis Threshold used to avoid flickering at LOD boundaries, as a fraction of distance. Default 0.0.
+     */
+    addLevel(object: Object3D, distance?: number, hysteresis?: number): this;
+
     getCurrentLevel(): number;
     getObjectForDistance(distance: number): Object3D | null;
     raycast(raycaster: Raycaster, intersects: Intersection[]): void;
     update(camera: Camera): void;
     toJSON(meta: any): any;
 
+    // TODO: Remove this
     /**
      * @deprecated Use {@link LOD#levels .levels} instead.
      */

three/src/renderers/WebGL3DRenderTarget.d.ts

@@ -12,7 +12,7 @@ export class WebGL3DRenderTarget extends WebGLRenderTarget {
      * @param height the height of the render target, in pixels.
      * @param depth the depth of the render target.
      */
-    constructor(width: number, height: number, depth: number);
+    constructor(width?: number, height?: number, depth?: number);
 
     /**
      * The depth of the render target.

three/src/renderers/WebGLArrayRenderTarget.d.ts

@@ -12,7 +12,7 @@ export class WebGLArrayRenderTarget extends WebGLRenderTarget {
      * @param height the height of the render target, in pixels.
      * @param depth the depth/layer count of the render target.
      */
-    constructor(width: number, height: number, depth: number);
+    constructor(width?: number, height?: number, depth?: number);
 
     /**
      * The depth of the render target.

three/src/renderers/WebGLCubeRenderTarget.d.ts

@@ -4,7 +4,7 @@ import { Texture } from './../textures/Texture';
 import { CubeTexture } from './../textures/CubeTexture';
 
 export class WebGLCubeRenderTarget extends WebGLRenderTarget {
-    constructor(size: number, options?: WebGLRenderTargetOptions);
+    constructor(size?: number, options?: WebGLRenderTargetOptions);
 
     texture: CubeTexture;
 

three/src/renderers/WebGLMultipleRenderTargets.d.ts

@@ -18,7 +18,7 @@ export class WebGLMultipleRenderTargets extends EventDispatcher {
      * @param options object that holds texture parameters for an auto-generated target texture and depthBuffer/stencilBuffer booleans.
      * For an explanation of the texture parameters see {@link Texture}.
      */
-    constructor(width: number, height: number, count: number, options?: WebGLRenderTargetOptions);
+    constructor(width?: number, height?: number, count?: number, options?: WebGLRenderTargetOptions);
 
     setSize(width: number, height: number, depth?: number): this;
     copy(source: WebGLMultipleRenderTargets): this;

three/src/renderers/WebGLRenderTarget.d.ts

@@ -26,7 +26,7 @@ export interface WebGLRenderTargetOptions {
 }
 
 export class WebGLRenderTarget extends EventDispatcher {
-    constructor(width: number, height: number, options?: WebGLRenderTargetOptions);
+    constructor(width?: number, height?: number, options?: WebGLRenderTargetOptions);
 
     width: number;
     height: number;

three/src/renderers/WebGLRenderer.d.ts

@@ -17,7 +17,7 @@ import { Material } from './../materials/Material';
 import { ToneMapping, ShadowMapType, CullFace, TextureEncoding } from '../constants';
 import { WebXRManager } from '../renderers/webxr/WebXRManager';
 import { BufferGeometry } from './../core/BufferGeometry';
-import { Texture } from '../textures/Texture';
+import { OffscreenCanvas, Texture } from '../textures/Texture';
 import { Data3DTexture } from '../textures/Data3DTexture';
 import { Vector3 } from '../math/Vector3';
 import { Box3 } from '../math/Box3';
@@ -31,10 +31,6 @@ export interface Renderer {
     setSize(width: number, height: number, updateStyle?: boolean): void;
 }
 
-/** This is only available in worker JS contexts, not the DOM. */
-// tslint:disable-next-line:no-empty-interface
-export interface OffscreenCanvas extends EventTarget {}
-
 export interface WebGLRendererParameters {
     /**
      * A Canvas where the renderer draws its output.

three/src/renderers/shaders/UniformsLib.d.ts

@@ -19,8 +19,9 @@ export let UniformsLib: {
         envMap: IUniform;
         flipEnvMap: IUniform;
         reflectivity: IUniform;
-        refractionRatio: IUniform;
-        maxMipLevel: IUniform;
+        ior: IUniform;
+        refractRatio: IUniform;
+        backgroundBlurriness: IUniform;
     };
     aomap: {
         aoMap: IUniform;

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

@@ -20,6 +20,7 @@ export class WebGLCapabilities {
     vertexTextures: boolean;
     floatFragmentTextures: boolean;
     floatVertexTextures: boolean;
+    maxSamples: number;
 
     getMaxAnisotropy(): number;
     getMaxPrecision(precision: string): string;

three/src/renderers/webxr/WebXRController.d.ts

@@ -3,7 +3,11 @@ import { Vector3 } from '../../math/Vector3';
 
 export type XRControllerEventType = XRSessionEventType | XRInputSourceEventType | 'disconnected' | 'connected';
 
-export type XRHandJoints = Record<XRHandJoint, number>;
+export class XRJointSpace extends Group {
+    readonly jointRadius: number | undefined;
+}
+
+export type XRHandJoints = Record<XRHandJoint, XRJointSpace>;
 
 export interface XRHandInputState {
     pinching: boolean;
@@ -35,6 +39,7 @@ export class WebXRController {
     getTargetRaySpace(): XRTargetRaySpace;
     getGripSpace(): XRGripSpace;
     dispatchEvent(event: { type: XRControllerEventType; data?: XRInputSource }): this;
+    connect(inputSource: XRInputSource): this;
     disconnect(inputSource: XRInputSource): this;
     update(inputSource: XRInputSource, frame: XRFrame, referenceSpace: XRReferenceSpace): this;
 }

three/src/renderers/webxr/WebXRManager.d.ts

@@ -1,3 +1,5 @@
+// https://threejs.org/docs/#api/en/renderers/webxr/WebXRManager
+
 /// <reference types="webxr" />
 
 import { Vector4 } from '../../math/Vector4';
@@ -44,5 +46,11 @@ export class WebXRManager extends EventDispatcher {
     setAnimationLoop(callback: XRFrameRequestCallback | null): void;
     getFoveation(): number | undefined;
     setFoveation(foveation: number): void;
+
+    /**
+     * Returns the set of planes detected by WebXR's plane detection API.
+     */
+    getPlanes(): Set<XRPlane>;
+
     dispose(): void;
 }

three/src/scenes/Scene.d.ts

@@ -1,3 +1,5 @@
+// https://threejs.org/docs/?q=scene#api/en/scenes/Scene
+
 import { FogBase } from './Fog';
 import { Material } from './../materials/Material';
 import { Object3D } from './../core/Object3D';
@@ -23,15 +25,24 @@ export class Scene extends Object3D {
     fog: FogBase | null;
 
     /**
-     * If not null, it will force everything in the scene to be rendered with that material. Default is null.
-     * @default null
+     * Sets the blurriness of the background. Only influences environment maps assigned to Scene.background. Valid input is a float between 0 and 1.
+     *
+     * @default 0
      */
-    overrideMaterial: Material | null;
+    backgroundBlurriness: number;
+
+    /**
+     * Attenuates the color of the background. Only applies to background textures.
+     *
+     * @default 1
+     */
+    backgroundIntensity: number;
 
     /**
-     * @default true
+     * If not null, it will force everything in the scene to be rendered with that material. Default is null.
+     * @default null
      */
-    autoUpdate: boolean;
+    overrideMaterial: Material | null;
 
     /**
      * @default null

three/src/textures/CanvasTexture.d.ts

@@ -1,4 +1,4 @@
-import { Texture } from './Texture';
+import { OffscreenCanvas, Texture } from './Texture';
 import { Mapping, Wrapping, TextureFilter, PixelFormat, TextureDataType } from '../constants';
 
 export class CanvasTexture extends Texture {
@@ -15,7 +15,7 @@ export class CanvasTexture extends Texture {
      * @param [encoding=THREE.LinearEncoding]
      */
     constructor(
-        canvas: HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageBitmap,
+        canvas: TexImageSource | OffscreenCanvas,
         mapping?: Mapping,
         wrapS?: Wrapping,
         wrapT?: Wrapping,

three/src/textures/CompressedArrayTexture.d.ts

@@ -0,0 +1,17 @@
+import { CompressedPixelFormat, TextureDataType, Wrapping } from '../constants';
+import { CompressedTexture } from './CompressedTexture.js';
+
+export class CompressedArrayTexture extends CompressedTexture {
+    isCompressedArrayTexture: true;
+
+    wrapR: Wrapping;
+
+    constructor(
+        mipmaps: ImageData[],
+        width: number,
+        height: number,
+        depth: number,
+        format?: CompressedPixelFormat,
+        type?: TextureDataType,
+    );
+}

three/src/textures/Texture.d.ts

@@ -1,3 +1,5 @@
+// https://threejs.org/docs/?q=texture#api/en/textures/Texture
+
 import { Vector2 } from './../math/Vector2';
 import { Matrix3 } from './../math/Matrix3';
 import { Source } from './Source';
@@ -12,6 +14,10 @@ import {
     TextureEncoding,
 } from '../constants';
 
+/** Shim for OffscreenCanvas. */
+// tslint:disable-next-line:no-empty-interface
+export interface OffscreenCanvas extends EventTarget {}
+
 export class Texture extends EventDispatcher {
     /**
      * @param [image]
@@ -22,11 +28,11 @@ export class Texture extends EventDispatcher {
      * @param [minFilter=THREE.LinearMipmapLinearFilter]
      * @param [format=THREE.RGBAFormat]
      * @param [type=THREE.UnsignedByteType]
-     * @param [anisotropy=1]
+     * @param [anisotropy=THREE.Texture.DEFAULT_ANISOTROPY]
      * @param [encoding=THREE.LinearEncoding]
      */
     constructor(
-        image?: HTMLImageElement | HTMLCanvasElement | HTMLVideoElement,
+        image?: TexImageSource | OffscreenCanvas,
         mapping?: Mapping,
         wrapS?: Wrapping,
         wrapT?: Wrapping,
@@ -199,6 +205,8 @@ export class Texture extends EventDispatcher {
     readonly isTexture: true;
 
     onUpdate: () => void;
+
+    static DEFAULT_ANISOTROPY: number;
     static DEFAULT_IMAGE: any;
     static DEFAULT_MAPPING: any;
 

three/examples/jsm/nodes/core/NodeVary.d.ts

@@ -1,6 +0,0 @@
-export default class NodeVary {
-    name: string;
-    type: string;
-    isNodeVary: boolean;
-    constructor(name: string, type: string);
-}

three/examples/jsm/shaders/PixelShader.d.ts

@@ -1,11 +0,0 @@
-import { IUniform } from '../../../src/Three';
-
-export const PixelShader: {
-    uniforms: {
-        tDiffuse: IUniform;
-        resolution: IUniform;
-        pixelSize: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};