super-three 0.173.5 → 0.176.0

package/src/renderers/webgl-fallback/utils/WebGLState.js

@@ -73,6 +73,9 @@ class WebGLState {
 		this.currentLineWidth = null;
 		this.currentClippingPlanes = 0;
 
+		this.currentVAO = null;
+		this.currentIndex = null;
+
 		this.currentBoundFramebuffers = {};
 		this.currentDrawbuffers = new WeakMap();
 
@@ -176,7 +179,7 @@ class WebGLState {
 	 * This method caches the state so `gl.frontFace()` is only
 	 * called when necessary.
 	 *
-	 * @param {Boolean} flipSided - Whether triangles flipped their sides or not.
+	 * @param {boolean} flipSided - Whether triangles flipped their sides or not.
 	 */
 	setFlipSided( flipSided ) {
 
@@ -207,7 +210,7 @@ class WebGLState {
 	 * This method caches the state so `gl.cullFace()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} cullFace - Defines which polygons are candidates for culling.
+	 * @param {number} cullFace - Defines which polygons are candidates for culling.
 	 */
 	setCullFace( cullFace ) {
 
@@ -251,7 +254,7 @@ class WebGLState {
 	 * This method caches the state so `gl.lineWidth()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} width - The line width.
+	 * @param {number} width - The line width.
 	 */
 	setLineWidth( width ) {
 
@@ -273,14 +276,14 @@ class WebGLState {
 	 * This method caches the state so `gl.blendEquation()`, `gl.blendEquationSeparate()`,
 	 * `gl.blendFunc()` and  `gl.blendFuncSeparate()` are only called when necessary.
 	 *
-	 * @param {Number} blending - The blending type.
-	 * @param {Number} blendEquation - The blending equation.
-	 * @param {Number} blendSrc - Only relevant for custom blending. The RGB source blending factor.
-	 * @param {Number} blendDst - Only relevant for custom blending. The RGB destination blending factor.
-	 * @param {Number} blendEquationAlpha - Only relevant for custom blending. The blending equation for alpha.
-	 * @param {Number} blendSrcAlpha - Only relevant for custom blending. The alpha source blending factor.
-	 * @param {Number} blendDstAlpha - Only relevant for custom blending. The alpha destination blending factor.
-	 * @param {Boolean} premultipliedAlpha - Whether premultiplied alpha is enabled or not.
+	 * @param {number} blending - The blending type.
+	 * @param {number} blendEquation - The blending equation.
+	 * @param {number} blendSrc - Only relevant for custom blending. The RGB source blending factor.
+	 * @param {number} blendDst - Only relevant for custom blending. The RGB destination blending factor.
+	 * @param {number} blendEquationAlpha - Only relevant for custom blending. The blending equation for alpha.
+	 * @param {number} blendSrcAlpha - Only relevant for custom blending. The alpha source blending factor.
+	 * @param {number} blendDstAlpha - Only relevant for custom blending. The alpha destination blending factor.
+	 * @param {boolean} premultipliedAlpha - Whether premultiplied alpha is enabled or not.
 	 */
 	setBlending( blending, blendEquation, blendSrc, blendDst, blendEquationAlpha, blendSrcAlpha, blendDstAlpha, premultipliedAlpha ) {
 
@@ -425,7 +428,7 @@ class WebGLState {
 	 * This method caches the state so `gl.colorMask()` is only
 	 * called when necessary.
 	 *
-	 * @param {Boolean} colorMask - The color mask.
+	 * @param {boolean} colorMask - The color mask.
 	 */
 	setColorMask( colorMask ) {
 
@@ -441,7 +444,7 @@ class WebGLState {
 	/**
 	 * Specifies whether the depth test is enabled or not.
 	 *
-	 * @param {Boolean} depthTest - Whether the depth test is enabled or not.
+	 * @param {boolean} depthTest - Whether the depth test is enabled or not.
 	 */
 	setDepthTest( depthTest ) {
 
@@ -466,7 +469,7 @@ class WebGLState {
 	 * This method caches the state so `gl.depthMask()` is only
 	 * called when necessary.
 	 *
-	 * @param {Boolean} depthMask - The depth mask.
+	 * @param {boolean} depthMask - The depth mask.
 	 */
 	setDepthMask( depthMask ) {
 
@@ -485,7 +488,7 @@ class WebGLState {
 	 * This method caches the state so `gl.depthFunc()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} depthFunc - The depth compare function.
+	 * @param {number} depthFunc - The depth compare function.
 	 */
 	setDepthFunc( depthFunc ) {
 
@@ -548,12 +551,12 @@ class WebGLState {
 	}
 
 	/**
-	 * Specifies the viewport.
+	 * Specifies the scissor box.
 	 *
-	 * @param {Number} x - The x-coordinate of the lower left corner of the viewport.
-	 * @param {Number} y - The y-coordinate of the lower left corner of the viewport.
-	 * @param {Number} width - The width of the viewport.
-	 * @param {Number} height - The height of the viewport.
+	 * @param {number} x - The x-coordinate of the lower left corner of the viewport.
+	 * @param {number} y - The y-coordinate of the lower left corner of the viewport.
+	 * @param {number} width - The width of the viewport.
+	 * @param {number} height - The height of the viewport.
 	 *
 	 */
 	scissor( x, y, width, height ) {
@@ -574,10 +577,10 @@ class WebGLState {
 	/**
 	 * Specifies the viewport.
 	 *
-	 * @param {Number} x - The x-coordinate of the lower left corner of the viewport.
-	 * @param {Number} y - The y-coordinate of the lower left corner of the viewport.
-	 * @param {Number} width - The width of the viewport.
-	 * @param {Number} height - The height of the viewport.
+	 * @param {number} x - The x-coordinate of the lower left corner of the viewport.
+	 * @param {number} y - The y-coordinate of the lower left corner of the viewport.
+	 * @param {number} width - The width of the viewport.
+	 * @param {number} height - The height of the viewport.
 	 *
 	 */
 	viewport( x, y, width, height ) {
@@ -598,7 +601,7 @@ class WebGLState {
 	/**
 	 * Defines the scissor test.
 	 *
-	 * @param {Boolean} boolean - Whether the scissor test should be enabled or not.
+	 * @param {boolean} boolean - Whether the scissor test should be enabled or not.
 	 */
 	setScissorTest( boolean ) {
 
@@ -619,7 +622,7 @@ class WebGLState {
 	/**
 	 * Specifies whether the stencil test is enabled or not.
 	 *
-	 * @param {Boolean} stencilTest - Whether the stencil test is enabled or not.
+	 * @param {boolean} stencilTest - Whether the stencil test is enabled or not.
 	 */
 	setStencilTest( stencilTest ) {
 
@@ -644,7 +647,7 @@ class WebGLState {
 	 * This method caches the state so `gl.stencilMask()` is only
 	 * called when necessary.
 	 *
-	 * @param {Boolean} stencilMask - The stencil mask.
+	 * @param {boolean} stencilMask - The stencil mask.
 	 */
 	setStencilMask( stencilMask ) {
 
@@ -663,9 +666,9 @@ class WebGLState {
 	 * This method caches the state so `gl.stencilFunc()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} stencilFunc - The stencil compare function.
-	 * @param {Number} stencilRef - The reference value for the stencil test.
-	 * @param {Number} stencilMask - A bit-wise mask that is used to AND the reference value and the stored stencil value when the test is done.
+	 * @param {number} stencilFunc - The stencil compare function.
+	 * @param {number} stencilRef - The reference value for the stencil test.
+	 * @param {number} stencilMask - A bit-wise mask that is used to AND the reference value and the stored stencil value when the test is done.
 	 */
 	setStencilFunc( stencilFunc, stencilRef, stencilMask ) {
 
@@ -689,9 +692,9 @@ class WebGLState {
 	 * This method caches the state so `gl.stencilOp()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} stencilFail - The function to use when the stencil test fails.
-	 * @param {Number} stencilZFail - The function to use when the stencil test passes, but the depth test fail.
-	 * @param {Number} stencilZPass - The function to use when both the stencil test and the depth test pass,
+	 * @param {number} stencilFail - The function to use when the stencil test fails.
+	 * @param {number} stencilZFail - The function to use when the stencil test passes, but the depth test fail.
+	 * @param {number} stencilZPass - The function to use when both the stencil test and the depth test pass,
 	 * or when the stencil test passes and there is no depth buffer or depth testing is disabled.
 	 */
 	setStencilOp( stencilFail, stencilZFail, stencilZPass ) {
@@ -714,8 +717,8 @@ class WebGLState {
 	 * Configures the WebGL state for the given material.
 	 *
 	 * @param {Material} material - The material to configure the state for.
-	 * @param {Number} frontFaceCW - Whether the front faces are counter-clockwise or not.
-	 * @param {Number} hardwareClippingPlanes - The number of hardware clipping planes.
+	 * @param {number} frontFaceCW - Whether the front faces are counter-clockwise or not.
+	 * @param {number} hardwareClippingPlanes - The number of hardware clipping planes.
 	 */
 	setMaterial( material, frontFaceCW, hardwareClippingPlanes ) {
 
@@ -787,9 +790,9 @@ class WebGLState {
 	 * This method caches the state so `gl.polygonOffset()` is only
 	 * called when necessary.
 	 *
-	 * @param {Boolean} polygonOffset - Whether polygon offset is enabled or not.
-	 * @param {Number} factor - The scale factor for the variable depth offset for each polygon.
-	 * @param {Number} units - The multiplier by which an implementation-specific value is multiplied with to create a constant depth offset.
+	 * @param {boolean} polygonOffset - Whether polygon offset is enabled or not.
+	 * @param {number} factor - The scale factor for the variable depth offset for each polygon.
+	 * @param {number} units - The multiplier by which an implementation-specific value is multiplied with to create a constant depth offset.
 	 */
 	setPolygonOffset( polygonOffset, factor, units ) {
 
@@ -823,7 +826,7 @@ class WebGLState {
 	 * called when necessary.
 	 *
 	 * @param {WebGLProgram} program - The WebGL program to use.
-	 * @return {Boolean} Whether a program change has been executed or not.
+	 * @return {boolean} Whether a program change has been executed or not.
 	 */
 	useProgram( program ) {
 
@@ -841,6 +844,53 @@ class WebGLState {
 
 	}
 
+	/**
+	 * Sets the vertex state by binding the given VAO and element buffer.
+	 *
+	 * @param {WebGLVertexArrayObject} vao - The VAO.
+	 * @param {WebGLBuffer} indexBuffer - The index buffer.
+	 * @return {boolean} Whether a vertex state has been changed or not.
+	 */
+	setVertexState( vao, indexBuffer = null ) {
+
+		const gl = this.gl;
+
+		if ( this.currentVAO !== vao || this.currentIndex !== indexBuffer ) {
+
+			gl.bindVertexArray( vao );
+
+			if ( indexBuffer !== null ) {
+
+				gl.bindBuffer( gl.ELEMENT_ARRAY_BUFFER, indexBuffer );
+
+			}
+
+			this.currentVAO = vao;
+			this.currentIndex = indexBuffer;
+
+			return true;
+
+		}
+
+		return false;
+
+	}
+
+	/**
+	 * Resets the vertex array state by resetting the VAO and element buffer.
+	 */
+	resetVertexState() {
+
+		const gl = this.gl;
+
+		gl.bindVertexArray( null );
+		gl.bindBuffer( gl.ELEMENT_ARRAY_BUFFER, null );
+
+		this.currentVAO = null;
+		this.currentIndex = null;
+
+	}
+
 	// framebuffer
 
 
@@ -850,9 +900,9 @@ class WebGLState {
 	 * This method caches the state so `gl.bindFramebuffer()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} target - The binding point (target).
+	 * @param {number} target - The binding point (target).
 	 * @param {WebGLFramebuffer} framebuffer - The WebGL framebuffer to bind.
-	 * @return {Boolean} Whether a bind has been executed or not.
+	 * @return {boolean} Whether a bind has been executed or not.
 	 */
 	bindFramebuffer( target, framebuffer ) {
 
@@ -962,7 +1012,7 @@ class WebGLState {
 	 * This method caches the state so `gl.activeTexture()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} webglSlot - The texture unit to make active.
+	 * @param {number} webglSlot - The texture unit to make active.
 	 */
 	activeTexture( webglSlot ) {
 
@@ -985,9 +1035,9 @@ class WebGLState {
 	 * This method caches the state so `gl.bindTexture()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} webglType - The binding point (target).
+	 * @param {number} webglType - The binding point (target).
 	 * @param {WebGLTexture} webglTexture - The WebGL texture to bind.
-	 * @param {Number} webglSlot - The texture.
+	 * @param {number} webglSlot - The texture.
 	 */
 	bindTexture( webglType, webglTexture, webglSlot ) {
 
@@ -1040,10 +1090,10 @@ class WebGLState {
 	 * This method caches the state so `gl.bindBufferBase()` is only
 	 * called when necessary.
 	 *
-	 * @param {Number} target - The target for the bind operation.
-	 * @param {Number} index - The index of the target.
+	 * @param {number} target - The target for the bind operation.
+	 * @param {number} index - The index of the target.
 	 * @param {WebGLBuffer} buffer - The WebGL buffer.
-	 * @return {Boolean} Whether a bind has been executed or not.
+	 * @return {boolean} Whether a bind has been executed or not.
 	 */
 	bindBufferBase( target, index, buffer ) {
 

package/src/renderers/webgl-fallback/utils/WebGLTextureUtils.js

@@ -134,11 +134,11 @@ class WebGLTextureUtils {
 	/**
 	 * Returns the native texture type for the given texture.
 	 *
-	 * @param {String?} internalFormatName - The internal format name. When `null`, the internal format is derived from the subsequent parameters.
+	 * @param {?string} internalFormatName - The internal format name. When `null`, the internal format is derived from the subsequent parameters.
 	 * @param {GLenum} glFormat - The WebGL format.
 	 * @param {GLenum} glType - The WebGL type.
-	 * @param {String} colorSpace - The texture's color space.
-	 * @param {Boolean} [forceLinearTransfer=false] - Whether to force a linear transfer or not.
+	 * @param {string} colorSpace - The texture's color space.
+	 * @param {boolean} [forceLinearTransfer=false] - Whether to force a linear transfer or not.
 	 * @return {GLenum} The internal format.
 	 */
 	getInternalFormat( internalFormatName, glFormat, glType, colorSpace, forceLinearTransfer = false ) {
@@ -697,33 +697,57 @@ class WebGLTextureUtils {
 	 *
 	 * @param {Texture} srcTexture - The source texture.
 	 * @param {Texture} dstTexture - The destination texture.
-	 * @param {Vector4?} [srcRegion=null] - The region of the source texture to copy.
-	 * @param {(Vector2|Vector3)?} [dstPosition=null] - The destination position of the copy.
-	 * @param {Number} [level=0] - The mip level to copy.
+	 * @param {?(Box3|Box2)} [srcRegion=null] - The region of the source texture to copy.
+	 * @param {?(Vector2|Vector3)} [dstPosition=null] - The destination position of the copy.
+	 * @param {number} [srcLevel=0] - The source mip level to copy from.
+	 * @param {number} [dstLevel=0] - The destination mip level to copy to.
 	 */
-	copyTextureToTexture( srcTexture, dstTexture, srcRegion = null, dstPosition = null, level = 0 ) {
+	copyTextureToTexture( srcTexture, dstTexture, srcRegion = null, dstPosition = null, srcLevel = 0, dstLevel = 0 ) {
 
 		const { gl, backend } = this;
 		const { state } = this.backend;
 
 		const { textureGPU: dstTextureGPU, glTextureType, glType, glFormat } = backend.get( dstTexture );
 
-		let width, height, minX, minY;
-		let dstX, dstY;
+		state.bindTexture( glTextureType, dstTextureGPU );
+
+		// gather the necessary dimensions to copy
+		let width, height, depth, minX, minY, minZ;
+		let dstX, dstY, dstZ;
+		const image = srcTexture.isCompressedTexture ? srcTexture.mipmaps[ dstLevel ] : srcTexture.image;
 
 		if ( srcRegion !== null ) {
 
 			width = srcRegion.max.x - srcRegion.min.x;
 			height = srcRegion.max.y - srcRegion.min.y;
+			depth = srcRegion.isBox3 ? srcRegion.max.z - srcRegion.min.z : 1;
 			minX = srcRegion.min.x;
 			minY = srcRegion.min.y;
+			minZ = srcRegion.isBox3 ? srcRegion.min.z : 0;
 
 		} else {
 
-			width = srcTexture.image.width;
-			height = srcTexture.image.height;
+			const levelScale = Math.pow( 2, - srcLevel );
+			width = Math.floor( image.width * levelScale );
+			height = Math.floor( image.height * levelScale );
+
+			if ( srcTexture.isDataArrayTexture ) {
+
+				depth = image.depth;
+
+			} else if ( srcTexture.isData3DTexture ) {
+
+				depth = Math.floor( image.depth * levelScale );
+
+			} else {
+
+				depth = 1;
+
+			}
+
 			minX = 0;
 			minY = 0;
+			minZ = 0;
 
 		}
 
@@ -731,36 +755,36 @@ class WebGLTextureUtils {
 
 			dstX = dstPosition.x;
 			dstY = dstPosition.y;
+			dstZ = dstPosition.z;
 
 		} else {
 
 			dstX = 0;
 			dstY = 0;
+			dstZ = 0;
 
 		}
 
-		state.bindTexture( glTextureType, dstTextureGPU );
 
-		// As another texture upload may have changed pixelStorei
-		// parameters, make sure they are correct for the dstTexture
-		gl.pixelStorei( gl.UNPACK_ALIGNMENT, dstTexture.unpackAlignment );
 		gl.pixelStorei( gl.UNPACK_FLIP_Y_WEBGL, dstTexture.flipY );
 		gl.pixelStorei( gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, dstTexture.premultiplyAlpha );
 		gl.pixelStorei( gl.UNPACK_ALIGNMENT, dstTexture.unpackAlignment );
 
+		// used for copying data from cpu
 		const currentUnpackRowLen = gl.getParameter( gl.UNPACK_ROW_LENGTH );
 		const currentUnpackImageHeight = gl.getParameter( gl.UNPACK_IMAGE_HEIGHT );
 		const currentUnpackSkipPixels = gl.getParameter( gl.UNPACK_SKIP_PIXELS );
 		const currentUnpackSkipRows = gl.getParameter( gl.UNPACK_SKIP_ROWS );
 		const currentUnpackSkipImages = gl.getParameter( gl.UNPACK_SKIP_IMAGES );
 
-		const image = srcTexture.isCompressedTexture ? srcTexture.mipmaps[ level ] : srcTexture.image;
-
 		gl.pixelStorei( gl.UNPACK_ROW_LENGTH, image.width );
 		gl.pixelStorei( gl.UNPACK_IMAGE_HEIGHT, image.height );
 		gl.pixelStorei( gl.UNPACK_SKIP_PIXELS, minX );
 		gl.pixelStorei( gl.UNPACK_SKIP_ROWS, minY );
+		gl.pixelStorei( gl.UNPACK_SKIP_IMAGES, minZ );
 
+		// set up the src texture
+		const isDst3D = dstTexture.isDataArrayTexture || dstTexture.isData3DTexture;
 		if ( srcTexture.isRenderTargetTexture || srcTexture.isDepthTexture ) {
 
 			const srcTextureData = backend.get( srcTexture );
@@ -786,19 +810,37 @@ class WebGLTextureUtils {
 
 		} else {
 
-			if ( srcTexture.isDataTexture ) {
+			if ( isDst3D ) {
 
-				gl.texSubImage2D( gl.TEXTURE_2D, level, dstX, dstY, width, height, glFormat, glType, image.data );
+				// copy data into the 3d texture
+				if ( srcTexture.isDataTexture || srcTexture.isData3DTexture ) {
+
+					gl.texSubImage3D( glTextureType, dstLevel, dstX, dstY, dstZ, width, height, depth, glFormat, glType, image.data );
+
+				} else if ( dstTexture.isCompressedArrayTexture ) {
+
+					gl.compressedTexSubImage3D( glTextureType, dstLevel, dstX, dstY, dstZ, width, height, depth, glFormat, image.data );
+
+				} else {
+
+					gl.texSubImage3D( glTextureType, dstLevel, dstX, dstY, dstZ, width, height, depth, glFormat, glType, image );
+
+				}
 
 			} else {
 
-				if ( srcTexture.isCompressedTexture ) {
+				// copy data into the 2d texture
+				if ( srcTexture.isDataTexture ) {
+
+					gl.texSubImage2D( glTextureType, dstLevel, dstX, dstY, width, height, glFormat, glType, image.data );
 
-					gl.compressedTexSubImage2D( gl.TEXTURE_2D, level, dstX, dstY, image.width, image.height, glFormat, image.data );
+				} else if ( srcTexture.isCompressedTexture ) {
+
+					gl.compressedTexSubImage2D( glTextureType, dstLevel, dstX, dstY, image.width, image.height, glFormat, image.data );
 
 				} else {
 
-					gl.texSubImage2D( gl.TEXTURE_2D, level, dstX, dstY, width, height, glFormat, glType, image );
+					gl.texSubImage2D( glTextureType, dstLevel, dstX, dstY, width, height, glFormat, glType, image );
 
 				}
 
@@ -806,6 +848,7 @@ class WebGLTextureUtils {
 
 		}
 
+		// reset values
 		gl.pixelStorei( gl.UNPACK_ROW_LENGTH, currentUnpackRowLen );
 		gl.pixelStorei( gl.UNPACK_IMAGE_HEIGHT, currentUnpackImageHeight );
 		gl.pixelStorei( gl.UNPACK_SKIP_PIXELS, currentUnpackSkipPixels );
@@ -813,12 +856,17 @@ class WebGLTextureUtils {
 		gl.pixelStorei( gl.UNPACK_SKIP_IMAGES, currentUnpackSkipImages );
 
 		// Generate mipmaps only when copying level 0
-		if ( level === 0 && dstTexture.generateMipmaps ) gl.generateMipmap( gl.TEXTURE_2D );
+		if ( dstLevel === 0 && dstTexture.generateMipmaps ) {
+
+			gl.generateMipmap( glTextureType );
+
+		}
 
 		state.unbindTexture();
 
 	}
 
+
 	/**
 	 * Copies the current bound framebuffer to the given texture.
 	 *
@@ -918,8 +966,8 @@ class WebGLTextureUtils {
 	 *
 	 * @param {WebGLRenderbuffer} renderbuffer - The render buffer.
 	 * @param {RenderContext} renderContext - The render context.
-	 * @param {Number} samples - The MSAA sample count.
-	 * @param {Boolean} [useMultisampledRTT=false] - Whether to use WEBGL_multisampled_render_to_texture or not.
+	 * @param {number} samples - The MSAA sample count.
+	 * @param {boolean} [useMultisampledRTT=false] - Whether to use WEBGL_multisampled_render_to_texture or not.
 	 */
 	setupRenderBufferStorage( renderbuffer, renderContext, samples, useMultisampledRTT = false ) {
 
@@ -986,11 +1034,11 @@ class WebGLTextureUtils {
 	 *
 	 * @async
 	 * @param {Texture} texture - The texture to copy.
-	 * @param {Number} x - The x coordinate of the copy origin.
-	 * @param {Number} y - The y coordinate of the copy origin.
-	 * @param {Number} width - The width of the copy.
-	 * @param {Number} height - The height of the copy.
-	 * @param {Number} faceIndex - The face index.
+	 * @param {number} x - The x coordinate of the copy origin.
+	 * @param {number} y - The y coordinate of the copy origin.
+	 * @param {number} width - The width of the copy.
+	 * @param {number} height - The height of the copy.
+	 * @param {number} faceIndex - The face index.
 	 * @return {Promise<TypedArray>} A Promise that resolves with a typed array when the copy operation has finished.
 	 */
 	async copyTextureToBuffer( texture, x, y, width, height, faceIndex ) {
@@ -1066,7 +1114,7 @@ class WebGLTextureUtils {
 	 * @private
 	 * @param {GLenum} glType - The WebGL data type.
 	 * @param {GLenum} glFormat - The WebGL texture format.
-	 * @return {Number} The bytes-per-texel.
+	 * @return {number} The bytes-per-texel.
 	 */
 	_getBytesPerTexel( glType, glFormat ) {
 

package/src/renderers/webgl-fallback/utils/WebGLTimestampQueryPool.js

@@ -4,16 +4,18 @@ import TimestampQueryPool from '../../common/TimestampQueryPool.js';
 /**
  * Manages a pool of WebGL timestamp queries for performance measurement.
  * Handles creation, execution, and resolution of timer queries using WebGL extensions.
- * @extends TimestampQueryPool
+ *
+ * @augments TimestampQueryPool
  */
 class WebGLTimestampQueryPool extends TimestampQueryPool {
 
 	/**
-     * Creates a new WebGL timestamp query pool.
-     * @param {WebGLRenderingContext|WebGL2RenderingContext} gl - The WebGL context.
-     * @param {string} type - The type identifier for this query pool.
-     * @param {number} [maxQueries=2048] - Maximum number of queries this pool can hold.
-     */
+	 * Creates a new WebGL timestamp query pool.
+	 *
+	 * @param {WebGLRenderingContext|WebGL2RenderingContext} gl - The WebGL context.
+	 * @param {string} type - The type identifier for this query pool.
+	 * @param {number} [maxQueries=2048] - Maximum number of queries this pool can hold.
+	 */
 	constructor( gl, type, maxQueries = 2048 ) {
 
 		super( maxQueries );
@@ -23,7 +25,7 @@ class WebGLTimestampQueryPool extends TimestampQueryPool {
 
 		// Check for timer query extensions
 		this.ext = gl.getExtension( 'EXT_disjoint_timer_query_webgl2' ) ||
-                  gl.getExtension( 'EXT_disjoint_timer_query' );
+				  gl.getExtension( 'EXT_disjoint_timer_query' );
 
 		if ( ! this.ext ) {
 
@@ -47,10 +49,11 @@ class WebGLTimestampQueryPool extends TimestampQueryPool {
 	}
 
 	/**
-     * Allocates a pair of queries for a given render context.
-     * @param {Object} renderContext - The render context to allocate queries for.
-     * @returns {?number} The base offset for the allocated queries, or null if allocation failed.
-     */
+	 * Allocates a pair of queries for a given render context.
+	 *
+	 * @param {Object} renderContext - The render context to allocate queries for.
+	 * @returns {?number} The base offset for the allocated queries, or null if allocation failed.
+	 */
 	allocateQueriesForContext( renderContext ) {
 
 		if ( ! this.trackTimestamp ) return null;
@@ -75,9 +78,10 @@ class WebGLTimestampQueryPool extends TimestampQueryPool {
 	}
 
 	/**
-     * Begins a timestamp query for the specified render context.
-     * @param {Object} renderContext - The render context to begin timing for.
-     */
+	 * Begins a timestamp query for the specified render context.
+	 *
+	 * @param {Object} renderContext - The render context to begin timing for.
+	 */
 	beginQuery( renderContext ) {
 
 		if ( ! this.trackTimestamp || this.isDisposed ) {
@@ -129,10 +133,11 @@ class WebGLTimestampQueryPool extends TimestampQueryPool {
 	}
 
 	/**
-     * Ends the active timestamp query for the specified render context.
-     * @param {Object} renderContext - The render context to end timing for.
-     * @param {string} renderContext.id - Unique identifier for the render context.
-     */
+	 * Ends the active timestamp query for the specified render context.
+	 *
+	 * @param {Object} renderContext - The render context to end timing for.
+	 * @param {string} renderContext.id - Unique identifier for the render context.
+	 */
 	endQuery( renderContext ) {
 
 		if ( ! this.trackTimestamp || this.isDisposed ) {
@@ -173,9 +178,11 @@ class WebGLTimestampQueryPool extends TimestampQueryPool {
 	}
 
 	/**
-     * Asynchronously resolves all completed queries and returns the total duration.
-     * @returns {Promise<number>} The total duration in milliseconds, or the last valid value if resolution fails.
-     */
+	 * Asynchronously resolves all completed queries and returns the total duration.
+	 *
+	 * @async
+	 * @returns {Promise<number>} The total duration in milliseconds, or the last valid value if resolution fails.
+	 */
 	async resolveQueriesAsync() {
 
 		if ( ! this.trackTimestamp || this.pendingResolve ) {
@@ -236,11 +243,12 @@ class WebGLTimestampQueryPool extends TimestampQueryPool {
 	}
 
 	/**
-     * Resolves a single query, checking for completion and disjoint operation.
-     * @private
-     * @param {WebGLQuery} query - The query object to resolve.
-     * @returns {Promise<number>} The elapsed time in milliseconds.
-     */
+	 * Resolves a single query, checking for completion and disjoint operation.
+	 *
+	 * @async
+	 * @param {WebGLQuery} query - The query object to resolve.
+	 * @returns {Promise<number>} The elapsed time in milliseconds.
+	 */
 	async resolveQuery( query ) {
 
 		return new Promise( ( resolve ) => {
@@ -325,9 +333,9 @@ class WebGLTimestampQueryPool extends TimestampQueryPool {
 	}
 
 	/**
-     * Releases all resources held by this query pool.
-     * This includes deleting all query objects and clearing internal state.
-     */
+	 * Releases all resources held by this query pool.
+	 * This includes deleting all query objects and clearing internal state.
+	 */
 	dispose() {
 
 		if ( this.isDisposed ) {

package/src/renderers/webgl-fallback/utils/WebGLUtils.js

@@ -43,9 +43,9 @@ class WebGLUtils {
 	 * The method currently supports the conversion of texture formats
 	 * and types.
 	 *
-	 * @param {Number} p - The three.js constant.
-	 * @param {String} [colorSpace=NoColorSpace] - The color space.
-	 * @return {Number} The corresponding WebGL constant.
+	 * @param {number} p - The three.js constant.
+	 * @param {string} [colorSpace=NoColorSpace] - The color space.
+	 * @return {?number} The corresponding WebGL constant.
 	 */
 	convert( p, colorSpace = NoColorSpace ) {