@types/three 0.169.0 → 0.171.0

three/src/constants.d.ts

@@ -697,23 +697,15 @@ export type NormalMapTypes = typeof TangentSpaceNormalMap | typeof ObjectSpaceNo
 export const NoColorSpace: "";
 export const SRGBColorSpace: "srgb";
 export const LinearSRGBColorSpace: "srgb-linear";
-export const DisplayP3ColorSpace: "display-p3";
-export const LinearDisplayP3ColorSpace = "display-p3-linear";
 export type ColorSpace =
     | typeof NoColorSpace
     | typeof SRGBColorSpace
-    | typeof LinearSRGBColorSpace
-    | typeof DisplayP3ColorSpace
-    | typeof LinearDisplayP3ColorSpace;
+    | typeof LinearSRGBColorSpace;
 
 export const LinearTransfer: "linear";
 export const SRGBTransfer: "srgb";
 export type ColorSpaceTransfer = typeof LinearTransfer | typeof SRGBTransfer;
 
-export const Rec709Primaries: "rec709";
-export const P3Primaries: "p3";
-export type ColorSpacePrimaries = typeof Rec709Primaries | typeof P3Primaries;
-
 // Stencil Op types
 export const ZeroStencilOp: 0;
 export const KeepStencilOp: 7680;

three/src/core/BufferGeometry.d.ts

@@ -4,6 +4,7 @@ import { Quaternion } from "../math/Quaternion.js";
 import { Sphere } from "../math/Sphere.js";
 import { Vector2 } from "../math/Vector2.js";
 import { Vector3, Vector3Tuple } from "../math/Vector3.js";
+import IndirectStorageBufferAttribute from "../renderers/common/IndirectStorageBufferAttribute.js";
 import { BufferAttribute, BufferAttributeJSON } from "./BufferAttribute.js";
 import { EventDispatcher } from "./EventDispatcher.js";
 import { GLBufferAttribute } from "./GLBufferAttribute.js";
@@ -155,6 +156,8 @@ export class BufferGeometry<
      */
     index: BufferAttribute | null;
 
+    indirect: IndirectStorageBufferAttribute | null;
+
     /**
      * This hashmap has as id the name of the attribute to be set and as value the {@link THREE.BufferAttribute | buffer} to set it to. Rather than accessing this property directly,
      * use {@link setAttribute | .setAttribute} and {@link getAttribute | .getAttribute} to access attributes of this geometry.
@@ -233,6 +236,10 @@ export class BufferGeometry<
      */
     setIndex(index: BufferAttribute | number[] | null): this;
 
+    setIndirect(indirect: IndirectStorageBufferAttribute | null): this;
+
+    getIndirect(): IndirectStorageBufferAttribute | null;
+
     /**
      * Sets an {@link attributes | attribute} to this geometry with the specified name.
      * @remarks
@@ -352,8 +359,12 @@ export class BufferGeometry<
     center(): this;
 
     /**
-     * Sets the attributes for this BufferGeometry from an array of points.
-     * @param points
+     * Defines a geometry by creating a `position` attribute based on the given array of points. The array can hold
+     * instances of {@link Vector2} or {@link Vector3}. When using two-dimensional data, the `z` coordinate for all
+     * vertices is set to `0`.
+     *
+     * If the method is used with an existing `position` attribute, the vertex data are overwritten with the data from
+     * the array. The length of the array must match the vertex count.
      */
     setFromPoints(points: Vector3[] | Vector2[]): this;
 

three/src/core/Clock.d.ts

