@types/three 0.158.3 → 0.159.0

three/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for three (https://threejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.
 
 ### Additional Details
- * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
+ * Last updated: Thu, 30 Nov 2023 20:07:36 GMT
  * Dependencies: [@types/stats.js](https://npmjs.com/package/@types/stats.js), [@types/webxr](https://npmjs.com/package/@types/webxr), [fflate](https://npmjs.com/package/fflate), [meshoptimizer](https://npmjs.com/package/meshoptimizer)
 
 # Credits

three/examples/jsm/Addons.d.ts

@@ -60,6 +60,7 @@ export * from './helpers/LightProbeHelper.js';
 export * from './helpers/OctreeHelper.js';
 export * from './helpers/PositionalAudioHelper.js';
 export * from './helpers/RectAreaLightHelper.js';
+export * from './helpers/TextureHelper.js';
 export * from './helpers/VertexNormalsHelper.js';
 export * from './helpers/VertexTangentsHelper.js';
 export * from './helpers/ViewHelper.js';
@@ -159,7 +160,6 @@ export * from './modifiers/EdgeSplitModifier.js';
 export * from './modifiers/SimplifyModifier.js';
 export * from './modifiers/TessellateModifier.js';
 
-export * from './objects/BatchedMesh.js';
 export * from './objects/GroundProjectedSkybox.js';
 export * from './objects/Lensflare.js';
 export * from './objects/MarchingCubes.js';
@@ -272,6 +272,7 @@ export * from './utils/PackedPhongMaterial.js';
 export * as SceneUtils from './utils/SceneUtils.js';
 export * from './utils/ShadowMapViewer.js';
 export * as SkeletonUtils from './utils/SkeletonUtils.js';
+export * as SortUtils from './utils/SortUtils.js';
 export * from './utils/TextureUtils.js';
 export * from './utils/UVsDebug.js';
 export * from './utils/WorkerPool.js';

three/examples/jsm/cameras/CinematicCamera.d.ts

@@ -7,7 +7,7 @@ import {
     WebGLRenderTarget,
 } from '../../../src/Three.js';
 
-import { BokehShaderUniforms } from './../shaders/BokehShader2.js';
+import { BokehShaderUniforms } from '../shaders/BokehShader2.js';
 
 export class CinematicCamera extends PerspectiveCamera {
     constructor(fov: number, aspect: number, near: number, far: number);

three/examples/jsm/helpers/TextureHelper.d.ts

@@ -0,0 +1,10 @@
+import { Mesh, Texture } from '../../../src/Three.js';
+
+export class TextureHelper extends Mesh {
+    texture: Texture;
+    type: 'TextureHelper';
+
+    constructor(texture: Texture, width?: number, height?: number, depth?: number);
+
+    dispose(): void;
+}

three/examples/jsm/lines/LineMaterial.d.ts

@@ -1,8 +1,8 @@
-import { Color, MaterialParameters, ShaderMaterial, Vector2 } from '../../../src/Three.js';
+import { Color, ColorRepresentation, MaterialParameters, ShaderMaterial, Vector2 } from '../../../src/Three.js';
 
 export interface LineMaterialParameters extends MaterialParameters {
     alphaToCoverage?: boolean | undefined;
-    color?: number | undefined;
+    color?: ColorRepresentation | undefined;
     dashed?: boolean | undefined;
     dashScale?: number | undefined;
     dashSize?: number | undefined;

three/examples/jsm/loaders/ColladaLoader.d.ts

@@ -1,4 +1,4 @@
-import { Loader, LoadingManager, Scene } from '../../../src/Three.js';
+import { Loader, Scene } from '../../../src/Three.js';
 
 export interface Collada {
     kinematics: object;
@@ -7,7 +7,5 @@ export interface Collada {
 }
 
 export class ColladaLoader extends Loader<Collada> {
-    constructor(manager?: LoadingManager);
-
     parse(text: string, path: string): Collada;
 }

three/examples/jsm/loaders/GLTFLoader.d.ts

@@ -36,7 +36,7 @@ export interface GLTF {
         extras?: any;
     };
     parser: GLTFParser;
-    userData: any;
+    userData: Record<string, any>;
 }
 
 export class GLTFLoader extends Loader<GLTF> {

three/examples/jsm/loaders/SVGLoader.d.ts

@@ -1,11 +1,7 @@
 import { Loader, LoadingManager, ShapePath, BufferGeometry, Vector3, Shape, Vector2 } from '../../../src/Three.js';
 
 export interface SVGResultPaths extends ShapePath {
-    userData?:
-        | {
-              [key: string]: any;
-          }
-        | undefined;
+    userData?: Record<string, any> | undefined;
 }
 
 export interface SVGResult {

three/examples/jsm/math/Octree.d.ts

@@ -3,10 +3,13 @@ import { Triangle, Box3, Ray, Sphere, Object3D } from '../../../src/Three.js';
 import { Capsule } from './Capsule.js';
 
 export class Octree {
-    constructor(box?: Box3);
-    triangles: Triangle[];
-    box: Box3;
+    box: Box3 | null | undefined;
+    bounds: Box3;
+
     subTrees: Octree[];
+    triangles: Triangle[];
+
+    constructor(box?: Box3 | null);
 
     addTriangle(triangle: Triangle): this;
     calcBox(): this;
@@ -21,4 +24,5 @@ export class Octree {
     capsuleIntersect(capsule: Capsule): any;
     rayIntersect(ray: Ray): any;
     fromGraphNode(group: Object3D): this;
+    clear(): this;
 }

three/examples/jsm/misc/ProgressiveLightMap.d.ts

@@ -11,7 +11,7 @@ import {
     WebGLRenderer,
     Scene,
     WebGLRenderTarget,
-} from './../../../src/Three.js';
+} from '../../../src/Three.js';
 
 export interface UVBoxes {
     w: number;

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

@@ -54,9 +54,7 @@ export type NodeTypeOption =
 export type SwizzleOption = string;
 
 /** Should be the same type as Object3D.userData */
-export interface NodeUserData {
-    [key: string]: any;
-}
+export type NodeUserData = Record<string, any>;
 
 /** generic key value type,curretly used by nodes  */
 export interface AnyObject {

three/examples/jsm/postprocessing/HBAOPass.d.ts

@@ -0,0 +1,106 @@
+import {
+    Camera,
+    Color,
+    ColorRepresentation,
+    DataTexture,
+    DepthTexture,
+    MeshNormalMaterial,
+    Scene,
+    ShaderMaterial,
+    Texture,
+    WebGLRenderer,
+    WebGLRenderTarget,
+} from '../../../src/Three.js';
+
+import { FullScreenQuad, Pass } from './Pass.js';
+
+export class HBAOPass extends Pass {
+    width: number;
+    height: number;
+    clear: boolean;
+    camera: Camera;
+    scene: Scene;
+    output: number;
+
+    rings: number;
+    samples: number;
+
+    noiseTexture: DataTexture;
+
+    hbaoRenderTarget: WebGLRenderTarget;
+    pdRenderTarget: WebGLRenderTarget;
+
+    hbaoMaterial: ShaderMaterial;
+
+    normalMaterial: MeshNormalMaterial;
+
+    pdMaterial: ShaderMaterial;
+
+    depthRenderMaterial: ShaderMaterial;
+
+    copyMaterial: ShaderMaterial;
+
+    fsQuad: FullScreenQuad;
+
+    originalClearColor: Color;
+
+    depthTexture: DepthTexture;
+    normalTexture: Texture;
+
+    constructor(
+        scene: Scene,
+        camera: Camera,
+        width?: number | undefined,
+        height?: number | undefined,
+        parameters?: { depthTexture?: DepthTexture | undefined; normalTexture?: Texture | undefined } | undefined,
+    );
+
+    setTextures(depthTexture?: DepthTexture | undefined, normalTexture?: Texture | undefined): void;
+
+    updateHbaoMaterial(parameters: {
+        radius?: number | undefined;
+        distanceExponent?: number | undefined;
+        bias?: number | undefined;
+        samples?: number | undefined;
+    }): void;
+
+    updatePdMaterial(parameters: {
+        lumaPhi?: number | undefined;
+        depthPhi?: number | undefined;
+        normalPhi?: number | undefined;
+        radius?: number | undefined;
+        rings?: number | undefined;
+        samples?: number | undefined;
+    }): void;
+
+    renderPass(
+        renderer: WebGLRenderer,
+        passMaterial: ShaderMaterial,
+        renderTarget: WebGLRenderTarget | null,
+        clearColor?: ColorRepresentation | undefined,
+        clearAlpha?: number | undefined,
+    ): void;
+
+    renderOverride(
+        renderer: WebGLRenderer,
+        overrideMaterial: MeshNormalMaterial,
+        renderTarget: WebGLRenderTarget | null,
+        clearColor?: ColorRepresentation | undefined,
+        clearAlpha?: number | undefined,
+    ): void;
+
+    overrideVisibility(): void;
+
+    restoreVisibility(): void;
+
+    generateNoise(size?: number): DataTexture;
+
+    static OUTPUT: {
+        Default: 0;
+        Diffuse: 1;
+        Depth: 2;
+        Normal: 3;
+        HBAO: 4;
+        Denoise: 5;
+    };
+}

three/examples/jsm/renderers/common/Info.d.ts

@@ -1,9 +1,14 @@
 import { Object3D } from '../../../../src/Three.js';
 
 export default class Info {
-    autoRest: boolean;
+    autoReset: boolean;
 
-    render: { frame: number; drawCalls: number; triangles: number; points: number; lines: number };
+    frame: number;
+    calls: number;
+
+    render: { calls: number; drawCalls: number; triangles: number; points: number; lines: number };
+
+    compute: { calls: number };
 
     memory: { geometries: number; textures: number };
 

three/examples/jsm/renderers/common/Renderer.d.ts

@@ -26,7 +26,7 @@ export default class Renderer {
 
     info: Info;
 
-    constructor(backend: Backend);
+    constructor(backend: Backend, parameters?: { logarithmicDepthBuffer?: boolean | undefined });
 
     init(): Promise<void>;
 
@@ -34,7 +34,7 @@ export default class Renderer {
 
     render(scene: Scene, camera: Camera): Promise<void>;
 
-    setAnimationLoop(callback: ((time: DOMHighResTimeStamp) => void) | null): void;
+    setAnimationLoop(callback: ((time: DOMHighResTimeStamp) => void) | null): Promise<void>;
 
     setPixelRatio(value?: number): void;
 

three/examples/jsm/renderers/webgpu/WebGPURenderer.d.ts

@@ -5,5 +5,6 @@ export default class WebGPURenderer extends Renderer {
         canvas?: HTMLCanvasElement | undefined;
         antialias?: boolean | undefined;
         sampleCount?: number | undefined;
+        logarithmicDepthBuffer?: boolean | undefined;
     });
 }

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

@@ -0,0 +1,44 @@
+import { IUniform, Matrix4, Vector2 } from '../../../src/Three.js';
+
+export const HBAOShader: {
+    name: string;
+    defines: {
+        PERSPECTIVE_CAMERA: number;
+        SAMPLES: number;
+        SAMPLE_VECTORS: string;
+        NORMAL_VECTOR_TYPE: number;
+        DEPTH_VALUE_SOURCE: number;
+        SAMPLING_FROM_NOISE: number;
+    };
+    uniforms: {
+        tNormal: IUniform;
+        tDepth: IUniform;
+        tNoise: IUniform;
+        resolution: IUniform<Vector2>;
+        cameraNear: IUniform;
+        cameraFar: IUniform;
+        cameraProjectionMatrix: IUniform<Matrix4>;
+        cameraProjectionMatrixInverse: IUniform<Matrix4>;
+        radius: IUniform<number>;
+        distanceExponent: IUniform<number>;
+        bias: IUniform<number>;
+    };
+    vertexShader: string;
+    fragmentShader: string;
+};
+
+export const HBAODepthShader: {
+    name: string;
+    defines: {
+        PERSPECTIVE_CAMERA: number;
+    };
+    uniforms: {
+        tDepth: IUniform;
+        cameraNear: IUniform;
+        cameraFar: IUniform;
+    };
+    vertexShader: string;
+    fragmentShader: string;
+};
+
+export function generateHaboSampleKernelInitializer(samples: number): string;

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

@@ -0,0 +1,28 @@
+import { IUniform, Matrix4, Vector2 } from '../../../src/Three.js';
+
+export const PoissonDenoiseShader: {
+    name: string;
+    defines: {
+        SAMPLES: number;
+        SAMPLE_VECTORS: string;
+        NORMAL_VECTOR_TYPE: number;
+        DEPTH_VALUE_SOURCE: number;
+    };
+    uniforms: {
+        tDiffuse: IUniform;
+        tNormal: IUniform;
+        tDepth: IUniform;
+        tNoise: IUniform;
+        resolution: IUniform<Vector2>;
+        cameraProjectionMatrixInverse: IUniform<Matrix4>;
+        lumaPhi: IUniform<number>;
+        depthPhi: IUniform<number>;
+        normalPhi: IUniform<number>;
+        radius: IUniform<number>;
+        index: IUniform<number>;
+    };
+    vertexShader: string;
+    fragmentShader: string;
+};
+
+export function generatePdSamplePointInitializer(samples: number, rings: number): string;

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

@@ -0,0 +1,7 @@
+export interface RadixSortOptions<T> {
+    aux?: T[] | undefined;
+    get?: ((el: T) => number) | undefined;
+    reversed?: boolean | undefined;
+}
+
+export const radixSort: <T = number>(arr: T[], opt?: RadixSortOptions<T>) => void;

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.158.3",
+    "version": "0.159.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -44,6 +44,6 @@
         "fflate": "~0.6.10",
         "meshoptimizer": "~0.18.1"
     },
-    "typesPublisherContentHash": "63e0c6a37dc1c160eecdbe61741d097ff25ba5c1e0bd8a134ae21d23bc71b38f",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "00146f19c0acfa1923520aa89574fd3c011b0b97251b16d57b2bc5999534c2c9",
+    "typeScriptVersion": "4.6"
 }

three/src/Three.d.ts

@@ -165,6 +165,7 @@ export { MathUtils };
 export * from './objects/Sprite.js';
 export * from './objects/LOD.js';
 export * from './objects/InstancedMesh.js';
+export * from './objects/BatchedMesh.js';
 export * from './objects/SkinnedMesh.js';
 export * from './objects/Skeleton.js';
 export * from './objects/Bone.js';

three/src/animation/AnimationClip.d.ts

@@ -1,6 +1,6 @@
 import { KeyframeTrack } from './KeyframeTrack.js';
-import { Vector3 } from './../math/Vector3.js';
-import { Bone } from './../objects/Bone.js';
+import { Vector3 } from '../math/Vector3.js';
+import { Bone } from '../objects/Bone.js';
 import { AnimationBlendMode } from '../constants.js';
 
 export interface MorphTarget {

three/src/animation/AnimationMixer.d.ts

@@ -1,7 +1,7 @@
 import { AnimationClip } from './AnimationClip.js';
 import { AnimationAction } from './AnimationAction.js';
 import { AnimationBlendMode } from '../constants.js';
-import { EventDispatcher } from './../core/EventDispatcher.js';
+import { EventDispatcher } from '../core/EventDispatcher.js';
 import { Object3D } from '../core/Object3D.js';
 import { AnimationObjectGroup } from './AnimationObjectGroup.js';
 

three/src/animation/KeyframeTrack.d.ts

@@ -1,6 +1,6 @@
-import { DiscreteInterpolant } from './../math/interpolants/DiscreteInterpolant.js';
-import { LinearInterpolant } from './../math/interpolants/LinearInterpolant.js';
-import { CubicInterpolant } from './../math/interpolants/CubicInterpolant.js';
+import { DiscreteInterpolant } from '../math/interpolants/DiscreteInterpolant.js';
+import { LinearInterpolant } from '../math/interpolants/LinearInterpolant.js';
+import { CubicInterpolant } from '../math/interpolants/CubicInterpolant.js';
 import { Interpolant } from '../math/Interpolant.js';
 import { InterpolationModes } from '../constants.js';
 

three/src/animation/tracks/BooleanKeyframeTrack.d.ts

@@ -1,4 +1,4 @@
-import { KeyframeTrack } from './../KeyframeTrack.js';
+import { KeyframeTrack } from '../KeyframeTrack.js';
 
 export class BooleanKeyframeTrack extends KeyframeTrack {
     constructor(name: string, times: ArrayLike<number>, values: ArrayLike<any>);

three/src/animation/tracks/ColorKeyframeTrack.d.ts

@@ -1,4 +1,4 @@
-import { KeyframeTrack } from './../KeyframeTrack.js';
+import { KeyframeTrack } from '../KeyframeTrack.js';
 import { InterpolationModes } from '../../constants.js';
 
 export class ColorKeyframeTrack extends KeyframeTrack {

three/src/animation/tracks/NumberKeyframeTrack.d.ts

@@ -1,4 +1,4 @@
-import { KeyframeTrack } from './../KeyframeTrack.js';
+import { KeyframeTrack } from '../KeyframeTrack.js';
 import { InterpolationModes } from '../../constants.js';
 
 export class NumberKeyframeTrack extends KeyframeTrack {

three/src/animation/tracks/QuaternionKeyframeTrack.d.ts

@@ -1,4 +1,4 @@
-import { KeyframeTrack } from './../KeyframeTrack.js';
+import { KeyframeTrack } from '../KeyframeTrack.js';
 import { InterpolationModes } from '../../constants.js';
 
 export class QuaternionKeyframeTrack extends KeyframeTrack {

three/src/animation/tracks/StringKeyframeTrack.d.ts

@@ -1,4 +1,4 @@
-import { KeyframeTrack } from './../KeyframeTrack.js';
+import { KeyframeTrack } from '../KeyframeTrack.js';
 import { InterpolationModes } from '../../constants.js';
 
 export class StringKeyframeTrack extends KeyframeTrack {

three/src/animation/tracks/VectorKeyframeTrack.d.ts

@@ -1,4 +1,4 @@
-import { KeyframeTrack } from './../KeyframeTrack.js';
+import { KeyframeTrack } from '../KeyframeTrack.js';
 import { InterpolationModes } from '../../constants.js';
 
 export class VectorKeyframeTrack extends KeyframeTrack {

three/src/audio/Audio.d.ts

@@ -1,4 +1,4 @@
-import { Object3D } from './../core/Object3D.js';
+import { Object3D } from '../core/Object3D.js';
 import { AudioListener } from './AudioListener.js';
 import { AudioContext } from './AudioContext.js';
 

three/src/audio/AudioListener.d.ts

@@ -1,4 +1,4 @@
-import { Object3D } from './../core/Object3D.js';
+import { Object3D } from '../core/Object3D.js';
 import { AudioContext } from './AudioContext.js';
 
 /**

three/src/core/BufferAttribute.d.ts

@@ -88,6 +88,7 @@ export class BufferAttribute {
     /**
      * This can be used to only update some components of stored vectors (for example, just the component related to color).
      * @defaultValue `{ offset: number = 0; count: number = -1 }`
+     * @deprecated Will be removed in r169. Use "addUpdateRange()" instead.
      */
     updateRange: {
         /**
@@ -99,6 +100,21 @@ export class BufferAttribute {
         count: number;
     };
 
+    /**
+     * This can be used to only update some components of stored vectors (for example, just the component related to
+     * color). Use the {@link .addUpdateRange} function to add ranges to this array.
+     */
+    updateRanges: Array<{
+        /**
+         * Position at which to start update.
+         */
+        start: number;
+        /**
+         * The number of components to update.
+         */
+        count: number;
+    }>;
+
     /**
      * A version number, incremented every time the {@link BufferAttribute.needsUpdate | needsUpdate} property is set to true.
      * @remarks Expects a `Integer`
@@ -159,6 +175,17 @@ export class BufferAttribute {
      */
     setUsage(usage: Usage): this;
 
+    /**
+     * Adds a range of data in the data array to be updated on the GPU. Adds an object describing the range to the
+     * {@link .updateRanges} array.
+     */
+    addUpdateRange(start: number, count: number): void;
+
+    /**
+     * Clears the {@link .updateRanges} array.
+     */
+    clearUpdateRanges(): void;
+
     /**
      * @returns a copy of this {@link BufferAttribute}.
      */

three/src/core/BufferGeometry.d.ts

@@ -188,7 +188,7 @@ export class BufferGeometry<
      * An object that can be used to store custom data about the BufferGeometry. It should not hold references to functions as these will not be cloned.
      * @defaultValue `{}`
      */
-    userData: { [key: string]: any };
+    userData: Record<string, any>;
 
     /**
      * Read-only flag to check if a given object is of type {@link BufferGeometry}.

three/src/core/InterleavedBuffer.d.ts

@@ -43,6 +43,7 @@ export class InterleavedBuffer {
     /**
      * Object containing offset and count.
      * @defaultValue `{ offset: number = 0; count: number = -1 }`
+     * @deprecated Will be removed in r169. Use "addUpdateRange()" instead.
      */
     updateRange: {
         /** @defaultValue `0` */
@@ -51,6 +52,21 @@ export class InterleavedBuffer {
         count: number;
     };
 
+    /**
+     * This can be used to only update some components of stored data. Use the {@link .addUpdateRange} function to add
+     * ranges to this array.
+     */
+    updateRanges: Array<{
+        /**
+         * Position at which to start update.
+         */
+        start: number;
+        /**
+         * The number of components to update.
+         */
+        count: number;
+    }>;
+
     /**
      * A version number, incremented every time the {@link BufferAttribute.needsUpdate | needsUpdate} property is set to true.
      * @remarks Expects a `Integer`
@@ -99,6 +115,17 @@ export class InterleavedBuffer {
      */
     setUsage(value: Usage): this;
 
+    /**
+     * Adds a range of data in the data array to be updated on the GPU. Adds an object describing the range to the
+     * {@link .updateRanges} array.
+     */
+    addUpdateRange(start: number, count: number): void;
+
+    /**
+     * Clears the {@link .updateRanges} array.
+     */
+    clearUpdateRanges(): void;
+
     /**
      * Copies another {@link InterleavedBuffer} to this {@link InterleavedBuffer} instance.
      * @param source

three/src/core/InterleavedBufferAttribute.d.ts

@@ -1,7 +1,7 @@
 import { BufferAttribute, TypedArray } from './BufferAttribute.js';
 import { InterleavedBuffer } from './InterleavedBuffer.js';
-import { Matrix4 } from './../math/Matrix4.js';
-import { Matrix } from './../math/Matrix3.js';
+import { Matrix4 } from '../math/Matrix4.js';
+import { Matrix } from '../math/Matrix3.js';
 
 /**
  * @see {@link https://threejs.org/docs/index.html#api/en/core/InterleavedBufferAttribute | Official Documentation}