@types/three 0.138.0 → 0.139.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: Wed, 02 Mar 2022 16:01:44 GMT
+ * Last updated: Sat, 26 Mar 2022 21:01:43 GMT
  * Dependencies: none
  * Global values: `THREE`
 

three/examples/jsm/exporters/EXRExporter.d.ts

@@ -1,7 +1,8 @@
 /**
  * @author sciecode / https://github.com/sciecode
  *
- * EXR format references: https://www.openexr.com/documentation/openexrfilelayout.pdf
+ * EXR format references:
+ * https://www.openexr.com/documentation/openexrfilelayout.pdf
  */
 
 import { WebGLRenderer, WebGLRenderTarget, TextureDataType } from '../../../src/Three';

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

@@ -3,7 +3,7 @@ import { Scene, Camera, ColorRepresentation, ShaderMaterial, WebGLRenderTarget }
 import { Pass } from './Pass';
 
 export class SSAARenderPass extends Pass {
-    constructor(scene: Scene, camera: Camera, clearColor: ColorRepresentation, clearAlpha: number);
+    constructor(scene: Scene, camera: Camera, clearColor?: ColorRepresentation, clearAlpha?: number);
     scene: Scene;
     camera: Camera;
     sampleLevel: number;

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

@@ -15,3 +15,5 @@ export function estimateBytesUsed(geometry: BufferGeometry): number;
 export function mergeVertices(geometry: BufferGeometry, tolerance?: number): BufferGeometry;
 export function toTrianglesDrawMode(geometry: BufferGeometry, drawMode: TrianglesDrawModes): BufferGeometry;
 export function computeMorphedAttributes(object: Mesh | Line | Points): object;
+export function computeTangents(geometry: BufferGeometry, negateSign?: boolean): BufferGeometry;
+export function mergeGroups(geometry: BufferGeometry): BufferGeometry;

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

@@ -1,4 +1,4 @@
-import { BufferGeometry, Group, InstancedMesh, Material, Object3D, Scene } from '../../../src/Three';
+import { BufferGeometry, Group, InstancedMesh, Material, Object3D, Scene, Mesh } from '../../../src/Three';
 
 export function createMeshesFromInstancedMesh(instancedMesh: InstancedMesh): Group;
 export function createMultiMaterialObject(geometry: BufferGeometry, materials: Material[]): Group;
@@ -10,3 +10,5 @@ export function detach(child: Object3D, parent: Object3D, scene: Scene): void;
  * @deprecated Use parent.attach( child ) instead.
  */
 export function attach(child: Object3D, scene: Scene, parent: Object3D): void;
+
+export function createMeshesFromMultiMaterialMesh(mesh: Mesh): Group;

three/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for three 0.138
+// Type definitions for three 0.139
 // Project: https://threejs.org/
 // Definitions by: Josh Ellis <https://github.com/joshuaellis>
 //                 Nathan Bierema <https://github.com/Methuselah96>

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.138.0",
+    "version": "0.139.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -25,6 +25,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "7873774346bfbeaa8143902909709f9b2a5154afc0017f590bff41e5d3e5e0b7",
+    "typesPublisherContentHash": "3d3b533eda48e6d4aad35b8b2177550c7d54d7f9eef4a9c679730a92b75d3551",
     "typeScriptVersion": "3.9"
 }

three/src/Three.d.ts

@@ -209,6 +209,7 @@ export * from './renderers/webgl/WebGLUniforms';
 export * from './renderers/webxr/WebXR';
 export * from './renderers/webxr/WebXRController';
 export * from './renderers/webxr/WebXRManager';
+export { WebGLUtils } from './renderers/webgl/WebGLUtils.js';
 /**
  * Scenes
  */

three/src/animation/AnimationUtils.d.ts

