@babylonjs/core 6.34.2 → 6.34.3

package/Engines/webgpuEngine.d.ts

@@ -34,6 +34,7 @@ import type { WebGPUDataBuffer } from "../Meshes/WebGPU/webgpuDataBuffer";
 import "../Buffers/buffer.align";
 import "../ShadersWGSL/postprocess.vertex";
 import type { RenderTargetWrapper } from "./renderTargetWrapper";
+import { WebGPUPerfCounter } from "./WebGPU/webgpuPerfCounter";
 /** @internal */
 interface IWebGPURenderPassWrapper {
     renderPassDescriptor: Nullable<GPURenderPassDescriptor>;
@@ -152,6 +153,8 @@ export declare class WebGPUEngine extends Engine {
     /** @internal */
     _timestampQuery: WebGPUTimestampQuery;
     /** @internal */
+    _timestampIndex: number;
+    /** @internal */
     _occlusionQuery: WebGPUOcclusionQuery;
     /** @internal */
     _compiledComputeEffects: {
@@ -299,6 +302,18 @@ export declare class WebGPUEngine extends Engine {
      */
     get compatibilityMode(): boolean;
     set compatibilityMode(mode: boolean);
+    /**
+     * Enables or disables GPU timing measurements.
+     * Note that this is only supported if the "timestamp-query" extension is enabled in the options.
+     */
+    get enableGPUTimingMeasurements(): boolean;
+    set enableGPUTimingMeasurements(enable: boolean);
+    /**
+     * Gets the GPU time spent in the main render pass for the last frame rendered (in nanoseconds).
+     * You have to enable the "timestamp-query" extension in the engine constructor options and set engine.enableGPUTimingMeasurements = true.
+     * It will only return time spent in the main pass, not additional render target / compute passes (if any)!
+     */
+    readonly gpuTimeInFrameForMainPass?: WebGPUPerfCounter;
     /** @internal */
     get currentSampleCount(): number;
     /**
@@ -426,7 +441,7 @@ export declare class WebGPUEngine extends Engine {
     /**
      * Creates a new index buffer
      * @param indices defines the content of the index buffer
-     * @param updatable defines if the index buffer must be updatable
+     * @param _updatable defines if the index buffer must be updatable
      * @param label defines the label of the buffer (for debug purpose)
      * @returns a new buffer
      */

package/Engines/webgpuEngine.js

@@ -1,9 +1,11 @@
+/* eslint-disable babylonjs/available */
 import { Logger } from "../Misc/logger.js";
 import { Color4 } from "../Maths/math.js";
 import { Engine } from "../Engines/engine.js";
 import { InternalTexture, InternalTextureSource } from "../Materials/Textures/internalTexture.js";
 import { Effect } from "../Materials/effect.js";
 
+// eslint-disable-next-line @typescript-eslint/naming-convention
 import * as WebGPUConstants from "./WebGPU/webgpuConstants.js";
 import { VertexBuffer } from "../Buffers/buffer.js";
 import { WebGPUPipelineContext } from "./WebGPU/webgpuPipelineContext.js";
@@ -34,6 +36,7 @@ import { ShaderLanguage } from "../Materials/shaderLanguage.js";
 import { WebGPUSnapshotRendering } from "./WebGPU/webgpuSnapshotRendering.js";
 import "../Buffers/buffer.align.js";
 import "../ShadersWGSL/postprocess.vertex.js";
+import { WebGPUPerfCounter } from "./WebGPU/webgpuPerfCounter.js";
 const viewDescriptorSwapChainAntialiasing = {
     label: `TextureView_SwapChain_ResolveTarget`,
     dimension: WebGPUConstants.TextureDimension.E2d,
@@ -188,6 +191,20 @@ export class WebGPUEngine extends Engine {
     set compatibilityMode(mode) {
         this._compatibilityMode = mode;
     }
+    /**
+     * Enables or disables GPU timing measurements.
+     * Note that this is only supported if the "timestamp-query" extension is enabled in the options.
+     */
+    get enableGPUTimingMeasurements() {
+        return this._timestampQuery.enable;
+    }
+    set enableGPUTimingMeasurements(enable) {
+        if (this._timestampQuery.enable === enable) {
+            return;
+        }
+        this.gpuTimeInFrameForMainPass = enable ? new WebGPUPerfCounter() : undefined;
+        this._timestampQuery.enable = enable;
+    }
     /** @internal */
     get currentSampleCount() {
         return this._currentRenderTarget ? this._currentRenderTarget.samples : this._mainPassSampleCount;
@@ -231,6 +248,8 @@ export class WebGPUEngine extends Engine {
             description: "",
         };
         /** @internal */
+        this._timestampIndex = 0;
+        /** @internal */
         this._compiledComputeEffects = {};
         /** @internal */
         this._counters = {
@@ -420,11 +439,11 @@ export class WebGPUEngine extends Engine {
             Logger.Error(e);
         })
             .then(() => {
-            this._bufferManager = new WebGPUBufferManager(this._device);
+            this._bufferManager = new WebGPUBufferManager(this, this._device);
             this._textureHelper = new WebGPUTextureHelper(this._device, this._glslang, this._tintWASM, this._bufferManager, this._deviceEnabledExtensions);
             this._cacheSampler = new WebGPUCacheSampler(this._device);
             this._cacheBindGroups = new WebGPUCacheBindGroups(this._device, this._cacheSampler, this);
-            this._timestampQuery = new WebGPUTimestampQuery(this._device, this._bufferManager);
+            this._timestampQuery = new WebGPUTimestampQuery(this, this._device, this._bufferManager);
             this._occlusionQuery = this._device.createQuerySet ? new WebGPUOcclusionQuery(this, this._device, this._bufferManager) : undefined;
             this._bundleList = new WebGPUBundleList(this._device);
             this._snapshotRendering = new WebGPUSnapshotRendering(this, this._snapshotRenderingMode, this._bundleList);
@@ -1034,7 +1053,7 @@ export class WebGPUEngine extends Engine {
     /**
      * Creates a new index buffer
      * @param indices defines the content of the index buffer
-     * @param updatable defines if the index buffer must be updatable
+     * @param _updatable defines if the index buffer must be updatable
      * @param label defines the label of the buffer (for debug purpose)
      * @returns a new buffer
      */
@@ -1912,6 +1931,7 @@ export class WebGPUEngine extends Engine {
         this._endCurrentRenderPass();
         this._snapshotRendering.endFrame();
         this._timestampQuery.endFrame(this._renderEncoder);
+        this._timestampIndex = 0;
         this.flushFramebuffer();
         this._textureHelper.destroyDeferredTextures();
         this._bufferManager.destroyDeferredBuffers();
@@ -2057,7 +2077,7 @@ export class WebGPUEngine extends Engine {
                 colorAttachments.push(null);
             }
         }
-        (_e = this._debugPushGroup) === null || _e === void 0 ? void 0 : _e.call(this, "render target pass", 1);
+        (_e = this._debugPushGroup) === null || _e === void 0 ? void 0 : _e.call(this, "render target pass" + (renderTargetWrapper.label ? " (" + renderTargetWrapper.label + ")" : ""), 1);
         this._rttRenderPassWrapper.renderPassDescriptor = {
             label: ((_f = renderTargetWrapper.label) !== null && _f !== void 0 ? _f : "RTT") + "RenderPass",
             colorAttachments,
@@ -2078,6 +2098,7 @@ export class WebGPUEngine extends Engine {
                 : undefined,
             occlusionQuerySet: ((_g = this._occlusionQuery) === null || _g === void 0 ? void 0 : _g.hasQueries) ? this._occlusionQuery.querySet : undefined,
         };
+        this._timestampQuery.startPass(this._rttRenderPassWrapper.renderPassDescriptor, this._timestampIndex);
         this._currentRenderPass = this._renderEncoder.beginRenderPass(this._rttRenderPassWrapper.renderPassDescriptor);
         if (this.dbgVerboseLogsForFirstFrames) {
             if (this._count === undefined) {
@@ -2158,6 +2179,7 @@ export class WebGPUEngine extends Engine {
             }
         }
         (_b = this._debugPushGroup) === null || _b === void 0 ? void 0 : _b.call(this, "main pass", 0);
+        this._timestampQuery.startPass(this._mainRenderPassWrapper.renderPassDescriptor, this._timestampIndex);
         this._currentRenderPass = this._renderEncoder.beginRenderPass(this._mainRenderPassWrapper.renderPassDescriptor);
         this._setDepthTextureFormat(this._mainRenderPassWrapper);
         this._setColorFormat(this._mainRenderPassWrapper);
@@ -2179,6 +2201,10 @@ export class WebGPUEngine extends Engine {
             this._bundleList.reset();
         }
         this._currentRenderPass.end();
+        this._timestampQuery.endPass(this._timestampIndex, (this._currentRenderTarget && this._currentRenderTarget.gpuTimeInFrame
+            ? this._currentRenderTarget.gpuTimeInFrame
+            : this.gpuTimeInFrameForMainPass));
+        this._timestampIndex += 2;
         if (this.dbgVerboseLogsForFirstFrames) {
             if (this._count === undefined) {
                 this._count = 0;
@@ -2543,8 +2569,11 @@ export class WebGPUEngine extends Engine {
     dispose() {
         var _a, _b;
         this._isDisposed = true;
+        this._timestampQuery.dispose();
         (_a = this._mainTexture) === null || _a === void 0 ? void 0 : _a.destroy();
         (_b = this._depthTexture) === null || _b === void 0 ? void 0 : _b.destroy();
+        this._textureHelper.destroyDeferredTextures();
+        this._bufferManager.destroyDeferredBuffers();
         this._device.destroy();
         super.dispose();
     }