@babylonjs/core 5.24.0 → 5.26.0

package/Engines/webgpuEngine.js

@@ -52,18 +52,18 @@ export class WebGPUEngine extends Engine {
         this._uploadEncoderDescriptor = { label: "upload" };
         this._renderEncoderDescriptor = { label: "render" };
         this._renderTargetEncoderDescriptor = { label: "renderTarget" };
-        /** @hidden */
+        /** @internal */
         this._clearDepthValue = 1;
-        /** @hidden */
+        /** @internal */
         this._clearReverseDepthValue = 0;
-        /** @hidden */
+        /** @internal */
         this._clearStencilValue = 0;
         this._defaultSampleCount = 4; // Only supported value for now.
         this._glslang = null;
         this._tintWASM = null;
-        /** @hidden */
+        /** @internal */
         this._compiledComputeEffects = {};
-        /** @hidden */
+        /** @internal */
         this._counters = {
             numEnableEffects: 0,
             numEnableDrawWrapper: 0,
@@ -85,32 +85,32 @@ export class WebGPUEngine extends Engine {
         this.numMaxUncapturedErrors = 20;
         this._commandBuffers = [null, null, null];
         // Frame Buffer Life Cycle (recreated for each render target pass)
-        /** @hidden */
+        /** @internal */
         this._currentRenderPass = null;
-        /** @hidden */
+        /** @internal */
         this._mainRenderPassWrapper = new WebGPURenderPassWrapper();
-        /** @hidden */
+        /** @internal */
         this._rttRenderPassWrapper = new WebGPURenderPassWrapper();
-        /** @hidden */
+        /** @internal */
         this._pendingDebugCommands = [];
-        /** @hidden */
+        /** @internal */
         this._onAfterUnbindFrameBufferObservable = new Observable();
         this._currentOverrideVertexBuffers = null;
         this._currentIndexBuffer = null;
         this._colorWriteLocal = true;
         this._forceEnableEffect = false;
         // TODO WEBGPU remove those variables when code stabilized
-        /** @hidden */
+        /** @internal */
         this.dbgShowShaderCode = false;
-        /** @hidden */
+        /** @internal */
         this.dbgSanityChecks = true;
-        /** @hidden */
+        /** @internal */
         this.dbgVerboseLogsForFirstFrames = false;
-        /** @hidden */
+        /** @internal */
         this.dbgVerboseLogsNumFrames = 10;
-        /** @hidden */
+        /** @internal */
         this.dbgLogIfNotDrawWrapper = true;
-        /** @hidden */
+        /** @internal */
         this.dbgShowEmptyEnableEffectCalls = true;
         //------------------------------------------------------------------------------
         //                              Dynamic WebGPU States
@@ -297,7 +297,7 @@ export class WebGPUEngine extends Engine {
     set compatibilityMode(mode) {
         this._compatibilityMode = mode;
     }
-    /** @hidden */
+    /** @internal */
     get currentSampleCount() {
         return this._currentRenderTarget ? this._currentRenderTarget.samples : this._mainPassSampleCount;
     }
@@ -659,8 +659,7 @@ export class WebGPUEngine extends Engine {
         return true;
     }
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessor(shaderLanguage) {
         if (shaderLanguage === ShaderLanguage.WGSL) {
@@ -669,8 +668,7 @@ export class WebGPUEngine extends Engine {
         return this._shaderProcessor;
     }
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessingContext(shaderLanguage) {
         return new WebGPUShaderProcessingContext(shaderLanguage);
@@ -678,7 +676,7 @@ export class WebGPUEngine extends Engine {
     //------------------------------------------------------------------------------
     //                          Static Pipeline WebGPU States
     //------------------------------------------------------------------------------
-    /** @hidden */
+    /** @internal */
     applyStates() {
         this._stencilStateComposer.apply();
         this._cacheRenderPipeline.setAlphaBlendEnabled(this._alphaState.alphaBlend);
@@ -769,11 +767,7 @@ export class WebGPUEngine extends Engine {
         }
     }
     /**
-     * @param x
-     * @param y
-     * @param width
-     * @param height
-     * @hidden
+     * @internal
      */
     _viewport(x, y, width, height) {
         this._viewportCached.x = x;
@@ -839,8 +833,7 @@ export class WebGPUEngine extends Engine {
         return update;
     }
     /**
-     * @param renderPass
-     * @hidden
+     * @internal
      */
     _applyStencilRef(renderPass) {
         renderPass.setStencilReference(this._stencilStateComposer.funcRef ?? 0);
@@ -1005,9 +998,7 @@ export class WebGPUEngine extends Engine {
         return dataBuffer;
     }
     /**
-     * @param data
-     * @param creationFlags
-     * @hidden
+     * @internal
      */
     _createBuffer(data, creationFlags) {
         let view;
@@ -1042,13 +1033,13 @@ export class WebGPUEngine extends Engine {
         return this._bufferManager.createBuffer(view, flags);
     }
     /**
-     * @hidden
+     * @internal
      */
     bindBuffersDirectly() {
         throw "Not implemented on WebGPU";
     }
     /**
-     * @hidden
+     * @internal
      */
     updateAndBindInstancesBuffer() {
         throw "Not implemented on WebGPU";
@@ -1066,8 +1057,7 @@ export class WebGPUEngine extends Engine {
         this._cacheRenderPipeline.setBuffers(vertexBuffers, indexBuffer, this._currentOverrideVertexBuffers);
     }
     /**
-     * @param buffer
-     * @hidden
+     * @internal
      */
     _releaseBuffer(buffer) {
         return this._bufferManager.releaseBuffer(buffer);
@@ -1161,13 +1151,13 @@ export class WebGPUEngine extends Engine {
         return program;
     }
     /**
-     * @hidden
+     * @internal
      */
     createRawShaderProgram() {
         throw "Not available on WebGPU";
     }
     /**
-     * @hidden
+     * @internal
      */
     createShaderProgram() {
         throw "Not available on WebGPU";
@@ -1206,15 +1196,7 @@ export class WebGPUEngine extends Engine {
         return new WebGPUDrawContext(this._bufferManager);
     }
     /**
-     * @param pipelineContext
-     * @param vertexSourceCode
-     * @param fragmentSourceCode
-     * @param createAsRaw
-     * @param rawVertexSourceCode
-     * @param rawFragmentSourceCode
-     * @param rebuildRebind
-     * @param defines
-     * @hidden
+     * @internal
      */
     _preparePipelineContext(pipelineContext, vertexSourceCode, fragmentSourceCode, createAsRaw, rawVertexSourceCode, rawFragmentSourceCode, rebuildRebind, defines) {
         const webGpuContext = pipelineContext;
@@ -1309,8 +1291,7 @@ export class WebGPUEngine extends Engine {
         }
     }
     /**
-     * @param effect
-     * @hidden
+     * @internal
      */
     _releaseEffect(effect) {
         if (this._compiledEffects[effect._key]) {
@@ -1344,13 +1325,12 @@ export class WebGPUEngine extends Engine {
     get needPOTTextures() {
         return false;
     }
-    /** @hidden */
+    /** @internal */
     _createHardwareTexture() {
         return new WebGPUHardwareTexture();
     }
     /**
-     * @param texture
-     * @hidden
+     * @internal
      */
     _releaseTexture(texture) {
         const index = this._internalTexturesCache.indexOf(texture);
@@ -1360,7 +1340,7 @@ export class WebGPUEngine extends Engine {
         this._textureHelper.releaseTexture(texture);
     }
     /**
-     * @hidden
+     * @internal
      */
     _getRGBABufferInternalSizedFormat() {
         return 5;
@@ -1370,7 +1350,7 @@ export class WebGPUEngine extends Engine {
     }
     /**
      * Creates an internal texture without binding it to a framebuffer
-     * @hidden
+     * @internal
      * @param size defines the size of the texture
      * @param options defines the options used to create the texture
      * @param delayGPUTextureCreation true to delay the texture creation the first time it is really needed. false to create it right away
@@ -1564,10 +1544,7 @@ export class WebGPUEngine extends Engine {
         this._textureHelper.createGPUTextureForInternalTexture(texture, width, height, depth, additionalUsages);
     }
     /**
-     * @param name
-     * @param texture
-     * @param baseName
-     * @hidden
+     * @internal
      */
     _setInternalTexture(name, texture, baseName) {
         baseName = baseName ?? name;
@@ -1676,10 +1653,7 @@ export class WebGPUEngine extends Engine {
         return true;
     }
     /**
-     * @param target
-     * @param internalTexture
-     * @param anisotropicFilteringLevel
-     * @hidden
+     * @internal
      */
     _setAnisotropicLevel(target, internalTexture, anisotropicFilteringLevel) {
         if (internalTexture._cachedAnisotropicFilteringLevel !== anisotropicFilteringLevel) {
@@ -1687,10 +1661,7 @@ export class WebGPUEngine extends Engine {
         }
     }
     /**
-     * @param channel
-     * @param texture
-     * @param name
-     * @hidden
+     * @internal
      */
     _bindTexture(channel, texture, name) {
         if (channel === undefined) {
@@ -1706,9 +1677,7 @@ export class WebGPUEngine extends Engine {
         this._generateMipmaps(texture, this._renderTargetEncoder);
     }
     /**
-     * @param texture
-     * @param commandEncoder
-     * @hidden
+     * @internal
      */
     _generateMipmaps(texture, commandEncoder) {
         const gpuHardwareTexture = texture._hardwareTexture;
@@ -1761,14 +1730,7 @@ export class WebGPUEngine extends Engine {
         }
     }
     /**
-     * @param texture
-     * @param internalFormat
-     * @param width
-     * @param height
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadCompressedDataToTextureDirectly(texture, internalFormat, width, height, imageData, faceIndex = 0, lod = 0) {
         let gpuTextureWrapper = texture._hardwareTexture;
@@ -1780,13 +1742,7 @@ export class WebGPUEngine extends Engine {
         this._textureHelper.updateTexture(data, texture, width, height, texture.depth, gpuTextureWrapper.format, faceIndex, lod, false, false, 0, 0);
     }
     /**
-     * @param texture
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @param babylonInternalFormat
-     * @param useTextureWidthAndHeight
-     * @hidden
+     * @internal
      */
     _uploadDataToTextureDirectly(texture, imageData, faceIndex = 0, lod = 0, babylonInternalFormat, useTextureWidthAndHeight = false) {
         const lodMaxWidth = Math.round(Math.log(texture.width) * Math.LOG2E);
@@ -1801,21 +1757,13 @@ export class WebGPUEngine extends Engine {
         this._textureHelper.updateTexture(data, texture, width, height, texture.depth, gpuTextureWrapper.format, faceIndex, lod, texture.invertY, false, 0, 0);
     }
     /**
-     * @param texture
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadArrayBufferViewToTexture(texture, imageData, faceIndex = 0, lod = 0) {
         this._uploadDataToTextureDirectly(texture, imageData, faceIndex, lod);
     }
     /**
-     * @param texture
-     * @param image
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadImageToTexture(texture, image, faceIndex = 0, lod = 0) {
         let gpuTextureWrapper = texture._hardwareTexture;
@@ -1965,7 +1913,7 @@ export class WebGPUEngine extends Engine {
             }
         }
     }
-    /** @hidden */
+    /** @internal */
     _currentFrameBufferIsDefaultFrameBuffer() {
         return this._currentRenderTarget === null;
     }
@@ -2079,7 +2027,7 @@ export class WebGPUEngine extends Engine {
             this._stencilStateComposer.enabled = false;
         }
     }
-    /** @hidden */
+    /** @internal */
     _endRenderTargetRenderPass() {
         if (this._currentRenderPass) {
             const gpuWrapper = this._currentRenderTarget.texture?._hardwareTexture;
@@ -2115,7 +2063,7 @@ export class WebGPUEngine extends Engine {
         }
         return this._currentRenderPass;
     }
-    /** @hidden */
+    /** @internal */
     _getCurrentRenderPassIndex() {
         return this._currentRenderPass === null ? -1 : this._currentRenderPass === this._mainRenderPassWrapper.renderPass ? 0 : 1;
     }
@@ -2335,8 +2283,7 @@ export class WebGPUEngine extends Engine {
     //                              Render
     //------------------------------------------------------------------------------
     /**
-     * @param wrapper
-     * @hidden
+     * @internal
      */
     _setColorFormat(wrapper) {
         const format = wrapper.colorAttachmentGPUTextures[0]?.format ?? null;
@@ -2347,8 +2294,7 @@ export class WebGPUEngine extends Engine {
         this._colorFormat = format;
     }
     /**
-     * @param wrapper
-     * @hidden
+     * @internal
      */
     _setDepthTextureFormat(wrapper) {
         this._cacheRenderPipeline.setDepthStencilFormat(wrapper.depthTextureFormat);
@@ -2608,11 +2554,11 @@ export class WebGPUEngine extends Engine {
     //                              Unused WebGPU
     //------------------------------------------------------------------------------
     /**
-     * @hidden
+     * @internal
      */
     bindSamplers() { }
     /**
-     * @hidden
+     * @internal
      */
     _bindTextureDirectly() {
         return false;
@@ -2625,9 +2571,7 @@ export class WebGPUEngine extends Engine {
         return true;
     }
     /**
-     * @param pipelineContext
-     * @param action
-     * @hidden
+     * @internal
      */
     _executeWhenRenderingStateIsCompiled(pipelineContext, action) {
         // No parallel shader compilation.
@@ -2635,125 +2579,125 @@ export class WebGPUEngine extends Engine {
         action();
     }
     /**
-     * @hidden
+     * @internal
      */
     _isRenderingStateCompiled() {
         // No parallel shader compilation.
         return true;
     }
-    /** @hidden */
+    /** @internal */
     _getUnpackAlignement() {
         return 1;
     }
     /**
-     * @hidden
+     * @internal
      */
     _unpackFlipY() { }
     /**
-     * @hidden
+     * @internal
      */
     _bindUnboundFramebuffer() {
         throw "_bindUnboundFramebuffer is not implementedin WebGPU! You probably want to use restoreDefaultFramebuffer or unBindFramebuffer instead";
     }
     // TODO WEBGPU. All of the below should go once engine split with baseEngine.
     /**
-     * @hidden
+     * @internal
      */
     _getSamplingParameters() {
         throw "_getSamplingParameters is not available in WebGPU";
     }
     /**
-     * @hidden
+     * @internal
      */
     getUniforms() {
         return [];
     }
     /**
-     * @hidden
+     * @internal
      */
     setIntArray() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setIntArray2() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setIntArray3() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setIntArray4() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setArray() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setArray2() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setArray3() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setArray4() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setMatrices() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setMatrix3x3() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setMatrix2x2() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setFloat() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setFloat2() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setFloat3() {
         return false;
     }
     /**
-     * @hidden
+     * @internal
      */
     setFloat4() {
         return false;