@types/three 0.136.1 → 0.139.0

three/src/geometries/CapsuleGeometry.d.ts

@@ -0,0 +1,27 @@
+import { BufferGeometry } from '../core/BufferGeometry';
+
+export class CapsuleGeometry extends BufferGeometry {
+    /**
+     * @param [radius=1] — Radius of the capsule.
+     * @param [length=1] — Length of the middle section.
+     * @param [capSegments=4] — Number of curve segments used to build the caps.
+     * @param [radialSegments=8] — Number of segmented faces around the circumference of the capsule.
+     */
+    constructor(radius?: number, length?: number, capSegments?: number, radialSegments?: number);
+
+    /**
+     * @default 'CapsuleGeometry'
+     */
+    type: string;
+
+    parameters: {
+        radius: number;
+        length: number;
+        capSegments: number;
+        radialSegments: number;
+    };
+
+    static fromJSON(data: any): CapsuleGeometry;
+}
+
+export { CapsuleGeometry as CapsuleBufferGeometry };

three/src/geometries/Geometries.d.ts

@@ -1,4 +1,5 @@
 export * from './BoxGeometry';
+export * from './CapsuleGeometry';
 export * from './CircleGeometry';
 export * from './ConeGeometry';
 export * from './CylinderGeometry';

three/src/materials/Material.d.ts

