@types/three 0.136.0 → 0.138.0

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

@@ -49,6 +49,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 +99,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 {
@@ -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, TextureEncoding } from '../../constants';
+
 export class WebGLUtils {
     constructor(gl: WebGLRenderingContext | WebGL2RenderingContext, extensions: any, capabilities: any);
 
-    convert(p: any): void;
+    convert(p: CompressedPixelFormat, encoding?: TextureEncoding | null): void;
 }

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/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;
+}

three/src/textures/Texture.d.ts

@@ -1,5 +1,6 @@
 import { Vector2 } from './../math/Vector2';
 import { Matrix3 } from './../math/Matrix3';
+import { Source } from './Source';
 import { EventDispatcher } from './../core/EventDispatcher';
 import {
     Mapping,
@@ -47,9 +48,30 @@ export class Texture extends EventDispatcher {
     sourceFile: string;
 
     /**
-     * @default THREE.Texture.DEFAULT_IMAGE
+     * The data definition of a texture. A reference to the data source can be shared across textures.
+     * This is often useful in context of spritesheets where multiple textures render the same data but with different texture transformations.
      */
-    image: any; // HTMLImageElement or ImageData or { width: number, height: number } in some children;
+    source: Source;
+
+    /**
+     * An image object, typically created using the {@link TextureLoader.load} method.
+     * This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.
+     *
+     * To use video as a texture you need to have a playing HTML5
+     * video element as a source for your texture image and continuously update this texture
+     * as long as video is playing - the {@link VideoTexture} class handles this automatically.
+     */
+    get image(): any;
+
+    /**
+     * An image object, typically created using the {@link TextureLoader.load} method.
+     * This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.
+     *
+     * To use video as a texture you need to have a playing HTML5
+     * video element as a source for your texture image and continuously update this texture
+     * as long as video is playing - the {@link VideoTexture} class handles this automatically.
+     */
+    set image(data: any);
 
     /**
      * @default []
@@ -158,6 +180,11 @@ export class Texture extends EventDispatcher {
      */
     isRenderTargetTexture: boolean;
 
+    /**
+     * @default false
+     */
+    needsPMREMUpdate: boolean;
+
     /**
      * An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.
      * @default {}
@@ -168,7 +195,7 @@ export class Texture extends EventDispatcher {
      * @default 0
      */
     version: number;
-    needsUpdate: boolean;
+    set needsUpdate(value: boolean);
     readonly isTexture: true;
 
     onUpdate: () => void;

three/src/textures/VideoTexture.d.ts

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

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

@@ -1,19 +0,0 @@
-import { Loader, LoadingManager } from '../../../src/Three';
-
-import { GLTFLoader, GLTF } from './GLTFLoader';
-import { DRACOLoader } from './DRACOLoader';
-
-export class VRMLoader extends Loader {
-    constructor(manager?: LoadingManager);
-    gltfLoader: GLTFLoader;
-
-    load(
-        url: string,
-        onLoad: (scene: GLTF) => void,
-        onProgress?: (event: ProgressEvent) => void,
-        onError?: (event: ErrorEvent) => void,
-    ): void;
-    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<GLTF>;
-    parse(gltf: GLTF, onLoad: (scene: GLTF) => void): void;
-    setDRACOLoader(dracoLoader: DRACOLoader): this;
-}

three/examples/jsm/nodes/Nodes.d.ts

@@ -1,106 +0,0 @@
-// core
-
-export * from './core/Node';
-export * from './core/TempNode';
-export * from './core/InputNode';
-export * from './core/ConstNode';
-export * from './core/VarNode';
-export * from './core/StructNode';
-export * from './core/AttributeNode';
-export * from './core/FunctionNode';
-export * from './core/ExpressionNode';
-export * from './core/FunctionCallNode';
-export * from './core/NodeLib';
-export * from './core/NodeUtils';
-export * from './core/NodeFrame';
-export * from './core/NodeUniform';
-export * from './core/NodeBuilder';
-
-// inputs
-
-export * from './inputs/BoolNode';
-export * from './inputs/IntNode';
-export * from './inputs/FloatNode';
-export * from './inputs/Vector2Node';
-export * from './inputs/Vector3Node';
-export * from './inputs/Vector4Node';
-export * from './inputs/ColorNode';
-export * from './inputs/Matrix3Node';
-export * from './inputs/Matrix4Node';
-export * from './inputs/TextureNode';
-export * from './inputs/CubeTextureNode';
-export * from './inputs/ScreenNode';
-export * from './inputs/ReflectorNode';
-export * from './inputs/PropertyNode';
-export * from './inputs/RTTNode';
-
-// accessors
-
-export * from './accessors/UVNode';
-export * from './accessors/ColorsNode';
-export * from './accessors/PositionNode';
-export * from './accessors/NormalNode';
-export * from './accessors/CameraNode';
-export * from './accessors/LightNode';
-export * from './accessors/ReflectNode';
-export * from './accessors/ScreenUVNode';
-export * from './accessors/ResolutionNode';
-
-// math
-
-export * from './math/MathNode';
-export * from './math/OperatorNode';
-export * from './math/CondNode';
-
-// procedural
-
-export * from './procedural/NoiseNode';
-export * from './procedural/CheckerNode';
-
-// misc
-
-export * from './misc/TextureCubeUVNode';
-export * from './misc/TextureCubeNode';
-export * from './misc/NormalMapNode';
-export * from './misc/BumpMapNode';
-
-// utils
-
-export * from './utils/BypassNode';
-export * from './utils/JoinNode';
-export * from './utils/SwitchNode';
-export * from './utils/TimerNode';
-export * from './utils/VelocityNode';
-export * from './utils/UVTransformNode';
-export * from './utils/MaxMIPLevelNode';
-export * from './utils/SpecularMIPLevelNode';
-export * from './utils/ColorSpaceNode';
-
-// effects
-
-export * from './effects/BlurNode';
-export * from './effects/ColorAdjustmentNode';
-export * from './effects/LuminanceNode';
-
-// material nodes
-
-export * from './materials/nodes/RawNode';
-export * from './materials/nodes/BasicNode';
-export * from './materials/nodes/SpriteNode';
-export * from './materials/nodes/PhongNode';
-export * from './materials/nodes/StandardNode';
-export * from './materials/nodes/MeshStandardNode';
-
-// materials
-
-export * from './materials/NodeMaterial';
-export * from './materials/BasicNodeMaterial';
-export * from './materials/SpriteNodeMaterial';
-export * from './materials/PhongNodeMaterial';
-export * from './materials/StandardNodeMaterial';
-export * from './materials/MeshStandardNodeMaterial';
-
-// postprocessing
-
-export * from './postprocessing/NodePostProcessing';
-// export * from './postprocessing/NodePass';

three/examples/jsm/nodes/accessors/CameraNode.d.ts

@@ -1,29 +0,0 @@
-import { Camera } from '../../../../src/Three';
-
-import { NodeFrame } from '../core/NodeFrame';
-import { TempNode } from '../core/TempNode';
-import { FunctionNode } from '../core/FunctionNode';
-import { FloatNode } from '../inputs/FloatNode';
-
-export class CameraNode extends TempNode {
-    constructor(scope?: string, camera?: Camera);
-
-    scope: string;
-    near: FloatNode | undefined;
-    far: FloatNode | undefined;
-    camera: Camera | undefined;
-    updateFrame: boolean | undefined;
-    nodeType: string;
-
-    setCamera(camera: Camera): void;
-    setScope(scope: string): void;
-    onUpdateFrame(frame: NodeFrame): void;
-    copy(source: CameraNode): this;
-
-    static Nodes: {
-        depthColor: FunctionNode;
-    };
-    static POSITION: string;
-    static DEPTH: string;
-    static TO_VERTEX: string;
-}

three/examples/jsm/nodes/accessors/ColorsNode.d.ts

@@ -1,10 +0,0 @@
-import { TempNode } from '../core/TempNode';
-
-export class ColorsNode extends TempNode {
-    constructor(index?: number);
-
-    index: number;
-    nodeType: string;
-
-    copy(source: ColorsNode): this;
-}

three/examples/jsm/nodes/accessors/LightNode.d.ts

@@ -1,12 +0,0 @@
-import { TempNode } from '../core/TempNode';
-
-export class LightNode extends TempNode {
-    constructor(scope?: string);
-
-    scope: string;
-    nodeType: string;
-
-    copy(source: LightNode): this;
-
-    static TOTAL: string;
-}

three/examples/jsm/nodes/accessors/NormalNode.d.ts

@@ -1,13 +0,0 @@
-import { TempNode } from '../core/TempNode';
-
-export class NormalNode extends TempNode {
-    constructor(scope?: string);
-
-    scope: string;
-    nodeType: string;
-
-    copy(source: NormalNode): this;
-
-    static LOCAL: string;
-    static WORLD: string;
-}