@types/three 0.150.0 → 0.150.2

three/src/constants.d.ts

@@ -1,25 +1,21 @@
 export const REVISION: string;
 
 // https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent.button
-export const MOUSE: {
-    LEFT: 0;
-    MIDDLE: 1;
-    RIGHT: 2;
-    ROTATE: 0;
-    DOLLY: 1;
-    PAN: 2;
-};
-
-export type MouseButton = 0 | 1 | 2;
-
-export const TOUCH: {
-    ROTATE: 0;
-    PAN: 1;
-    DOLLY_PAN: 2;
-    DOLLY_ROTATE: 3;
-};
-
-export type TouchCount = 0 | 1 | 2 | 3;
+export enum MOUSE {
+    LEFT = 0,
+    MIDDLE = 1,
+    RIGHT = 2,
+    ROTATE = 0,
+    DOLLY = 1,
+    PAN = 2,
+}
+
+export enum TOUCH {
+    ROTATE = 0,
+    PAN = 1,
+    DOLLY_PAN = 2,
+    DOLLY_ROTATE = 3,
+}
 
 // GL STATE CONSTANTS
 export const CullFaceNone: 0;
@@ -146,39 +142,153 @@ export type ToneMapping =
     | typeof ACESFilmicToneMapping
     | typeof CustomToneMapping;
 
+///////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
 // Mapping modes
+
+/**
+ * Maps the texture using the mesh's UV coordinates.
+ * @remarks This is the _default_ value and behaver for Texture Mapping.
+ */
 export const UVMapping: 300;
+
+/**
+ * @remarks This is the _default_ value and behaver for Cube Texture Mapping.
+ */
 export const CubeReflectionMapping: 301;
 export const CubeRefractionMapping: 302;
+export const CubeUVReflectionMapping: 306;
+
 export const EquirectangularReflectionMapping: 303;
 export const EquirectangularRefractionMapping: 304;
-export const CubeUVReflectionMapping: 306;
+
+/**
+ * Texture Mapping Modes for non-cube Textures
+ * @remarks {@link UVMapping} is the _default_ value and behaver for Texture Mapping.
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
 export type Mapping =
     | typeof UVMapping
+    | typeof EquirectangularReflectionMapping
+    | typeof EquirectangularRefractionMapping;
+
+/**
+ * Texture Mapping Modes for cube Textures
+ * @remarks {@link CubeReflectionMapping} is the _default_ value and behaver for Cube Texture Mapping.
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
+export type CubeTextureMapping =
     | typeof CubeReflectionMapping
     | typeof CubeRefractionMapping
-    | typeof EquirectangularReflectionMapping
-    | typeof EquirectangularRefractionMapping
     | typeof CubeUVReflectionMapping;
 
+/**
+ * Texture Mapping Modes for any type of Textures
+ * @see {@link Mapping} and {@link CubeTextureMapping}
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
+export type AnyMapping = Mapping | CubeTextureMapping;
+
+///////////////////////////////////////////////////////////////////////////////
 // Wrapping modes
+
+/** With {@link RepeatWrapping} the texture will simply repeat to infinity. */
 export const RepeatWrapping: 1000;
+/**
+ * With {@link ClampToEdgeWrapping} the last pixel of the texture stretches to the edge of the mesh.
+ * @remarks This is the _default_ value and behaver for Wrapping Mapping.
+ */
 export const ClampToEdgeWrapping: 1001;
+/** With {@link MirroredRepeatWrapping} the texture will repeats to infinity, mirroring on each repeat. */
 export const MirroredRepeatWrapping: 1002;
+
+/**
+ * Texture Wrapping Modes
+ * @remarks {@link ClampToEdgeWrapping} is the _default_ value and behaver for Wrapping Mapping.
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
 export type Wrapping = typeof RepeatWrapping | typeof ClampToEdgeWrapping | typeof MirroredRepeatWrapping;
 
+///////////////////////////////////////////////////////////////////////////////
 // Filters
+
+/** {@link NearestFilter} returns the value of the texture element that is nearest (in Manhattan distance) to the specified texture coordinates. */
 export const NearestFilter: 1003;
