@types/three 0.182.0 → 0.183.0

three/src/scenes/FogExp2.d.ts

@@ -8,59 +8,54 @@ export interface FogExp2JSON {
 }
 
 /**
- * This class contains the parameters that define exponential squared fog, which gives a clear view near the camera and a faster than exponentially densening fog farther from the camera.
- * @example
- * ```typescript
+ * This class can be used to define an exponential squared fog,
+ * which gives a clear view near the camera and a faster than exponentially
+ * densening fog farther from the camera.
+ *
+ * ```js
  * const scene = new THREE.Scene();
- * scene.fog = new THREE.FogExp2(0xcccccc, 0.002);
+ * scene.fog = new THREE.FogExp2( 0xcccccc, 0.002 );
  * ```
- * @see Example: {@link https://threejs.org/examples/#webgl_geometry_terrain | webgl geometry terrain}
- * @see {@link https://threejs.org/docs/index.html#api/en/scenes/FogExp2 | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/scenes/FogExp2.js | Source}
  */
 export class FogExp2 {
     /**
-     * The color parameter is passed to the {@link THREE.Color | Color} constructor to set the color property
-     * @remarks Color can be a hexadecimal integer or a CSS-style string.
-     * @param color
-     * @param density Expects a `Float`
+     * Constructs a new fog.
+     *
+     * @param {number|Color} color - The fog's color.
+     * @param {number} [density=0.00025] - Defines how fast the fog will grow dense.
      */
     constructor(color: ColorRepresentation, density?: number);
-
     /**
-     * Read-only flag to check if a given object is of type {@link FogExp2}.
-     * @remarks This is a _constant_ value
-     * @defaultValue `true`
+     * This flag can be used for type testing.
+     *
+     * @default true
      */
-    readonly isFogExp2: true;
-
+    readonly isFogExp2: boolean;
     /**
-     * Optional name of the object
-     * @remarks _(doesn't need to be unique)_.
-     * @defaultValue `""`
+     * The name of the fog.
      */
     name: string;
-
     /**
-     * Fog color.
-     * @remarks If set to black, far away objects will be rendered black.
+     * The fog's color.
      */
     color: Color;
-
     /**
-     * Defines how fast the fog will grow dense.
-     * @defaultValue `0.00025`
-     * @remarks Expects a `Float`
+     *  Defines how fast the fog will grow dense.
+     *
+     * @default 0.00025
      */
     density: number;
-
     /**
-     * Returns a new {@link FogExp2} instance with the same parameters as this one.
+     * Returns a new fog with copied values from this instance.
+     *
+     * @return {FogExp2} A clone of this instance.
      */
     clone(): FogExp2;
-
     /**
-     * Return {@link FogExp2} data in JSON format.
+     * Serializes the fog into JSON.
+     *
+     * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
+     * @return {Object} A JSON object representing the serialized fog
      */
     toJSON(): FogExp2JSON;
 }

three/src/scenes/Scene.d.ts

@@ -1,8 +1,7 @@
-import { JSONMeta, Object3D, Object3DEventMap, Object3DJSON, Object3DJSONObject } from "../core/Object3D.js";
+import { JSONMeta, Object3D, Object3DJSON, Object3DJSONObject } from "../core/Object3D.js";
 import { Material } from "../materials/Material.js";
 import { Color } from "../math/Color.js";
 import { Euler, EulerTuple } from "../math/Euler.js";
-import { CubeTexture } from "../textures/CubeTexture.js";
 import { Texture } from "../textures/Texture.js";
 import { Fog, FogJSON } from "./Fog.js";
 import { FogExp2, FogExp2JSON } from "./FogExp2.js";
@@ -23,96 +22,83 @@ export interface SceneJSON extends Object3DJSON {
 }
 
 /**
- * Scenes allow you to set up what and where is to be rendered by three.js
- * @remarks
- * This is where you place objects, lights and cameras.
- * @see Example: {@link https://threejs.org/examples/#webgl_multiple_scenes_comparison | webgl multiple scenes comparison}
- * @see {@link https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene | Manual: Creating a scene}
- * @see {@link https://threejs.org/docs/index.html#api/en/scenes/Scene | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/scenes/Scene.js | Source}
+ * Scenes allow you to set up what is to be rendered and where by three.js.
+ * This is where you place 3D objects like meshes, lines or lights.
  */