@@ -1,10 +1,8 @@
 /**
- * Object for keeping track of time
- * @remarks
- * This uses {@link https://developer.mozilla.org/en-US/docs/Web/API/Performance/now | performance.now} if it is available,
- * otherwise it reverts to the less accurate {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date/now | Date.now}.
- * @see {@link https://threejs.org/docs/index.html#api/en/core/Clock | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/core/Clock.js | Source}
+ * Object for keeping track of time. This uses
+ * [performance.now]{@link https://developer.mozilla.org/en-US/docs/Web/API/Performance/now}.
+ * @see [Official Documentation]{@link https://threejs.org/docs/index.html#api/en/core/Clock}
+ * @see [Source]{@link https://github.com/mrdoob/three.js/blob/master/src/core/Clock.js}
  */
 export class Clock {
     /**

three/src/core/InterleavedBuffer.d.ts

@@ -85,6 +85,18 @@ export class InterleavedBuffer {
      */
     uuid: string;
 
+    /**
+     * A callback function that is executed after the Renderer has transferred the geometry data to the GPU.
+     */
+    onUploadCallback: () => void;
+
+    /**
+     * Sets the value of the {@link onUploadCallback} property.
+     * @see {@link onUploadCallback}
+     * @param callback function that is executed after the Renderer has transferred the geometry data to the GPU.
+     */
+    onUpload(callback: () => void): this;
+
     /**
      * Calls {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set | TypedArray.set}( {@link value}, {@link offset} )
      * on the {@link BufferAttribute.array | array}.

three/src/core/RenderTarget.d.ts

@@ -1,5 +1,4 @@
 import {
-    ColorSpace,
     MagnificationTextureFilter,
     MinificationTextureFilter,
     PixelFormatGPU,
@@ -20,7 +19,7 @@ export interface RenderTargetOptions {
     format?: number | undefined; // RGBAFormat
     type?: TextureDataType | undefined; // UnsignedByteType
     anisotropy?: number | undefined; // 1
-    colorSpace?: ColorSpace | undefined;
+    colorSpace?: string | undefined;
     internalFormat?: PixelFormatGPU | null | undefined; // null
     depthBuffer?: boolean | undefined; // true
     stencilBuffer?: boolean | undefined; // false

three/src/loaders/FileLoader.d.ts

@@ -11,9 +11,9 @@ export class FileLoader extends Loader<string | ArrayBuffer> {
         onError?: (err: unknown) => void,
     ): void;
 
-    mimeType: undefined | MimeType;
-    responseType: undefined | string;
+    mimeType: string | undefined;
+    responseType: string | undefined;
 
-    setMimeType(mimeType: MimeType): FileLoader;
+    setMimeType(mimeType: string): FileLoader;
     setResponseType(responseType: string): FileLoader;
 }

three/src/materials/LineBasicMaterial.d.ts

@@ -20,11 +20,6 @@ export class LineBasicMaterial extends Material {
      */
     readonly isLineBasicMaterial: true;
 
-    /**
-     * @default 'LineBasicMaterial'
-     */
-    type: string;
-
     /**
      * @default 0xffffff
      */

three/src/materials/LineDashedMaterial.d.ts

@@ -16,11 +16,6 @@ export class LineDashedMaterial extends LineBasicMaterial {
      */
     readonly isLineDashedMaterial: true;
 
-    /**
-     * @default 'LineDashedMaterial'
-     */
-    type: string;
-
     /**
      * @default 1
      */

three/src/materials/Material.d.ts

@@ -243,6 +243,12 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
      */
     readonly isMaterial: true;
 
+    /**
+     * Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a
+     * scene.
+     */
+    type: string;
+
     /**
      * Enables alpha hashed transparency, an alternative to {@link .transparent} or {@link .alphaTest}. The material
      * will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise,
@@ -509,12 +515,6 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
      */
     transparent: boolean;
 
-    /**
-     * Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a scene.
-     * @default 'Material'
-     */
-    type: string;
-
     /**
      * UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.
      */

three/src/materials/MeshBasicMaterial.d.ts

@@ -39,11 +39,6 @@ export class MeshBasicMaterial extends Material {
      */
     readonly isMeshBasicMaterial: true;
 
-    /**
-     * @default 'MeshBasicMaterial'
-     */
-    type: string;
-
     /**
      * @default new THREE.Color( 0xffffff )
      */

three/src/materials/MeshDepthMaterial.d.ts

@@ -22,11 +22,6 @@ export class MeshDepthMaterial extends Material {
      */
     readonly isMeshDepthMaterial: true;
 
-    /**
-     * @default 'MeshDepthMaterial'
-     */
-    type: string;
-
     /**
      * @default null
      */

three/src/materials/MeshDistanceMaterial.d.ts

@@ -23,11 +23,6 @@ export class MeshDistanceMaterial extends Material {
      */
     readonly isMeshDistanceMaterial: true;
 
-    /**
-     * @default 'MeshDistanceMaterial'
-     */
-    type: string;
-
     /**
      * @default null
      */

three/src/materials/MeshLambertMaterial.d.ts

@@ -47,11 +47,6 @@ export class MeshLambertMaterial extends Material {
      */
     readonly isMeshLambertMaterial: true;
 
-    /**
-     * @default 'MeshLambertMaterial'
-     */
-    type: string;
-
     /**
      * @default new THREE.Color( 0xffffff )
      */

three/src/materials/MeshMatcapMaterial.d.ts

@@ -31,11 +31,6 @@ export class MeshMatcapMaterial extends Material {
      */
     readonly isMeshMatcapMaterial: true;
 
-    /**
-     * @default 'MeshMatcapMaterial'
-     */
-    type: string;
-
     /**
      * @default { 'MATCAP': '' }
      */

three/src/materials/MeshNormalMaterial.d.ts

@@ -28,11 +28,6 @@ export class MeshNormalMaterial extends Material {
      */
     readonly isMeshNormalMaterial: true;
 
-    /**
-     * @default 'MeshNormalMaterial'
-     */
-    type: string;
-
     /**
      * @default null
      */

three/src/materials/MeshPhongMaterial.d.ts

@@ -52,11 +52,6 @@ export class MeshPhongMaterial extends Material {
      */
     readonly isMeshPhongMaterial: true;
 
-    /**
-     * @default 'MeshNormalMaterial'
-     */
-    type: string;
-
     /**
      * @default new THREE.Color( 0xffffff )
      */

three/src/materials/MeshPhysicalMaterial.d.ts

@@ -62,11 +62,6 @@ export class MeshPhysicalMaterial extends MeshStandardMaterial {
      */
     defines: { [key: string]: any };
 
-    /**
-     * @default 'MeshPhysicalMaterial'
-     */
-    type: string;
-
     /**
      * @default 0
      */

three/src/materials/MeshStandardMaterial.d.ts

@@ -47,11 +47,6 @@ export class MeshStandardMaterial extends Material {
      */
     readonly isMeshStandardMaterial: true;
 
-    /**
-     * @default 'MeshStandardMaterial'
-     */
-    type: string;
-
     /**
      * @default { 'STANDARD': '' }
      */

three/src/materials/MeshToonMaterial.d.ts

@@ -43,11 +43,6 @@ export class MeshToonMaterial extends Material {
      */
     readonly isMeshToonMaterial: true;
 
-    /**
-     * @default 'MeshToonMaterial'
-     */
-    type: string;
-
     /**
      * @default { 'TOON': '' }
      */

three/src/materials/PointsMaterial.d.ts

@@ -21,11 +21,6 @@ export class PointsMaterial extends Material {
      */
     readonly isPointsMaterial: true;
 
-    /**
-     * @default 'PointsMaterial'
-     */
-    type: string;
-
     /**
      * @default new THREE.Color( 0xffffff )
      */

three/src/materials/RawShaderMaterial.d.ts

@@ -9,6 +9,4 @@ export class RawShaderMaterial extends ShaderMaterial {
      * @defaultValue `true`
      */
     readonly isRawShaderMaterial: true;
-
-    override readonly type: "RawShaderMaterial";
 }

three/src/materials/ShaderMaterial.d.ts

@@ -79,11 +79,6 @@ export class ShaderMaterial extends Material {
      */
     readonly isShaderMaterial: true;
 
-    /**
-     * @default 'ShaderMaterial'
-     */
-    type: string;
-
     /**
      * @default {}
      */

three/src/materials/ShadowMaterial.d.ts

@@ -16,11 +16,6 @@ export class ShadowMaterial extends Material {
      */
     readonly isShadowMaterial: true;
 
-    /**
-     * @default 'ShadowMaterial'
-     */
-    type: string;
-
     /**
      * @default new THREE.Color( 0x000000 )
      */

three/src/materials/SpriteMaterial.d.ts

@@ -20,11 +20,6 @@ export class SpriteMaterial extends Material {
      */
     readonly isSpriteMaterial: true;
 
-    /**
-     * @default 'SpriteMaterial'
-     */
-    type: string;
-
     /**
      * @default new THREE.Color( 0xffffff )
      */

three/src/materials/nodes/LineDashedNodeMaterial.d.ts

@@ -3,6 +3,7 @@ import { LineDashedMaterialParameters } from "../LineDashedMaterial.js";
 import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
 
 export interface LineDashedNodeMaterialParameters extends NodeMaterialParameters, LineDashedMaterialParameters {
+    dashOffset?: number | undefined;
     offsetNode?: Node | null | undefined;
     dashScaleNode?: Node | null | undefined;
     dashSizeNode?: Node | null | undefined;
@@ -12,6 +13,8 @@ export interface LineDashedNodeMaterialParameters extends NodeMaterialParameters
 declare class LineDashedNodeMaterial extends NodeMaterial {
     readonly isLineDashedNodeMaterial: true;
 
+    dashOffset: number;
+
     offsetNode: Node | null;
     dashScaleNode: Node | null;
     dashSizeNode: Node | null;

three/src/materials/nodes/MeshNormalNodeMaterial.d.ts

@@ -4,7 +4,7 @@ import { Texture } from "../../textures/Texture.js";
 import { MeshNormalMaterialParameters } from "../MeshNormalMaterial.js";
 import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
 
-export interface MeshBasicNodeMaterialParameters extends NodeMaterialParameters, MeshNormalMaterialParameters {
+export interface MeshNormalNodeMaterialParameters extends NodeMaterialParameters, MeshNormalMaterialParameters {
 }
 
 export default class MeshNormalNodeMaterial extends NodeMaterial {
@@ -24,5 +24,5 @@ export default class MeshNormalNodeMaterial extends NodeMaterial {
     wireframeLinewidth: number;
     flatShading: boolean;
 
-    constructor(parameters?: MeshBasicNodeMaterialParameters);
+    constructor(parameters?: MeshNormalNodeMaterialParameters);
 }

three/src/materials/nodes/NodeMaterial.d.ts

@@ -24,6 +24,7 @@ export interface NodeMaterialParameters extends MaterialParameters {
     alphaTestNode?: Node | null | undefined;
 
     positionNode?: Node | null | undefined;
+    geometryNode?: Node | null | undefined;
 
     depthNode?: Node | null | undefined;
     shadowNode?: Node | null | undefined;
@@ -41,6 +42,7 @@ declare class NodeMaterial extends Material {
 
     fog: boolean;
     lights: boolean;
+    hardwareClipping: boolean;
 
     lightsNode: LightsNode | null;
     envNode: Node | null;
@@ -54,10 +56,12 @@ declare class NodeMaterial extends Material {
     alphaTestNode: Node | null;
 
     positionNode: Node | null;
+    geometryNode: Node | null;
 
     depthNode: Node | null;
-    shadowNode: Node | null;
     shadowPositionNode: Node | null;
+    receivedShadowNode: Node | null;
+    castShadowNode: Node | null;
 
     outputNode: Node | null;
     mrtNode: MRTNode | null;
@@ -70,6 +74,7 @@ declare class NodeMaterial extends Material {
     build(builder: NodeBuilder): void;
     setup(builder: NodeBuilder): void;
     setupClipping(builder: NodeBuilder): ClippingNode | null;
+    setupHardwareClipping(builder: NodeBuilder): void;
     setupDepth(builder: NodeBuilder): void;
     setupPosition(builder: NodeBuilder): Node;
     setupDiffuseColor(builder: NodeBuilder): void;

three/src/materials/nodes/NodeMaterials.d.ts

@@ -1,18 +1,21 @@
-export { default as InstancedPointsNodeMaterial } from "./InstancedPointsNodeMaterial.js";
-export { default as Line2NodeMaterial } from "./Line2NodeMaterial.js";
-export { default as LineBasicNodeMaterial } from "./LineBasicNodeMaterial.js";
-export { default as LineDashedNodeMaterial } from "./LineDashedNodeMaterial.js";
-export { default as MeshBasicNodeMaterial } from "./MeshBasicNodeMaterial.js";
-export { default as MeshLambertNodeMaterial } from "./MeshLambertNodeMaterial.js";
-export { default as MeshMatcapNodeMaterial } from "./MeshMatcapNodeMaterial.js";
-export { default as MeshNormalNodeMaterial } from "./MeshNormalNodeMaterial.js";
-export { default as MeshPhongNodeMaterial } from "./MeshPhongNodeMaterial.js";
-export { default as MeshPhysicalNodeMaterial } from "./MeshPhysicalNodeMaterial.js";
+export {
+    default as InstancedPointsNodeMaterial,
+    InstancedPointsNodeMaterialParameters,
+} from "./InstancedPointsNodeMaterial.js";
+export { default as Line2NodeMaterial, Line2NodeMaterialParameters } from "./Line2NodeMaterial.js";
+export { default as LineBasicNodeMaterial, LineBasicNodeMaterialParameters } from "./LineBasicNodeMaterial.js";
+export { default as LineDashedNodeMaterial, LineDashedNodeMaterialParameters } from "./LineDashedNodeMaterial.js";
+export { default as MeshBasicNodeMaterial, MeshBasicNodeMaterialParameters } from "./MeshBasicNodeMaterial.js";
+export { default as MeshLambertNodeMaterial, MeshLambertNodeMaterialParameters } from "./MeshLambertNodeMaterial.js";
+export { default as MeshMatcapNodeMaterial, MeshMatcapNodeMaterialParameters } from "./MeshMatcapNodeMaterial.js";
+export { default as MeshNormalNodeMaterial, MeshNormalNodeMaterialParameters } from "./MeshNormalNodeMaterial.js";
+export { default as MeshPhongNodeMaterial, MeshPhongNodeMaterialParameters } from "./MeshPhongNodeMaterial.js";
+export { default as MeshPhysicalNodeMaterial, MeshPhysicalNodeMaterialParameters } from "./MeshPhysicalNodeMaterial.js";
 export { default as MeshSSSNodeMaterial } from "./MeshSSSNodeMaterial.js";
-export { default as MeshStandardNodeMaterial } from "./MeshStandardNodeMaterial.js";
-export { default as MeshToonNodeMaterial } from "./MeshToonNodeMaterial.js";
-export { default as NodeMaterial } from "./NodeMaterial.js";
-export { default as PointsNodeMaterial } from "./PointsNodeMaterial.js";
-export { default as ShadowNodeMaterial } from "./ShadowNodeMaterial.js";
-export { default as SpriteNodeMaterial } from "./SpriteNodeMaterial.js";
+export { default as MeshStandardNodeMaterial, MeshStandardNodeMaterialParameters } from "./MeshStandardNodeMaterial.js";
+export { default as MeshToonNodeMaterial, MeshToonNodeMaterialParameters } from "./MeshToonNodeMaterial.js";
+export { default as NodeMaterial, NodeMaterialParameters } from "./NodeMaterial.js";
+export { default as PointsNodeMaterial, PointsNodeMaterialParameters } from "./PointsNodeMaterial.js";
+export { default as ShadowNodeMaterial, ShadowNodeMaterialParameters } from "./ShadowNodeMaterial.js";
+export { default as SpriteNodeMaterial, SpriteNodeMaterialParameters } from "./SpriteNodeMaterial.js";
 export { default as VolumeNodeMaterial } from "./VolumeNodeMaterial.js";

three/src/materials/nodes/manager/NodeMaterialObserver.d.ts

@@ -1,3 +1,4 @@
+import { BufferAttribute } from "../../../core/BufferAttribute.js";
 import { Matrix4 } from "../../../math/Matrix4.js";
 import NodeBuilder from "../../../nodes/core/NodeBuilder.js";
 import NodeFrame from "../../../nodes/core/NodeFrame.js";
@@ -59,8 +60,21 @@ type RefreshUniform = (typeof refreshUniforms)[number];
 type MaterialData = {
     [K in RefreshUniform]?: unknown;
 };
+interface AttributesData {
+    [name: string]: {
+        version: number;
+    };
+}
 interface RenderObjectData {
     material: MaterialData;
+    geometry: {
+        attributes: AttributesData;
+        indexVersion: number | null;
+        drawRange: {
+            start: number;
+            count: number;
+        };
+    };
     worldMatrix: Matrix4;
     version?: number;
 }
@@ -73,6 +87,7 @@ declare class NodeMaterialObserver {
     constructor(builder: NodeBuilder);
     firstInitialization(renderObject: RenderObject): boolean;
     getRenderObjectData(renderObject: RenderObject): RenderObjectData;
+    getAttributesData(attributes: Record<string, BufferAttribute>): AttributesData;
     containsNode(builder: NodeBuilder): boolean;
     getMaterialData(material: Material): MaterialData;
     equals(renderObject: RenderObject): boolean;