+
+/**
+ * {@link NearestMipmapNearestFilter} chooses the mipmap that most closely matches the size of the pixel being textured
+ * and uses the {@link NearestFilter} criterion (the texel nearest to the center of the pixel) to produce a texture value.
+ */
 export const NearestMipmapNearestFilter: 1004;
+/**
+ * {@link NearestMipmapNearestFilter} chooses the mipmap that most closely matches the size of the pixel being textured
+ * and uses the {@link NearestFilter} criterion (the texel nearest to the center of the pixel) to produce a texture value.
+ */
 export const NearestMipMapNearestFilter: 1004;
+
+/**
+ * {@link NearestMipmapLinearFilter} chooses the two mipmaps that most closely match the size of the pixel being textured
+ * and uses the {@link NearestFilter} criterion to produce a texture value from each mipmap.
+ * The final texture value is a weighted average of those two values.
+ */
 export const NearestMipmapLinearFilter: 1005;
+/**
+ * {@link NearestMipMapLinearFilter} chooses the two mipmaps that most closely match the size of the pixel being textured
+ * and uses the {@link NearestFilter} criterion to produce a texture value from each mipmap.
+ * The final texture value is a weighted average of those two values.
+ */
 export const NearestMipMapLinearFilter: 1005;
+
+/**
+ * {@link LinearFilter} returns the weighted average of the four texture elements that are closest to the specified texture coordinates,
+ * and can include items wrapped or repeated from other parts of a texture,
+ * depending on the values of {@link THREE.Texture.wrapS | wrapS} and {@link THREE.Texture.wrapT | wrapT}, and on the exact mapping.
+ */
 export const LinearFilter: 1006;
+
+/**
+ * {@link LinearMipmapNearestFilter} chooses the mipmap that most closely matches the size of the pixel being textured and
+ * uses the {@link LinearFilter} criterion (a weighted average of the four texels that are closest to the center of the pixel) to produce a texture value.
+ */
 export const LinearMipmapNearestFilter: 1007;
+/**
+ * {@link LinearMipMapNearestFilter} chooses the mipmap that most closely matches the size of the pixel being textured and
+ * uses the {@link LinearFilter} criterion (a weighted average of the four texels that are closest to the center of the pixel) to produce a texture value.
+ */
 export const LinearMipMapNearestFilter: 1007;
+
+/**
+ * {@link LinearMipmapLinearFilter} is the default and chooses the two mipmaps that most closely match the size of the pixel being textured and
+ * uses the {@link LinearFilter} criterion to produce a texture value from each mipmap.
+ * The final texture value is a weighted average of those two values.
+ */
 export const LinearMipmapLinearFilter: 1008;
+
+/**
+ * {@link LinearMipMapLinearFilter} is the default and chooses the two mipmaps that most closely match the size of the pixel being textured and
+ * uses the {@link LinearFilter} criterion to produce a texture value from each mipmap.
+ * The final texture value is a weighted average of those two values.
+ */
 export const LinearMipMapLinearFilter: 1008;
-export type TextureFilter =
+
+/**
+ * Texture Magnification Filter Modes.
+ * For use with a texture's {@link THREE.Texture.magFilter | magFilter} property,
+ * these define the texture magnification function to be used when the pixel being textured maps to an area less than or equal to one texture element (texel).
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ * @see {@link https://sbcode.net/threejs/mipmaps/ | Texture Mipmaps (non-official)}
+ */
+export type MagnificationTextureFilter = typeof NearestFilter | typeof LinearFilter;
+
+/**
+ * Texture Minification Filter Modes.
+ * For use with a texture's {@link THREE.Texture.minFilter | minFilter} property,
+ * these define the texture minifying function that is used whenever the pixel being textured maps to an area greater than one texture element (texel).
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ * @see {@link https://sbcode.net/threejs/mipmaps/ | Texture Mipmaps (non-official)}
+ */
+export type MinificationTextureFilter =
     | typeof NearestFilter
     | typeof NearestMipmapNearestFilter
     | typeof NearestMipMapNearestFilter
@@ -190,7 +300,17 @@ export type TextureFilter =
     | typeof LinearMipmapLinearFilter
     | typeof LinearMipMapLinearFilter;
 