@@ -181,12 +181,6 @@ export class Material extends EventDispatcher {
      */
     fog: boolean;
 
-    /**
-     * When this property is set to THREE.RGBFormat, the material is considered to be opaque and alpha values are ignored.
-     * @default THREE.RGBAFormat
-     */
-    format: PixelFormat;
-
     /**
      * Unique number of this material instance.
      */

three/src/materials/MeshStandardMaterial.d.ts

@@ -30,7 +30,6 @@ export interface MeshStandardMaterialParameters extends MaterialParameters {
     alphaMap?: Texture | null | undefined;
     envMap?: Texture | null | undefined;
     envMapIntensity?: number | undefined;
-    refractionRatio?: number | undefined;
     wireframe?: boolean | undefined;
     wireframeLinewidth?: number | undefined;
 
@@ -170,11 +169,6 @@ export class MeshStandardMaterial extends Material {
      */
     envMapIntensity: number;
 
-    /**
-     * @default 0.98
-     */
-    refractionRatio: number;
-
     /**
      * @default false
      */

three/src/math/Box3.d.ts

@@ -25,7 +25,7 @@ export class Box3 {
     setFromBufferAttribute(bufferAttribute: BufferAttribute): this;
     setFromPoints(points: Vector3[]): this;
     setFromCenterAndSize(center: Vector3, size: Vector3): this;
-    setFromObject(object: Object3D): this;
+    setFromObject(object: Object3D, precise?: boolean): this;
     clone(): this;
     copy(box: Box3): this;
     makeEmpty(): this;
@@ -35,7 +35,7 @@ export class Box3 {
     expandByPoint(point: Vector3): this;
     expandByVector(vector: Vector3): this;
     expandByScalar(scalar: number): this;
-    expandByObject(object: Object3D): this;
+    expandByObject(object: Object3D, precise?: boolean): this;
     containsPoint(point: Vector3): boolean;
     containsBox(box: Box3): boolean;
     getParameter(point: Vector3, target: Vector3): Vector3;

three/src/math/Color.d.ts

@@ -1,12 +1,22 @@
+import { ColorSpace } from '../constants';
 import { ColorRepresentation } from '../utils';
+
 import { BufferAttribute } from './../core/BufferAttribute';
 
+export { SRGBToLinear } from './ColorManagement';
+
 export interface HSL {
     h: number;
     s: number;
     l: number;
 }
 
+export interface RGB {
+    r: number;
+    g: number;
+    b: number;
+}
+
 /**
  * Represents a color. See also {@link ColorUtils}.
  *
@@ -41,7 +51,7 @@ export class Color {
 
     set(color: ColorRepresentation): Color;
     setScalar(scalar: number): Color;
-    setHex(hex: number): Color;
+    setHex(hex: number, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from RGB values.
@@ -49,7 +59,7 @@ export class Color {
      * @param g Green channel value between 0 and 1.
      * @param b Blue channel value between 0 and 1.
      */
-    setRGB(r: number, g: number, b: number): Color;
+    setRGB(r: number, g: number, b: number, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from HSL values.
@@ -59,20 +69,20 @@ export class Color {
      * @param s Saturation value channel between 0 and 1.
      * @param l Value channel value between 0 and 1.
      */
-    setHSL(h: number, s: number, l: number): Color;
+    setHSL(h: number, s: number, l: number, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from a CSS context style string.
      * @param contextStyle Color in CSS context style format.
      */
-    setStyle(style: string): Color;
+    setStyle(style: string, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from a color name.
      * Faster than {@link Color#setStyle .setStyle()} method if you don't need the other CSS-style formats.
      * @param style Color name in X11 format.
      */
-    setColorName(style: string): Color;
+    setColorName(style: string, colorSpace?: ColorSpace): Color;
 
     /**
      * Clones this color.
@@ -110,20 +120,22 @@ export class Color {
     /**
      * Returns the hexadecimal value of this color.
      */
-    getHex(): number;
+    getHex(colorSpace?: ColorSpace): number;
 
     /**
      * Returns the string formated hexadecimal value of this color.
      */
-    getHexString(): string;
+    getHexString(colorSpace?: ColorSpace): string;
+
+    getHSL(target: HSL, colorSpace?: ColorSpace): HSL;
 
-    getHSL(target: HSL): HSL;
+    getRGB(target: RGB, colorSpace?: ColorSpace): RGB;
 
     /**
      * Returns the value of this color in CSS context style.
      * Example: rgb(r, g, b)
      */
-    getStyle(): string;
+    getStyle(colorSpace?: ColorSpace): string;
 
     offsetHSL(h: number, s: number, l: number): this;
 

three/src/math/ColorManagement.d.ts

@@ -0,0 +1,18 @@
+import { LinearSRGBColorSpace, SRGBColorSpace } from '../constants';
+import { Color } from './Color';
+
+export function SRGBToLinear(c: number): number;
+
+export function LinearToSRGB(c: number): number;
+
+export namespace ColorManagement {
+    function convert(
+        color: Color,
+        sourceColorSpace: SRGBColorSpace | LinearSRGBColorSpace,
+        targetColorSpace: SRGBColorSpace | LinearSRGBColorSpace,
+    ): Color;
+
+    function fromWorkingColorSpace(color: Color, targetColorSpace: SRGBColorSpace | LinearSRGBColorSpace): Color;
+
+    function toWorkingColorSpace(color: Color, sourceColorSpace: SRGBColorSpace | LinearSRGBColorSpace): Color;
+}

three/src/math/Euler.d.ts

@@ -38,7 +38,6 @@ export class Euler {
     equals(euler: Euler): boolean;
     fromArray(xyzo: any[]): Euler;
     toArray(array?: number[], offset?: number): number[];
-    toVector3(optionalResult?: Vector3): Vector3;
     _onChange(callback: () => void): this;
 
     static RotationOrders: string[];

three/src/math/Plane.d.ts

@@ -31,7 +31,6 @@ export class Plane {
     distanceToPoint(point: Vector3): number;
     distanceToSphere(sphere: Sphere): number;
     projectPoint(point: Vector3, target: Vector3): Vector3;
-    orthoPoint(point: Vector3, target: Vector3): Vector3;
     intersectLine(line: Line3, target: Vector3): Vector3 | null;
     intersectsLine(line: Line3): boolean;
     intersectsBox(box: Box3): boolean;

three/src/math/Vector3.d.ts

@@ -252,6 +252,11 @@ export class Vector3 implements Vector {
     setFromMatrixColumn(matrix: Matrix4, index: number): this;
     setFromMatrix3Column(matrix: Matrix3, index: number): this;
 
+    /**
+     * Sets this vector's {@link x}, {@link y} and {@link z} components from the x, y, and z components of the specified {@link Euler Euler Angle}.
+     */
+    setFromEuler(e: Euler): this;
+
     /**
      * Checks for strict equality of this vector and v.
      */

three/src/renderers/WebGL3DRenderTarget.d.ts

@@ -0,0 +1,28 @@
+import { Data3DTexture } from '../textures/Data3DTexture';
+import { WebGLRenderTarget } from './WebGLRenderTarget';
+
+/**
+ * Represents a three-dimensional render target.
+ */
+export class WebGL3DRenderTarget extends WebGLRenderTarget {
+    /**
+     * Creates a new WebGL3DRenderTarget.
+     *
+     * @param width the width of the render target, in pixels.
+     * @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);
+
+    /**
+     * The depth of the render target.
+     */
+    depth: number;
+
+    /**
+     * The texture property is overwritten with an instance of {@link Data3DTexture}.
+     */
+    texture: Data3DTexture;
+
+    readonly isWebGL3DRenderTarget: true;
+}

three/src/renderers/WebGLArrayRenderTarget.d.ts

@@ -0,0 +1,28 @@
+import { DataArrayTexture } from '../textures/DataArrayTexture';
+import { WebGLRenderTarget } from './WebGLRenderTarget';
+
+/**
+ * This type of render target represents an array of textures.
+ */
+export class WebGLArrayRenderTarget extends WebGLRenderTarget {
+    /**
+     * Creates a new WebGLArrayRenderTarget.
+     *
+     * @param width the width of the render target, in pixels.
+     * @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);
+
+    /**
+     * The depth of the render target.
+     */
+    depth: number;
+
+    /**
+     * The texture property is overwritten with an instance of {@link DataArrayTexture}.
+     */
+    texture: DataArrayTexture;
+
+    readonly isWebGLArrayRenderTarget: true;
+}

three/src/renderers/WebGLMultipleRenderTargets.d.ts

@@ -1,5 +1,6 @@
 import { EventDispatcher } from '../core/EventDispatcher';
 import { Texture } from '../textures/Texture';
+import { WebGLRenderTargetOptions } from './WebGLRenderTarget';
 
 /**
  * This class originall extended WebGLMultipleRenderTarget
@@ -10,7 +11,14 @@ export class WebGLMultipleRenderTargets extends EventDispatcher {
 
     readonly isWebGLMultipleRenderTargets = true;
 
-    constructor(width: number, height: number, count: number);
+    /**
+     * @param width The width of the render target.
+     * @param height The height of the render target.
+     * @param count The number of render targets.
+     * @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);
 
     setSize(width: number, height: number, depth?: number): this;
     copy(source: WebGLMultipleRenderTargets): this;

three/src/renderers/WebGLMultisampleRenderTarget.d.ts

@@ -1,13 +1,6 @@
-import { WebGLRenderTarget, WebGLRenderTargetOptions } from './WebGLRenderTarget';
+import { WebGLRenderTarget } from './WebGLRenderTarget';
 
-export class WebGLMultisampleRenderTarget extends WebGLRenderTarget {
-    constructor(width: number, height: number, options?: WebGLRenderTargetOptions);
-
-    readonly isWebGLMultisampleRenderTarget: true;
-
-    /**
-     * Specifies the number of samples to be used for the renderbuffer storage.However, the maximum supported size for multisampling is platform dependent and defined via gl.MAX_SAMPLES.
-     * @default 4
-     */
-    samples: number;
-}
+/**
+ * @deprecated THREE.WebGLMultisampleRenderTarget has been removed. Use a normal {@link WebGLRenderTarget render target} and set the "samples" property to greater 0 to enable multisampling.
+ */
+export class WebGLMultisampleRenderTarget extends WebGLRenderTarget {}

three/src/renderers/WebGLRenderTarget.d.ts

@@ -22,7 +22,6 @@ export interface WebGLRenderTargetOptions {
 export class WebGLRenderTarget extends EventDispatcher {
     constructor(width: number, height: number, options?: WebGLRenderTargetOptions);
 
-    uuid: string;
     width: number;
     height: number;
     depth: number;
@@ -49,6 +48,13 @@ export class WebGLRenderTarget extends EventDispatcher {
      * @default null
      */
     depthTexture: DepthTexture;
+
+    /**
+     * Defines the count of MSAA samples. Can only be used with WebGL 2. Default is **0**.
+     * @default 0
+     */
+    samples: number;
+
     readonly isWebGLRenderTarget: true;
 
     /**
@@ -92,7 +98,6 @@ export class WebGLRenderTarget extends EventDispatcher {
      */
     generateMipmaps: any;
 
-    setTexture(texture: Texture): void;
     setSize(width: number, height: number, depth?: number): void;
     clone(): this;
     copy(source: WebGLRenderTarget): this;

three/src/renderers/WebGLRenderer.d.ts

@@ -5,7 +5,6 @@ import { WebGLInfo } from './webgl/WebGLInfo';
 import { WebGLShadowMap } from './webgl/WebGLShadowMap';
 import { WebGLCapabilities } from './webgl/WebGLCapabilities';
 import { WebGLProperties } from './webgl/WebGLProperties';
-import { WebGLProgram } from './webgl/WebGLProgram';
 import { WebGLRenderLists } from './webgl/WebGLRenderLists';
 import { WebGLState } from './webgl/WebGLState';
 import { Vector2 } from './../math/Vector2';
@@ -19,11 +18,11 @@ import { ToneMapping, ShadowMapType, CullFace, TextureEncoding } from '../consta
 import { WebXRManager } from '../renderers/webxr/WebXRManager';
 import { BufferGeometry } from './../core/BufferGeometry';
 import { Texture } from '../textures/Texture';
-import { DataTexture3D } from '../textures/DataTexture3D';
+import { Data3DTexture } from '../textures/Data3DTexture';
 import { XRAnimationLoopCallback } from './webxr/WebXR';
 import { Vector3 } from '../math/Vector3';
 import { Box3 } from '../math/Box3';
-import { DataTexture2DArray } from '../textures/DataTexture2DArray';
+import { DataArrayTexture } from '../textures/DataArrayTexture';
 import { ColorRepresentation } from '../utils';
 
 export interface Renderer {
@@ -219,7 +218,7 @@ export class WebGLRenderer implements Renderer {
     /**
      * Return the WebGL context.
      */
-    getContext(): WebGLRenderingContext;
+    getContext(): WebGLRenderingContext | WebGL2RenderingContext;
     getContextAttributes(): any;
     forceContextLoss(): void;
     forceContextRestore(): void;
@@ -437,7 +436,7 @@ export class WebGLRenderer implements Renderer {
         sourceBox: Box3,
         position: Vector3,
         srcTexture: Texture,
-        dstTexture: DataTexture3D | DataTexture2DArray,
+        dstTexture: Data3DTexture | DataArrayTexture,
         level?: number,
     ): void;
 

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

@@ -1,5 +1,7 @@
+import { CompressedPixelFormat, PixelFormat, TextureEncoding, TextureDataType } from '../../constants';
+
 export class WebGLUtils {
     constructor(gl: WebGLRenderingContext | WebGL2RenderingContext, extensions: any, capabilities: any);
 
-    convert(p: any): void;
+    convert(p: PixelFormat | CompressedPixelFormat | TextureDataType, encoding?: TextureEncoding | null): number | null;
 }

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

@@ -25,7 +25,7 @@ export class WebXRManager extends EventDispatcher {
     getSession(): XRSession | null;
     setSession(value: XRSession): Promise<void>;
     getCamera(camera: Camera): Camera;
-    setAnimationLoop(callback: XRFrameRequestCallback): void;
+    setAnimationLoop(callback: XRFrameRequestCallback | null): void;
     getFoveation(): number | undefined;
     setFoveation(foveation: number): void;
     dispose(): void;

three/src/scenes/Scene.d.ts

@@ -45,20 +45,5 @@ export class Scene extends Object3D {
 
     readonly isScene: true;
 
-    /**
-     * Calls before rendering scene
-     */
-    onBeforeRender: (
-        renderer: WebGLRenderer,
-        scene: Scene,
-        camera: Camera,
-        renderTarget: any, // any required for Object3D.onBeforeRender compatibility
-    ) => void;
-
-    /**
-     * Calls after rendering scene
-     */
-    onAfterRender: (renderer: WebGLRenderer, scene: Scene, camera: Camera) => void;
-
     toJSON(meta?: any): any;
 }

three/src/textures/CompressedTexture.d.ts

@@ -38,7 +38,8 @@ export class CompressedTexture extends Texture {
         encoding?: TextureEncoding,
     );
 
-    image: { width: number; height: number };
+    get image(): { width: number; height: number };
+    set image(value: { width: number; height: number });
 
     mipmaps: ImageData[];
 

three/src/textures/CubeTexture.d.ts

@@ -9,7 +9,7 @@ export class CubeTexture extends Texture {
      * @param [wrapT=THREE.ClampToEdgeWrapping]
      * @param [magFilter=THREE.LinearFilter]
      * @param [minFilter=THREE.LinearMipmapLinearFilter]
-     * @param [format=THREE.RGBFormat]
+     * @param [format=THREE.RGBAFormat]
      * @param [type=THREE.UnsignedByteType]
      * @param [anisotropy=1]
      * @param [encoding=THREE.LinearEncoding]

three/src/textures/Data3DTexture.d.ts

@@ -0,0 +1,33 @@
+import { Texture } from './Texture';
+import { TextureFilter } from '../constants';
+
+export class Data3DTexture extends Texture {
+    constructor(data: BufferSource, width: number, height: number, depth: number);
+
+    /**
+     * @default THREE.NearestFilter
+     */
+    magFilter: TextureFilter;
+
+    /**
+     * @default THREE.NearestFilter
+     */
+    minFilter: TextureFilter;
+
+    /**
+     * @default THREE.ClampToEdgeWrapping
+     */
+    wrapR: boolean;
+
+    /**
+     * @default false
+     */
+    flipY: boolean;
+
+    /**
+     * @default false
+     */
+    generateMipmaps: boolean;
+
+    readonly isData3DTexture: true;
+}

three/src/textures/DataArrayTexture.d.ts

@@ -0,0 +1,33 @@
+import { Texture } from './Texture';
+import { TextureFilter } from '../constants';
+
+export class DataArrayTexture extends Texture {
+    constructor(data?: BufferSource, width?: number, height?: number, depth?: number);
+
+    /**
+     * @default THREE.NearestFilter
+     */
+    magFilter: TextureFilter;
+
+    /**
+     * @default THREE.NearestFilter
+     */
+    minFilter: TextureFilter;
+
+    /**
+     * @default THREE.ClampToEdgeWrapping
+     */
+    wrapR: boolean;
+
+    /**
+     * @default false
+     */
+    flipY: boolean;
+
+    /**
+     * @default false
+     */
+    generateMipmaps: boolean;
+
+    readonly isDataArrayTexture: true;
+}

three/src/textures/DataTexture.d.ts

@@ -31,7 +31,8 @@ export class DataTexture extends Texture {
         encoding?: TextureEncoding,
     );
 
-    image: ImageData;
+    get image(): ImageData;
+    set image(value: ImageData);
 
     /**
      * @default false

three/src/textures/DataTexture2DArray.d.ts

@@ -1,33 +1,6 @@
-import { Texture } from './Texture';
-import { TextureFilter } from '../constants';
+import { DataArrayTexture } from './DataArrayTexture';
 
-export class DataTexture2DArray extends Texture {
-    constructor(data?: BufferSource, width?: number, height?: number, depth?: number);
-
-    /**
-     * @default THREE.NearestFilter
-     */
-    magFilter: TextureFilter;
-
-    /**
-     * @default THREE.NearestFilter
-     */
-    minFilter: TextureFilter;
-
-    /**
-     * @default THREE.ClampToEdgeWrapping
-     */
-    wrapR: boolean;
-
-    /**
-     * @default false
-     */
-    flipY: boolean;
-
-    /**
-     * @default false
-     */
-    generateMipmaps: boolean;
-
-    readonly isDataTexture2DArray: true;
-}
+/**
+ * @deprecated THREE.DataTexture2DArray has been renamed to DataArrayTexture.
+ */
+export class DataTexture2DArray extends DataArrayTexture {}

three/src/textures/DataTexture3D.d.ts

@@ -1,33 +1,6 @@
-import { Texture } from './Texture';
-import { TextureFilter } from '../constants';
+import { Data3DTexture } from './Data3DTexture';
 
-export class DataTexture3D extends Texture {
-    constructor(data: BufferSource, width: number, height: number, depth: number);
-
-    /**
-     * @default THREE.NearestFilter
-     */
-    magFilter: TextureFilter;
-
-    /**
-     * @default THREE.NearestFilter
-     */
-    minFilter: TextureFilter;
-
-    /**
-     * @default THREE.ClampToEdgeWrapping
-     */
-    wrapR: boolean;
-
-    /**
-     * @default false
-     */
-    flipY: boolean;
-
-    /**
-     * @default false
-     */
-    generateMipmaps: boolean;
-
-    readonly isDataTexture3D: true;
-}
+/**
+ * @deprecated THREE.DataTexture3D has been renamed to Data3DTexture.
+ */
+export class DataTexture3D extends Data3DTexture {}

three/src/textures/DepthTexture.d.ts

@@ -25,7 +25,8 @@ export class DepthTexture extends Texture {
         anisotropy?: number,
     );
 
-    image: { width: number; height: number };
+    get image(): { width: number; height: number };
+    set image(value: { width: number; height: number });
 
     /**
      * @default false

three/src/textures/Source.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents the data source of a texture.
+ */
+export class Source {
+    /**
+     * @param [data] The data definition of a texture. default is **null**.
+     */
+    constructor(data: any);
+
+    /**
+     * The actual data of a texture. The type of this property depends on the texture that uses this instance.
+     */
+    data: any;
+
+    /**
+     * Set this to **true** to trigger a data upload to the GPU next time the source is used.
+     */
+    set needsUpdate(value: boolean);
+
+    /**
+     * [UUID](http://en.wikipedia.org/wiki/Universally_unique_identifier) of this object instance.
+     * This gets automatically assigned, so this shouldn't be edited.
+     */
+    uuid: string;
+
+    /**
+     * This starts at **0** and counts how many times [property:Boolean needsUpdate] is set to **true**.
+     */
+    version: number;
+
+    /**
+     * Convert the data source to three.js [JSON Object/Scene format](https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4).
+     *
+     * @param [meta] optional object containing metadata.
+     */
+    toJSON(meta: any): any;
+
+    readonly isTexture: true;
+}