@@ -4,7 +4,7 @@ export namespace AnimationUtils {
     function arraySlice(array: any, from: number, to: number): any;
     function convertArray(array: any, type: any, forceClone: boolean): any;
     function isTypedArray(object: any): boolean;
-    function getKeyFrameOrder(times: number[]): number[];
+    function getKeyframeOrder(times: number[]): number[];
     function sortedArray(values: any[], stride: number, order: number[]): any[];
     function flattenJSON(jsonKeys: string[], times: any[], values: any[], valuePropertyName: string): void;
 

three/src/constants.d.ts

@@ -115,7 +115,6 @@ export const CubeRefractionMapping: Mapping;
 export const EquirectangularReflectionMapping: Mapping;
 export const EquirectangularRefractionMapping: Mapping;
 export const CubeUVReflectionMapping: Mapping;
-export const CubeUVRefractionMapping: Mapping;
 
 // Wrapping modes
 export enum Wrapping {}
@@ -153,6 +152,7 @@ export const UnsignedInt248Type: TextureDataType;
 // Pixel formats
 export enum PixelFormat {}
 export const AlphaFormat: PixelFormat;
+export const RGBFormat: PixelFormat;
 export const RGBAFormat: PixelFormat;
 export const LuminanceFormat: PixelFormat;
 export const LuminanceAlphaFormat: PixelFormat;
@@ -313,6 +313,11 @@ export enum NormalMapTypes {}
 export const TangentSpaceNormalMap: NormalMapTypes;
 export const ObjectSpaceNormalMap: NormalMapTypes;
 
+export type ColorSpace = NoColorSpace | SRGBColorSpace | LinearSRGBColorSpace;
+export type NoColorSpace = '';
+export type SRGBColorSpace = 'srgb';
+export type LinearSRGBColorSpace = 'srgb-linear';
+
 // Stencil Op types
 export enum StencilOp {}
 export const ZeroStencilOp: StencilOp;

three/src/core/BufferGeometry.d.ts

@@ -22,8 +22,6 @@ export class BufferGeometry extends EventDispatcher {
      */
     constructor();
 
-    static MaxIndex: number;
-
     /**
      * Unique number of this buffergeometry instance
      */

three/src/core/InstancedBufferGeometry.d.ts

@@ -13,12 +13,8 @@ export class InstancedBufferGeometry extends BufferGeometry {
 
     isInstancedBufferGeometry: boolean;
 
-    groups: Array<{ start: number; count: number; instances: number }>;
-
     /**
      * @default Infinity
      */
     instanceCount: number;
-
-    addGroup(start: number, count: number, instances: number): void;
 }

three/src/core/Uniform.d.ts

@@ -13,7 +13,6 @@ export class Uniform {
      * @deprecated Use {@link Object3D#onBeforeRender object.onBeforeRender()} instead.
      */
     dynamic: boolean;
-    onUpdateCallback: () => void;
 
     /**
      * @deprecated Use {@link Object3D#onBeforeRender object.onBeforeRender()} instead.

three/src/extras/DataUtils.d.ts

@@ -1,3 +1,4 @@
 export namespace DataUtils {
     function toHalfFloat(val: number): number;
+    function fromHalfFloat(val: number): number;
 }

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

@@ -80,11 +80,6 @@ export class Material extends EventDispatcher {
      */
     alphaToCoverage: boolean;
 
-    /**
-     * @default false
-     */
-    alphaWrite: boolean;
-
     /**
      * Blending destination. It's one of the blending mode constants defined in Three.js. Default is {@link OneMinusSrcAlphaFactor}.
      * @default THREE.OneMinusSrcAlphaFactor

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/Color.d.ts

@@ -1,13 +1,21 @@
+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 function SRGBToLinear(c: number): number;
+export interface RGB {
+    r: number;
+    g: number;
+    b: number;
+}
 
 /**
  * Represents a color. See also {@link ColorUtils}.
@@ -43,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.
@@ -51,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.
@@ -61,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.
@@ -112,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/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/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;

three/src/renderers/WebGLRenderer.d.ts

@@ -218,7 +218,7 @@ export class WebGLRenderer implements Renderer {
     /**
      * Return the WebGL context.
      */
-    getContext(): WebGLRenderingContext;
+    getContext(): WebGLRenderingContext | WebGL2RenderingContext;
     getContextAttributes(): any;
     forceContextLoss(): void;
     forceContextRestore(): void;

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

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

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/examples/jsm/postprocessing/SSRrPass.d.ts

@@ -1,121 +0,0 @@
-import {
-    Color,
-    MeshNormalMaterial,
-    MeshBasicMaterial,
-    ShaderMaterial,
-    WebGLRenderTarget,
-    MeshStandardMaterial,
-    WebGLRenderer,
-    Scene,
-    Camera,
-    Mesh,
-    Material,
-    ColorRepresentation,
-} from '../../../src/Three';
-import { Pass, FullScreenQuad } from './Pass';
-
-export interface SSRrPassParams {
-    renderer: WebGLRenderer;
-    scene: Scene;
-    camera: Camera;
-    width?: number | undefined;
-    height?: number | undefined;
-    selects: Mesh[] | null;
-}
-
-export class SSRrPass extends Pass {
-    width: number;
-    height: number;
-    clear: boolean;
-
-    renderer: WebGLRenderer;
-    scene: Scene;
-    camera: Camera;
-
-    output: number;
-
-    ior: number;
-    maxDistance: number;
-    surfDist: number;
-
-    color: Color;
-
-    seleects: Mesh[] | null;
-
-    _specular: boolean;
-    get specular(): boolean;
-    set specular(spec: boolean);
-
-    _fillHole: boolean;
-    get fillHole(): boolean;
-    set fillHole(spec: boolean);
-
-    _infiniteThick: boolean;
-    get infiniteThick(): boolean;
-    set infiniteThick(spec: boolean);
-
-    beautyRenderTarget: WebGLRenderTarget;
-    specularRenderTarget: WebGLRenderTarget;
-    normalSelectsRenderTarget: WebGLRenderTarget;
-    refractiveRenderTarget: WebGLRenderTarget;
-    ssrrRenderTarget: WebGLRenderTarget;
-
-    ssrrMaterial: ShaderMaterial;
-
-    normalMaterial: MeshNormalMaterial;
-    refractiveOnMaterial: MeshBasicMaterial;
-    refractiveOffMaterial: MeshBasicMaterial;
-    specularMaterial: MeshStandardMaterial;
-
-    depthRenderMaterial: ShaderMaterial;
-    copyMaterial: ShaderMaterial;
-
-    fsQuad: FullScreenQuad;
-
-    originalClearColor: Color;
-
-    constructor(params: SSRrPassParams);
-
-    dispose: () => void;
-
-    render: (renderer: WebGLRenderer, writeBuffer: WebGLRenderTarget) => void;
-
-    renderPass: (
-        renderer: WebGLRenderer,
-        passMaterial: Material,
-        renderTarget: WebGLRenderTarget,
-        clearColor: ColorRepresentation,
-        clearAlpha: ColorRepresentation,
-    ) => void;
-
-    renderOverride: (
-        renderer: WebGLRenderer,
-        passMaterial: Material,
-        renderTarget: WebGLRenderTarget,
-        clearColor: ColorRepresentation,
-        clearAlpha: ColorRepresentation,
-    ) => void;
-
-    renderRefractive: (
-        renderer: WebGLRenderer,
-        passMaterial: Material,
-        renderTarget: WebGLRenderTarget,
-        clearColor: ColorRepresentation,
-        clearAlpha: ColorRepresentation,
-    ) => void;
-
-    setSize: (width: number, height: number) => void;
-}
-
-export namespace SSRrPass {
-    interface OUTPUT {
-        Default: 0;
-        SSRr: 1;
-        Beauty: 3;
-        Depth: 4;
-        DepthSelects: 9;
-        NormalSelects: 5;
-        Refractive: 7;
-        Specular: 8;
-    }
-}