+/**
+ * Texture all Magnification and Minification Filter Modes.
+ * @see {@link MagnificationTextureFilter} and {@link MinificationTextureFilter}
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ * @see {@link https://sbcode.net/threejs/mipmaps/ | Texture Mipmaps (non-official)}
+ */
+export type TextureFilter = MagnificationTextureFilter | MinificationTextureFilter;
+
+///////////////////////////////////////////////////////////////////////////////
 // Data types
+
 export const UnsignedByteType: 1009;
 export const ByteType: 1010;
 export const ShortType: 1011;
@@ -202,6 +322,13 @@ export const HalfFloatType: 1016;
 export const UnsignedShort4444Type: 1017;
 export const UnsignedShort5551Type: 1018;
 export const UnsignedInt248Type: 1020;
+
+/**
+ * Texture Types.
+ * @remarks Must correspond to the correct {@link PixelFormat | format}.
+ * @see {@link THREE.Texture.type}
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
 export type TextureDataType =
     | typeof UnsignedByteType
     | typeof ByteType
@@ -215,19 +342,101 @@ export type TextureDataType =
     | typeof UnsignedShort5551Type
     | typeof UnsignedInt248Type;
 
+///////////////////////////////////////////////////////////////////////////////
 // Pixel formats
+
+/** {@link AlphaFormat} discards the red, green and blue components and reads just the alpha component. */
 export const AlphaFormat: 1021;
+
+/** {@link RGBAFormat} discards the green and blue components and reads just the red component. (Can only be used with a WebGL 2 rendering context). */
 export const RGBAFormat: 1023;
+
+/**
+ * {@link LuminanceFormat} reads each element as a single luminance component.
+ * This is then converted to a floating point, clamped to the range `[0,1]`, and then assembled into an RGBA element by
+ * placing the luminance value in the red, green and blue channels, and attaching `1.0` to the alpha channel.
+ */
 export const LuminanceFormat: 1024;
+
+/**
+ * {@link LuminanceAlphaFormat} reads each element as a luminance/alpha double.
+ * The same process occurs as for the {@link LuminanceFormat}, except that the alpha channel may have values other than `1.0`.
+ */
 export const LuminanceAlphaFormat: 1025;
+
+/**
+ * {@link DepthFormat} reads each element as a single depth value, converts it to floating point, and clamps to the range `[0,1]`.
+ * @remarks This is the default for {@link THREE.DepthTexture}.
+ */
 export const DepthFormat: 1026;
+
+/**
+ * {@link DepthStencilFormat} reads each element is a pair of depth and stencil values.
+ * The depth component of the pair is interpreted as in {@link DepthFormat}.
+ * The stencil component is interpreted based on the depth + stencil internal format.
+ */
 export const DepthStencilFormat: 1027;
+
+/**
+ * {@link RedFormat} discards the green and blue components and reads just the red component.
+ * @remarks Can only be used with a WebGL 2 rendering context.
+ */
 export const RedFormat: 1028;
+
+/**
+ * {@link RedIntegerFormat} discards the green and blue components and reads just the red component.
+ * The texels are read as integers instead of floating point.
+ * @remarks Can only be used with a WebGL 2 rendering context.
+ */
 export const RedIntegerFormat: 1029;
+
+/**
+ * {@link RGFormat} discards the alpha, and blue components and reads the red, and green components.
+ * @remarks Can only be used with a WebGL 2 rendering context.
+ */
 export const RGFormat: 1030;
+
+/**
+ * {@link RGIntegerFormat} discards the alpha, and blue components and reads the red, and green components.
+ * The texels are read as integers instead of floating point.
+ * @remarks Can only be used with a WebGL 2 rendering context.
+ */
 export const RGIntegerFormat: 1031;
+
+/**
+ * {@link RGBAIntegerFormat} reads the red, green, blue and alpha component
+ * @remarks This is the default for {@link THREE.Texture}.
+ */
 export const RGBAIntegerFormat: 1033;