-export class Scene<TEventMap extends Object3DEventMap = Object3DEventMap> extends Object3D<TEventMap> {
+export class Scene extends Object3D {
     /**
-     * Create a new {@link Scene} object.
+     * This flag can be used for type testing.
+     *
+     * @default true
      */
-    constructor();
-
+    readonly isScene: boolean;
     /**
-     * Read-only flag to check if a given object is of type {@link Scene}.
-     * @remarks This is a _constant_ value
-     * @defaultValue `true`
+     * Defines the background of the scene. Valid inputs are:
+     *
+     * - A color for defining a uniform colored background.
+     * - A texture for defining a (flat) textured background.
+     * - Cube textures or equirectangular textures for defining a skybox.
+     *
+     * @default null
      */
-    readonly isScene: true;
-
+    background: (Color | Texture) | null;
     /**
-     * @defaultValue `Scene`
+     * Sets the environment map for all physical materials in the scene. However,
+     * it's not possible to overwrite an existing texture assigned to the `envMap`
+     * material property.
+     *
+     * @default null
      */
-    type: "Scene";
-
+    environment: Texture | null;
     /**
-     * A {@link Fog | fog} instance defining the type of fog that affects everything rendered in the scene.
-     * @defaultValue `null`
+     * A fog instance defining the type of fog that affects everything
+     * rendered in the scene.
+     *
+     * @default null
      */
-    fog: Fog | FogExp2 | null;
-
+    fog: (Fog | FogExp2) | null;
     /**
-     * Sets the blurriness of the background. Only influences environment maps assigned to {@link THREE.Scene.background | Scene.background}.
-     * @defaultValue `0`
-     * @remarks Expects a `Float` between `0` and `1`.
+     * Sets the blurriness of the background. Only influences environment maps
+     * assigned to {@link Scene#background}. Valid input is a float between `0`
+     * and `1`.
+     *
+     * @default 0
      */
     backgroundBlurriness: number;
-
     /**
      * Attenuates the color of the background. Only applies to background textures.
-     * @defaultValue `1`
-     * @remarks Expects a `Float`
+     *
+     * @default 1
      */
     backgroundIntensity: number;
-
-    /**
-     * Forces everything in the {@link Scene} to be rendered with the defined material.
-     * @defaultValue `null`
-     */
-    overrideMaterial: Material | null;
-
     /**
-     * Defines the background of the scene.
-     * @remarks Valid inputs are:
-     *  - A {@link THREE.Color | Color} for defining a uniform colored background.
-     *  - A {@link THREE.Texture | Texture} for defining a (flat) textured background.
-     *  - Texture cubes ({@link THREE.CubeTexture | CubeTexture}) or equirectangular textures for defining a skybox.</li>
-     * @defaultValue `null`
-     */
-    background: Color | Texture | CubeTexture | null;
-
-    /**
-     * The rotation of the background in radians. Only influences environment maps assigned to {@link .background}.
-     * Default is `(0,0,0)`.
+     * The rotation of the background in radians. Only influences environment maps
+     * assigned to {@link Scene#background}.
+     *
+     * @default (0,0,0)
      */
     backgroundRotation: Euler;
-
     /**
-     * Sets the environment map for all physical materials in the scene.
-     * However, it's not possible to overwrite an existing texture assigned to {@link THREE.MeshStandardMaterial.envMap | MeshStandardMaterial.envMap}.
-     * @defaultValue `null`
-     */
-    environment: Texture | null;
-
-    /**
-     * Attenuates the color of the environment. Only influences environment maps assigned to {@link Scene.environment}.
+     * Attenuates the color of the environment. Only influences environment maps
+     * assigned to {@link Scene#environment}.
+     *
      * @default 1
      */
     environmentIntensity: number;
-
     /**
-     * The rotation of the environment map in radians. Only influences physical materials in the scene when
-     * {@link .environment} is used. Default is `(0,0,0)`.
+     * The rotation of the environment map in radians. Only influences physical materials
+     * in the scene when {@link Scene#environment} is used.
+     *
+     * @default (0,0,0)
      */
     environmentRotation: Euler;
-
     /**
-     * Convert the {@link Scene} to three.js {@link https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 | JSON Object/Scene format}.
-     * @param meta Object containing metadata such as textures or images for the scene.
+     * Forces everything in the scene to be rendered with the defined material. It is possible
+     * to exclude materials from override by setting {@link Material#allowOverride} to `false`.
+     *
+     * @default null
      */
+    overrideMaterial: Material | null;
+    copy(source: Scene, recursive?: boolean): this;
     toJSON(meta?: JSONMeta): SceneJSON;
 }

three/src/textures/CompressedArrayTexture.d.ts

@@ -57,7 +57,7 @@ export class CompressedArrayTexture extends CompressedTexture<CompressedArrayTex
     /**
      * Resets the layer updates registry. See {@link CompressedArrayTexture.addLayerUpdate}.
      */
-    clearLayoutUpdates(): void;
+    clearLayerUpdates(): void;
 }
 
 export interface CompressedArrayTextureImageData extends CompressedTextureImageData {

three/src/textures/DataArrayTexture.d.ts

@@ -112,7 +112,7 @@ export class DataArrayTexture extends Texture<DataArrayTextureImageData> {
     /**
      * Resets the layer updates registry. See {@link DataArrayTexture.addLayerUpdate}.
      */
-    clearLayoutUpdates(): void;
+    clearLayerUpdates(): void;
 }
 
 export interface DataArrayTextureImageData {

three/src/utils.d.ts

@@ -1,3 +1,5 @@
+import { DepthModes } from "./constants.js";
+
 declare function isTypedArray(object: unknown): boolean;
 
 declare function createCanvasElement(): HTMLCanvasElement;
@@ -18,6 +20,8 @@ declare function warnOnce(...params: unknown[]): void;
 
 declare function probeAsync(gl: WebGLRenderingContext, sync: WebGLSync, interval: number): Promise<void>;
 
+declare const ReversedDepthFuncs: { [K in DepthModes]: DepthModes };
+
 export {
     createCanvasElement,
     error,
@@ -25,6 +29,7 @@ export {
     isTypedArray,
     log,
     probeAsync,
+    ReversedDepthFuncs,
     setConsoleFunction,
     warn,
     warnOnce,

three/examples/jsm/materials/MeshGouraudMaterial.d.ts

@@ -1,18 +0,0 @@
-/**
- * MeshGouraudMaterial
- *
- * Lambert illumination model with Gouraud (per-vertex) shading
- */
-
-import { ShaderMaterial, ShaderMaterialParameters } from "three";
-
-/**
- * @deprecated Use THREE.MeshLambertMaterial instead.
- */
-export class MeshGouraudMaterial extends ShaderMaterial {
-    isMeshGouraudMaterial: true;
-
-    constructor(parameters?: ShaderMaterialParameters);
-
-    copy(source: MeshGouraudMaterial): this;
-}

three/examples/jsm/materials/MeshPostProcessingMaterial.d.ts

@@ -1,13 +0,0 @@
-import { MeshPhysicalMaterial, MeshPhysicalMaterialParameters, Texture } from "three";
-
-export interface MeshPostProcessingMaterialParameters extends MeshPhysicalMaterialParameters {
-    aoPassMap?: Texture | null | undefined;
-    aoPassMapScale?: number | undefined;
-}
-
-export class MeshPostProcessingMaterial extends MeshPhysicalMaterial {
-    constructor(parameters: MeshPostProcessingMaterialParameters);
-
-    get aoPassMap(): Texture | null | undefined;
-    set aoPassMap(aoPassMap: Texture | null | undefined);
-}

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

@@ -1,44 +0,0 @@
-import { IUniform } from "three";
-
-export const GodRaysDepthMaskShader: {
-    name: string;
-    uniforms: {
-        tInput: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};
-
-export const GodRaysGenerateShader: {
-    name: string;
-    uniforms: {
-        tInput: IUniform;
-        fStepSize: IUniform;
-        vSunPositionScreenSpace: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};
-
-export const GodRaysCombineShader: {
-    name: string;
-    uniforms: {
-        tColors: IUniform;
-        tGodRays: IUniform;
-        fGodRayIntensity: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};
-
-export const GodRaysFakeSunShader: {
-    name: string;
-    uniforms: {
-        vSunPositionScreenSpace: IUniform;
-        fAspect: IUniform;
-        sunColor: IUniform;
-        bgColor: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};

three/src/nodes/accessors/SceneNode.d.ts

@@ -1,21 +0,0 @@
-import { Scene } from "../../scenes/Scene.js";
-import Node from "../core/Node.js";
-
-export type SceneNodeScope = typeof SceneNode.BACKGROUND_BLURRINESS | typeof SceneNode.BACKGROUND_INTENSITY;
-
-declare class SceneNode extends Node {
-    scope: SceneNodeScope;
-    scene: Scene | null;
-
-    constructor(scope?: SceneNodeScope, scene?: Scene | null);
-
-    static BACKGROUND_BLURRINESS: "backgroundBlurriness";
-    static BACKGROUND_INTENSITY: "backgroundIntensity";
-    static BACKGROUND_ROTATION: "backgroundRotation";
-}
-
-export default SceneNode;
-
-export const backgroundBlurriness: SceneNode;
-export const backgroundIntensity: SceneNode;
-export const backgroundRotation: SceneNode;

three/src/nodes/code/ScriptableNode.d.ts

@@ -1,21 +0,0 @@
-import Node from "../core/Node.js";
-
-declare class Resources extends Map<string, unknown> {
-    get<TArgs extends unknown[]>(key: string, callback?: ((...args: TArgs) => void) | null, ...params: TArgs): unknown;
-}
-
-export const ScriptableNodeResources: Resources;
-
-declare class ScriptableNode extends Node {
-    codeNode: Node | null;
-    parameters: Record<string, unknown>;
-
-    constructor(codeNode?: Node | null, parameters?: Record<string, unknown>);
-}
-
-export default ScriptableNode;
-
-export const scriptable: (
-    codeNode: Node,
-    parameters?: Record<string, unknown>,
-) => ScriptableNode;

three/src/nodes/code/ScriptableValueNode.d.ts

@@ -1,9 +0,0 @@
-import Node from "../core/Node.js";
-
-declare class ScriptableValueNode extends Node {
-    constructor(value: unknown);
-}
-
-export default ScriptableValueNode;
-
-export const scriptableValue: (value: unknown) => ScriptableValueNode;

three/src/nodes/display/PosterizeNode.d.ts

@@ -1,13 +0,0 @@
-import Node from "../core/Node.js";
-
-export default class PosterizeNode extends Node {
-    sourceNode: Node;
-    stepsNode: Node;
-
-    constructor(sourceNode: Node, stepsNode: Node);
-}
-
-export const posterize: (
-    sourceNode: Node,
-    stepsNode: Node | number,
-) => PosterizeNode;

three/src/nodes/utils/SpriteSheetUVNode.d.ts

@@ -1,15 +0,0 @@
-import Node from "../core/Node.js";
-
-export default class SpriteSheetUVNode extends Node {
-    countNode: Node;
-    uvNode: Node;
-    frameNode: Node;
-
-    constructor(countNode: Node, uvNode?: Node, frameNode?: Node);
-}
-
-export const spritesheetUV: (
-    countNode: Node,
-    uvNode: Node | null,
-    frameNode: Node | null,
-) => SpriteSheetUVNode;

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

@@ -1,8 +0,0 @@
-import { WebGLRenderer } from "../WebGLRenderer.js";
-
-export class WebGLCubeMaps {
-    constructor(renderer: WebGLRenderer);
-
-    get(texture: any): any;
-    dispose(): void;
-}

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

@@ -1,9 +0,0 @@
-import { Texture } from "../../textures/Texture.js";
-import { WebGLRenderer } from "../WebGLRenderer.js";
-
-export class WebGLCubeUVMaps {
-    constructor(renderer: WebGLRenderer);
-
-    get<T>(texture: T): T extends Texture ? Texture : T;
-    dispose(): void;
-}