@types/three 0.157.2 → 0.158.1

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const AfterimageShader: {
+    name: string;
     uniforms: {
         damp: IUniform;
         tOld: IUniform;

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

@@ -1,4 +1,5 @@
 export const BasicShader: {
+    name: string;
     uniforms: {};
     vertexShader: string;
     fragmentShader: string;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const BlendShader: {
+    name: string;
     uniforms: {
         tDiffuse1: IUniform;
         tDiffuse2: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const BokehShader: {
+    name: string;
     defines: {
         DEPTH_PACKING: number;
         PERSPECTIVE_CAMERA: number;

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

@@ -27,12 +27,14 @@ export interface BokehShaderUniforms {
 }
 
 export const BokehShader: {
+    name: string;
     uniforms: BokehShaderUniforms;
     vertexShader: string;
     fragmentShader: string;
 };
 
 export const BokehDepthShader: {
+    name: string;
     uniforms: {
         mNear: IUniform;
         mFar: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const BrightnessContrastShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         brightness: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const ColorCorrectionShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         powRGB: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const DOFMipMapShader: {
+    name: string;
     uniforms: {
         tColor: IUniform;
         tDepth: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform, Vector2, Material } from '../../../src/Three.js';
 
 export const DepthLimitedBlurShader: {
+    name: string;
     defines: {
         KERNEL_RADIUS: number;
         DEPTH_PACKING: number;

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

@@ -0,0 +1,11 @@
+import { IUniform, Texture } from '../../../src/Three.js';
+
+export const ExposureShader: {
+    name: 'ExposureShader';
+    uniforms: {
+        tDiffuse: IUniform<Texture | null>;
+        exposure: IUniform<number>;
+    };
+    vertexShader: string;
+    fragmentShader: string;
+};

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const FXAAShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         resolution: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const FocusShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         screenWidth: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const FreiChenShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         aspect: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const GodRaysDepthMaskShader: {
+    name: string;
     uniforms: {
         tInput: IUniform;
     };
@@ -9,6 +10,7 @@ export const GodRaysDepthMaskShader: {
 };
 
 export const GodRaysGenerateShader: {
+    name: string;
     uniforms: {
         tInput: IUniform;
         fStepSize: IUniform;
@@ -19,6 +21,7 @@ export const GodRaysGenerateShader: {
 };
 
 export const GodRaysCombineShader: {
+    name: string;
     uniforms: {
         tColors: IUniform;
         tGodRays: IUniform;
@@ -29,6 +32,7 @@ export const GodRaysCombineShader: {
 };
 
 export const GodRaysFakeSunShader: {
+    name: string;
     uniforms: {
         vSunPositionScreenSpace: IUniform;
         fAspect: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const HalftoneShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         shape: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const HorizontalTiltShiftShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         h: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const HueSaturationShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         hue: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const KaleidoShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         sides: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const LuminosityHighPassShader: {
+    name: string;
     shaderID: string;
     uniforms: {
         tDiffuse: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const LuminosityShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
     };

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

@@ -0,0 +1,15 @@
+import { IUniform } from '../../../src/Three.js';
+
+export const MMDToonShader: {
+    name: string;
+    defines: {
+        TOON: boolean;
+        MATCAP: boolean;
+        MATCAP_BLENDING_ADD: boolean;
+    };
+    uniforms: {
+        [key: string]: IUniform;
+    };
+    vertexShader: string;
+    fragmentShader: string;
+};

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const MirrorShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         side: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const NormalMapShader: {
+    name: string;
     uniforms: {
         heightMap: IUniform;
         resolution: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const OutputShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         toneMappingExposure: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SAOShader: {
+    name: string;
     defines: {
         NUM_SAMPLES: number;
         NUM_RINGS: number;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SMAAEdgesShader: {
+    name: string;
     defines: {
         SMAA_THRESHOLD: string;
     };
@@ -13,6 +14,7 @@ export const SMAAEdgesShader: {
 };
 
 export const SMAAWeightsShader: {
+    name: string;
     defines: {
         SMAA_MAX_SEARCH_STEPS: string;
         SMAA_AREATEX_MAX_DISTANCE: string;
@@ -30,6 +32,7 @@ export const SMAAWeightsShader: {
 };
 
 export const SMAABlendShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         tColor: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SSAOShader: {
+    name: string;
     defines: {
         PERSPECTIVE_CAMERA: number;
         KERNEL_SIZE: number;
@@ -24,6 +25,7 @@ export const SSAOShader: {
 };
 
 export const SSAODepthShader: {
+    name: string;
     defines: {
         PERSPECTIVE_CAMERA: number;
     };
@@ -37,6 +39,7 @@ export const SSAODepthShader: {
 };
 
 export const SSAOBlurShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         resolution: IUniform;

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

@@ -6,6 +6,7 @@ import { Matrix4, Vector2, Texture, IUniform } from '../../../src/Three.js';
 
 export const SSRShader: SSRShader;
 export interface SSRShader {
+    name: string;
     defines: {
         MAX_STEP: number;
         isPerspectiveCamera: boolean;
@@ -35,6 +36,7 @@ export interface SSRShader {
 
 export const SSRDepthShader: SSRDepthShader;
 export interface SSRDepthShader {
+    name: string;
     defines: {
         PERSPECTIVE_CAMERA: number;
     };
@@ -49,6 +51,7 @@ export interface SSRDepthShader {
 
 export const SSRBlurShader: SSRBlurShader;
 export interface SSRBlurShader {
+    name: string;
     uniforms: {
         tDiffuse: IUniform<Texture | null>;
         resolution: IUniform<Vector2>;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SobelOperatorShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         resolution: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SubsurfaceScatteringShader: {
+    name: string;
     uniforms: {
         alphaMap: IUniform;
         ambientLightColor: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const TechnicolorShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
     };

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const TriangleBlurShader: {
+    name: string;
     uniforms: {
         texture: IUniform;
         delta: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const UnpackDepthRGBAShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         opacity: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform, UniformsLib } from '../../../src/Three.js';
 
 export const VelocityShader: {
+    name: string;
     uniforms: (typeof UniformsLib)['common'] &
         (typeof UniformsLib)['displacementmap'] & {
             modelMatrixPrev: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const VerticalTiltShiftShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         v: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const WaterRefractionShader: {
+    name: string;
     uniforms: {
         color: IUniform;
         time: IUniform;

three/examples/jsm/utils/GPUStatsPanel.d.ts

@@ -0,0 +1,12 @@
+import Stats from '../libs/stats.module.js';
+
+export class GPUStatsPanel extends Stats.Panel {
+    context: WebGLRenderingContext | WebGL2RenderingContext;
+    extension: unknown;
+    maxTime: number;
+    activeQueries: number;
+    startQuery: () => void;
+    endQuery: () => void;
+
+    constructor(context: WebGLRenderingContext | WebGL2RenderingContext, name?: string);
+}

three/examples/jsm/utils/TextureUtils.d.ts

@@ -0,0 +1,3 @@
+import { Texture, WebGLRenderer } from 'three';
+
+export function decompress(texture: Texture, maxTextureSize?: number, renderer?: WebGLRenderer): Texture;

three/examples/jsm/utils/WorkerPool.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @author Deepkolos / https://github.com/deepkolos
+ */
+
+export class WorkerPool {
+    pool: number;
+    quene: Array<{
+        resolve: (e: any) => void;
+        msg: any;
+        transfer: Array<Transferable>;
+    }>;
+    workers: Array<Worker>;
+    workersResolve: Array<(e: any) => void>;
+    workerStatus: number;
+
+    constructor(pool?: number);
+
+    _initWorker(workerId: number): void;
+    workerCreator(): Worker;
+    _getIdleWorker(): void;
+    _onMessage(workerId: number, msg: any): void;
+    setWorkerCreator(workerCreator: () => Worker): void;
+    setWorkerLimit(pool: number): void;
+    postMessage(msg: any, transfer?: Array<Transferable>): Promise<MessageEvent>;
+    dispose(): void;
+}

three/examples/jsm/webxr/XRButton.d.ts

@@ -2,5 +2,5 @@ import { WebGLRenderer } from '../../../src/Three.js';
 
 // tslint:disable-next-line:no-unnecessary-class
 export class XRButton {
-    static createButton(renderer: WebGLRenderer): HTMLElement;
+    static createButton(renderer: WebGLRenderer, sessionInit?: XRSessionInit): HTMLElement;
 }

three/examples/jsm/webxr/XREstimatedLight.d.ts

@@ -24,14 +24,46 @@ export class SessionLightProbe {
 }
 
 export interface XREstimatedLightEventMap extends Object3DEventMap {
+    /**
+     * Fires when the estimated lighting values start being updated.
+     */
     estimationstart: {};
+    /**
+     * Fires when the estimated lighting values stop being updated.
+     */
     estimationend: {};
 }
 
+/**
+ * XREstimatedLight uses WebXR's light estimation to create a light probe, a directional light, and (optionally) an
+ * environment map that model the user's real-world environment and lighting.
+ * As WebXR updates the light and environment estimation, XREstimatedLight automatically updates the light probe,
+ * directional light, and environment map.
+ *
+ * It's important to specify `light-estimation` as an optional or required feature when creating the WebXR session,
+ * otherwise the light estimation can't work.
+ *
+ * See {@link https://developer.mozilla.org/en-US/docs/Web/API/XRLightProbe#browser_compatibility here} for browser
+ * compatibility information, as this is still an experimental feature in WebXR.
+ *
+ * To use this, as with all files in the /examples directory, you will have to include the file separately in your HTML.
+ */
 export class XREstimatedLight extends Group<XREstimatedLightEventMap> {
     lightProbe: LightProbe;
+
     directionalLight: DirectionalLight;
+
+    /**
+     * The environment map estimated by WebXR. This is only available if environmentEstimation is `true`.
+     *
+     * It can be used as the {@link Scene.environment}, for {@link MeshStandardMaterial.envMap}, or as the
+     * {@link Scene.background}.
+     */
     environment: Texture;
 
+    /**
+     * @param renderer The renderer used to render the Scene. Mainly used to interact with WebXRManager.
+     * @param environmentEstimation If `true`, use WebXR to estimate an environment map.
+     */
     constructor(renderer: WebGLRenderer, environmentEstimation?: boolean);
 }

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.157.2",
+    "version": "0.158.1",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -26,6 +26,7 @@
         },
         "./examples/fonts/*": "./examples/fonts/*",
         "./examples/jsm/*": "./examples/jsm/*",
+        "./addons": "./examples/jsm/Addons.js",
         "./addons/*": "./examples/jsm/*",
         "./src/*": "./src/*",
         "./nodes": "./examples/jsm/nodes/Nodes.js",
@@ -43,6 +44,6 @@
         "fflate": "~0.6.10",
         "meshoptimizer": "~0.18.1"
     },
-    "typesPublisherContentHash": "793c51304c26c918dd5ee5b103fbcbcf8155af7cb9cceb2837b49309565f40d6",
+    "typesPublisherContentHash": "c899477bcb4613cebb36e4f1a475fdaffd37e5fb970f81884efc36ba7c395649",
     "typeScriptVersion": "4.5"
 }

three/src/cameras/CubeCamera.d.ts

@@ -1,5 +1,4 @@
 import { WebGLCubeRenderTarget } from '../renderers/WebGLCubeRenderTarget.js';
-import { Scene } from '../scenes/Scene.js';
 import { WebGLRenderer } from '../renderers/WebGLRenderer.js';
 import { Object3D } from '../core/Object3D.js';
 import { CoordinateSystem } from '../constants.js';
@@ -65,5 +64,5 @@ export class CubeCamera extends Object3D {
      * @param renderer The current WebGL renderer
      * @param scene The current scene
      */
-    update(renderer: WebGLRenderer, scene: Scene): void;
+    update(renderer: WebGLRenderer, scene: Object3D): void;
 }

three/src/constants.d.ts

@@ -74,7 +74,7 @@ export type BlendingEquation =
     | typeof MinEquation
     | typeof MaxEquation;
 
-// custom blending destination factors
+// custom blending factors
 export const ZeroFactor: 200;
 export const OneFactor: 201;
 export const SrcColorFactor: 202;
@@ -85,6 +85,11 @@ export const DstAlphaFactor: 206;
 export const OneMinusDstAlphaFactor: 207;
 export const DstColorFactor: 208;
 export const OneMinusDstColorFactor: 209;
+export const SrcAlphaSaturateFactor: 210;
+export const ConstantColorFactor: 211;
+export const OneMinusConstantColorFactor: 212;
+export const ConstantAlphaFactor: 213;
+export const OneMinusConstantAlphaFactor: 214;
 export type BlendingDstFactor =
     | typeof ZeroFactor
     | typeof OneFactor
@@ -95,11 +100,12 @@ export type BlendingDstFactor =
     | typeof DstAlphaFactor
     | typeof OneMinusDstAlphaFactor
     | typeof DstColorFactor
-    | typeof OneMinusDstColorFactor;
-
-// custom blending src factors
-export const SrcAlphaSaturateFactor: 210;
-export type BlendingSrcFactor = typeof SrcAlphaSaturateFactor;
+    | typeof OneMinusDstColorFactor
+    | typeof ConstantColorFactor
+    | typeof OneMinusConstantColorFactor
+    | typeof ConstantAlphaFactor
+    | typeof OneMinusConstantAlphaFactor;
+export type BlendingSrcFactor = BlendingDstFactor | typeof SrcAlphaSaturateFactor;
 
 // depth modes
 export const NeverDepth: 0;
@@ -142,6 +148,11 @@ export type ToneMapping =
     | typeof ACESFilmicToneMapping
     | typeof CustomToneMapping;
 
+// Bind modes
+export const AttachedBindMode: 'attached';
+export const DetachedBindMode: 'detached';
+export type BindMode = typeof AttachedBindMode | typeof DetachedBindMode;
+
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////
@@ -462,11 +473,11 @@ export type WebGL2PixelFormat =
 export type PixelFormat = WebGL1PixelFormat | WebGL2PixelFormat;
 
 /**
- * All Texture Pixel Formats Modes for {@link THREE.DeepTexture}.
+ * All Texture Pixel Formats Modes for {@link THREE.DepthTexture}.
  * @see {@link WebGLRenderingContext.texImage2D} for details.
  * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
  */
-export type DeepTexturePixelFormat = typeof DepthFormat | typeof DepthStencilFormat;
+export type DepthTexturePixelFormat = typeof DepthFormat | typeof DepthStencilFormat;
 
 ///////////////////////////////////////////////////////////////////////////////
 // Compressed texture formats
@@ -649,10 +660,10 @@ export type CompressedPixelFormat =
  * All Possible Texture Pixel Formats Modes. For any Type or SubType of Textures.
  * @remarks Note that the texture must have the correct {@link THREE.Texture.type} set, as described in {@link TextureDataType}.
  * @see {@link WebGLRenderingContext.texImage2D} for details.
- * @see {@link PixelFormat} and {@link DeepTexturePixelFormat} and {@link CompressedPixelFormat}
+ * @see {@link PixelFormat} and {@link DepthTexturePixelFormat} and {@link CompressedPixelFormat}
  * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
  */
-export type AnyPixelFormat = PixelFormat | DeepTexturePixelFormat | CompressedPixelFormat;
+export type AnyPixelFormat = PixelFormat | DepthTexturePixelFormat | CompressedPixelFormat;
 
 ///////////////////////////////////////////////////////////////////////////////
 // Loop styles for AnimationAction