-export type PixelFormat =
+
+export const _SRGBAFormat = 1035; // fallback for WebGL 1
+
+/**
+ * Texture Pixel Formats Modes. Compatible only with {@link WebGLRenderingContext | WebGL 1 Rendering Context}.
+ * @remarks Note that the texture must have the correct {@link THREE.Texture.type} set, as described in  {@link TextureDataType}.
+ * @see {@link WebGLRenderingContext.texImage2D} for details.
+ * @see {@link WebGL2PixelFormat} and {@link PixelFormat}
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
+export type WebGL1PixelFormat =
+    | typeof AlphaFormat
+    | typeof LuminanceFormat
+    | typeof LuminanceAlphaFormat
+    | typeof DepthFormat
+    | typeof DepthStencilFormat
+    | typeof RedFormat
+    | typeof RedIntegerFormat
+    | typeof RGFormat
+    | typeof _SRGBAFormat;
+
+/**
+ * Texture Pixel Formats Modes. Compatible only with {@link WebGL2RenderingContext | WebGL 2 Rendering Context}.
+ * @remarks Note that the texture must have the correct {@link THREE.Texture.type} set, as described in  {@link TextureDataType}.
+ * @see {@link WebGLRenderingContext.texImage2D} for details.
+ * @see {@link WebGL2PixelFormat} and {@link PixelFormat}
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
+export type WebGL2PixelFormat =
     | typeof AlphaFormat
     | typeof RGBAFormat
     | typeof LuminanceFormat
@@ -241,41 +450,149 @@ export type PixelFormat =
     | typeof RGBAIntegerFormat
     | typeof _SRGBAFormat;
 
+/**
+ * All Texture Pixel Formats Modes.
+ * @remarks Note that the texture must have the correct {@link THREE.Texture.type} set, as described in  {@link TextureDataType}.
+ * @see {@link WebGLRenderingContext.texImage2D} for details.
+ * @see {@link WebGL1PixelFormat} and {@link WebGL2PixelFormat}
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
+export type PixelFormat = WebGL1PixelFormat | WebGL2PixelFormat;
+
+/**
+ * All Texture Pixel Formats Modes for {@link THREE.DeepTexture}.
+ * @see {@link WebGLRenderingContext.texImage2D} for details.
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
+export type DeepTexturePixelFormat = typeof DepthFormat | typeof DepthStencilFormat;
+
+///////////////////////////////////////////////////////////////////////////////
 // Compressed texture formats
 // DDS / ST3C Compressed texture formats
+
+/**
+ * A DXT1-compressed image in an RGB image format.
+ * @remarks Require support for the _WEBGL_compressed_texture_s3tc_ WebGL extension.
+ */
 export const RGB_S3TC_DXT1_Format: 33776;
+/**
+ * A DXT1-compressed image in an RGB image format with a simple on/off alpha value.
+ * @remarks Require support for the _WEBGL_compressed_texture_s3tc_ WebGL extension.
+ */
 export const RGBA_S3TC_DXT1_Format: 33777;
+/**
+ * A DXT3-compressed image in an RGBA image format. Compared to a 32-bit RGBA texture, it offers 4:1 compression.
+ * @remarks Require support for the _WEBGL_compressed_texture_s3tc_ WebGL extension.
+ */
 export const RGBA_S3TC_DXT3_Format: 33778;
+/**
+ * A DXT5-compressed image in an RGBA image format. It also provides a 4:1 compression, but differs to the DXT3 compression in how the alpha compression is done.
+ * @remarks Require support for the _WEBGL_compressed_texture_s3tc_ WebGL extension.
+ */
 export const RGBA_S3TC_DXT5_Format: 33779;
 
 // PVRTC compressed './texture formats
+
+/**
+ * RGB compression in 4-bit mode. One block for each 4×4 pixels.
+ * @remarks Require support for the _WEBGL_compressed_texture_pvrtc_ WebGL extension.
+ */
 export const RGB_PVRTC_4BPPV1_Format: 35840;
+/**
+ * RGB compression in 2-bit mode. One block for each 8×4 pixels.
+ * @remarks Require support for the _WEBGL_compressed_texture_pvrtc_ WebGL extension.
+ */
 export const RGB_PVRTC_2BPPV1_Format: 35841;
+/**
+ * RGBA compression in 4-bit mode. One block for each 4×4 pixels.
+ * @remarks Require support for the _WEBGL_compressed_texture_pvrtc_ WebGL extension.
+ */
 export const RGBA_PVRTC_4BPPV1_Format: 35842;
+/**
+ * RGBA compression in 2-bit mode. One block for each 8×4 pixels.
+ * @remarks Require support for the _WEBGL_compressed_texture_pvrtc_ WebGL extension.
+ */
 export const RGBA_PVRTC_2BPPV1_Format: 35843;
 
 // ETC compressed texture formats
+
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_etc1_ (ETC1) or _WEBGL_compressed_texture_etc_ (ETC2) WebGL extension.
+ */
 export const RGB_ETC1_Format: 36196;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_etc1_ (ETC1) or _WEBGL_compressed_texture_etc_ (ETC2) WebGL extension.
+ */
 export const RGB_ETC2_Format: 37492;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_etc1_ (ETC1) or _WEBGL_compressed_texture_etc_ (ETC2) WebGL extension.
+ */
 export const RGBA_ETC2_EAC_Format: 37496;
 
 // ASTC compressed texture formats
+
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_4x4_Format: 37808;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_5x4_Format: 37809;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_5x5_Format: 37810;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_6x5_Format: 37811;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_6x6_Format: 37812;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_8x5_Format: 37813;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_8x6_Format: 37814;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_8x8_Format: 37815;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_10x5_Format: 37816;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_10x6_Format: 37817;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_10x8_Format: 37818;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_10x10_Format: 37819;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_12x10_Format: 37820;
+/**
+ * @remarks Require support for the _WEBGL_compressed_texture_astc_ WebGL extension.
+ */
 export const RGBA_ASTC_12x12_Format: 37821;
 
 // BPTC compressed texture formats
+
+/**
+ * @remarks Require support for the _EXT_texture_compression_bptc_ WebGL extension.
+ */
 export const RGBA_BPTC_Format: 36492;
 
 // RGTC compressed texture formats
@@ -284,6 +601,10 @@ export const SIGNED_RED_RGTC1_Format: 36284;
 export const RED_GREEN_RGTC2_Format: 36285;
 export const SIGNED_RED_GREEN_RGTC2_Format: 36286;
 
+/**
+ * For use with a {@link THREE.CompressedTexture}'s {@link THREE.CompressedTexture.format | .format} property.
+ * @remarks Compressed Require support for correct WebGL extension.
+ */
 export type CompressedPixelFormat =
     | typeof RGB_S3TC_DXT1_Format
     | typeof RGBA_S3TC_DXT1_Format
@@ -316,6 +637,18 @@ export type CompressedPixelFormat =
     | typeof RED_GREEN_RGTC2_Format
     | typeof SIGNED_RED_GREEN_RGTC2_Format;
 
+///////////////////////////////////////////////////////////////////////////////
+
+/**
+ * All Possible Texture Pixel Formats Modes. For any Type or SubType of Textures.
+ * @remarks Note that the texture must have the correct {@link THREE.Texture.type} set, as described in {@link TextureDataType}.
+ * @see {@link WebGLRenderingContext.texImage2D} for details.
+ * @see {@link PixelFormat} and {@link DeepTexturePixelFormat} and {@link CompressedPixelFormat}
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
+export type AnyPixelFormat = PixelFormat | DeepTexturePixelFormat | CompressedPixelFormat;
+
+///////////////////////////////////////////////////////////////////////////////
 // Loop styles for AnimationAction
 export const LoopOnce: 2200;
 export const LoopRepeat: 2201;
@@ -345,17 +678,27 @@ export const TriangleStripDrawMode: 1;
 export const TriangleFanDrawMode: 2;
 export type TrianglesDrawModes = typeof TrianglesDrawMode | typeof TriangleStripDrawMode | typeof TriangleFanDrawMode;
 
+///////////////////////////////////////////////////////////////////////////////
 // Texture Encodings
+
 export const LinearEncoding: 3000;
 export const sRGBEncoding: 3001;
+/**
+ * Texture Encodings.
+ * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
+ */
 export type TextureEncoding = typeof LinearEncoding | typeof sRGBEncoding;
 
+///////////////////////////////////////////////////////////////////////////////
 // Depth packing strategies
+
 export const BasicDepthPacking: 3200;
 export const RGBADepthPacking: 3201;
 export type DepthPackingStrategies = typeof BasicDepthPacking | typeof RGBADepthPacking;
 
+///////////////////////////////////////////////////////////////////////////////
 // Normal Map types
+
 export const TangentSpaceNormalMap: 0;
 export const ObjectSpaceNormalMap: 1;
 export type NormalMapTypes = typeof TangentSpaceNormalMap | typeof ObjectSpaceNormalMap;
@@ -433,9 +776,69 @@ export const GLSL1: '100';
 export const GLSL3: '300 es';
 export type GLSLVersion = typeof GLSL1 | typeof GLSL3;
 
-export const _SRGBAFormat = 1035; // fallback for WebGL 1
+///////////////////////////////////////////////////////////////////////////////
+// Texture - Internal Pixel Formats
 
-// Internal Pixel Formats
+/**
+ * For use with a texture's {@link THREE.Texture.internalFormat} property, these define how elements of a {@link THREE.Texture}, or texels, are stored on the GPU.
+ * - `R8` stores the red component on 8 bits.
+ * - `R8_SNORM` stores the red component on 8 bits. The component is stored as normalized.
+ * - `R8I` stores the red component on 8 bits. The component is stored as an integer.
+ * - `R8UI` stores the red component on 8 bits. The component is stored as an unsigned integer.
+ * - `R16I` stores the red component on 16 bits. The component is stored as an integer.
+ * - `R16UI` stores the red component on 16 bits. The component is stored as an unsigned integer.
+ * - `R16F` stores the red component on 16 bits. The component is stored as floating point.
+ * - `R32I` stores the red component on 32 bits. The component is stored as an integer.
+ * - `R32UI` stores the red component on 32 bits. The component is stored as an unsigned integer.
+ * - `R32F` stores the red component on 32 bits. The component is stored as floating point.
+ * - `RG8` stores the red and green components on 8 bits each.
+ * - `RG8_SNORM` stores the red and green components on 8 bits each. Every component is stored as normalized.
+ * - `RG8I` stores the red and green components on 8 bits each. Every component is stored as an integer.
+ * - `RG8UI` stores the red and green components on 8 bits each. Every component is stored as an unsigned integer.
+ * - `RG16I` stores the red and green components on 16 bits each. Every component is stored as an integer.
+ * - `RG16UI` stores the red and green components on 16 bits each. Every component is stored as an unsigned integer.
+ * - `RG16F` stores the red and green components on 16 bits each. Every component is stored as floating point.
+ * - `RG32I` stores the red and green components on 32 bits each. Every component is stored as an integer.
+ * - `RG32UI` stores the red and green components on 32 bits. Every component is stored as an unsigned integer.
+ * - `RG32F` stores the red and green components on 32 bits. Every component is stored as floating point.
+ * - `RGB8` stores the red, green, and blue components on 8 bits each. RGB8_SNORM` stores the red, green, and blue components on 8 bits each. Every component is stored as normalized.
+ * - `RGB8I` stores the red, green, and blue components on 8 bits each. Every component is stored as an integer.
+ * - `RGB8UI` stores the red, green, and blue components on 8 bits each. Every component is stored as an unsigned integer.
+ * - `RGB16I` stores the red, green, and blue components on 16 bits each. Every component is stored as an integer.
+ * - `RGB16UI` stores the red, green, and blue components on 16 bits each. Every component is stored as an unsigned integer.
+ * - `RGB16F` stores the red, green, and blue components on 16 bits each. Every component is stored as floating point
+ * - `RGB32I` stores the red, green, and blue components on 32 bits each. Every component is stored as an integer.
+ * - `RGB32UI` stores the red, green, and blue components on 32 bits each. Every component is stored as an unsigned integer.
+ * - `RGB32F` stores the red, green, and blue components on 32 bits each. Every component is stored as floating point
+ * - `R11F_G11F_B10F` stores the red, green, and blue components respectively on 11 bits, 11 bits, and 10bits. Every component is stored as floating point.
+ * - `RGB565` stores the red, green, and blue components respectively on 5 bits, 6 bits, and 5 bits.
+ * - `RGB9_E5` stores the red, green, and blue components on 9 bits each.
+ * - `RGBA8` stores the red, green, blue, and alpha components on 8 bits each.
+ * - `RGBA8_SNORM` stores the red, green, blue, and alpha components on 8 bits. Every component is stored as normalized.
+ * - `RGBA8I` stores the red, green, blue, and alpha components on 8 bits each. Every component is stored as an integer.
+ * - `RGBA8UI` stores the red, green, blue, and alpha components on 8 bits. Every component is stored as an unsigned integer.
+ * - `RGBA16I` stores the red, green, blue, and alpha components on 16 bits. Every component is stored as an integer.
+ * - `RGBA16UI` stores the red, green, blue, and alpha components on 16 bits. Every component is stored as an unsigned integer.
+ * - `RGBA16F` stores the red, green, blue, and alpha components on 16 bits. Every component is stored as floating point.
+ * - `RGBA32I` stores the red, green, blue, and alpha components on 32 bits. Every component is stored as an integer.
+ * - `RGBA32UI` stores the red, green, blue, and alpha components on 32 bits. Every component is stored as an unsigned integer.
+ * - `RGBA32F` stores the red, green, blue, and alpha components on 32 bits. Every component is stored as floating point.
+ * - `RGB5_A1` stores the red, green, blue, and alpha components respectively on 5 bits, 5 bits, 5 bits, and 1 bit.
+ * - `RGB10_A2` stores the red, green, blue, and alpha components respectively on 10 bits, 10 bits, 10 bits and 2 bits.
+ * - `RGB10_A2UI` stores the red, green, blue, and alpha components respectively on 10 bits, 10 bits, 10 bits and 2 bits. Every component is stored as an unsigned integer.
+ * - `SRGB8` stores the red, green, and blue components on 8 bits each.
+ * - `SRGB8_ALPHA8` stores the red, green, blue, and alpha components on 8 bits each.
+ * - `DEPTH_COMPONENT16` stores the depth component on 16bits.
+ * - `DEPTH_COMPONENT24` stores the depth component on 24bits.
+ * - `DEPTH_COMPONENT32F` stores the depth component on 32bits. The component is stored as floating point.
+ * - `DEPTH24_STENCIL8` stores the depth, and stencil components respectively on 24 bits and 8 bits. The stencil component is stored as an unsigned integer.
+ * - `DEPTH32F_STENCIL8` stores the depth, and stencil components respectively on 32 bits and 8 bits. The depth component is stored as floating point, and the stencil component as an unsigned integer.
+ * @remark Note that the texture must have the correct {@link THREE.Texture.type} set, as well as the correct {@link THREE.Texture.format}.
+ * @see {@link WebGLRenderingContext.texImage2D} and {@link WebGLRenderingContext.texImage3D} for more details regarding the possible combination
+ * of {@link THREE.Texture.format}, {@link THREE.Texture.internalFormat}, and {@link THREE.Texture.type}.
+ * @see {@link https://registry.khronos.org/webgl/specs/latest/2.0/ | WebGL2 Specification} and
+ * {@link https://registry.khronos.org/OpenGL/specs/es/3.0/es_spec_3.0.pdf | OpenGL ES 3.0 Specification} For more in-depth information regarding internal formats.
+ */
 export type PixelFormatGPU =
     | 'ALPHA'
     | 'RGB'
@@ -499,6 +902,8 @@ export type PixelFormatGPU =
     | 'DEPTH24_STENCIL8'
     | 'DEPTH32F_STENCIL8';
 
+///////////////////////////////////////////////////////////////////////////////
+
 export type BuiltinShaderAttributeName =
     | 'position'
     | 'normal'

three/src/core/BufferGeometry.d.ts

@@ -68,9 +68,11 @@ export class BufferGeometry extends EventDispatcher {
     name: string;
 
     /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
      * @defaultValue `BufferGeometry`
      */
-    type: string; // TODO Replace for "BufferGeometry" // TODO add readonly
+    readonly type: string | 'BufferGeometry';
 
     /**
      * Allows for vertices to be re-used across multiple triangles; this is called using "indexed triangles".
@@ -131,7 +133,7 @@ export class BufferGeometry extends EventDispatcher {
     }>;
 
     /**
-     * Bounding box for the bufferGeometry, which can be calculated with {@link computeBoundingBox | .computeBoundingBox()}.
+     * Bounding box for the {@link THREE.BufferGeometry | BufferGeometry}, which can be calculated with {@link computeBoundingBox | .computeBoundingBox()}.
      * @remarks Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are `null`.
      * @defaultValue `null`
      */
@@ -350,7 +352,7 @@ export class BufferGeometry extends EventDispatcher {
     /**
      * Creates a clone of this BufferGeometry
      */
-    clone(): BufferGeometry;
+    clone(): this;
 
     /**
      * Copies another BufferGeometry to this BufferGeometry.