@woosh/meep-engine 3.34.0 → 3.35.0

package/package.json

@@ -6,7 +6,7 @@
   "description": "Advanced 3D game engine",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "3.34.0",
+  "version": "3.35.0",
   "exports": {
     "./build/*": "./build/*",
     "./src/*": "./src/*",

package/src/shade/device/timing/profile/GPUProfileSession.d.ts

@@ -72,7 +72,8 @@ export class GPUProfileSession {
     readonly onBytesWritten: any;
     /**
      * Fires once, with the finished capture, however the session ended — `stop()` or the frame
-     * limit running out. Both paths land here so a caller can await one thing.
+     * limit running out — once the frames begun before that have landed. Both paths land here so a
+     * caller can await one thing.
      *
      * @readonly
      * @type {Signal<ArrayBuffer>}
@@ -83,6 +84,10 @@ export class GPUProfileSession {
      */
     get level(): number;
     /**
+     * Whether new frames are being taken: from `start()` until `stop()` or the frame limit. A session
+     * that is no longer running can still be waiting on frames begun before that; {@link done} says
+     * when it has them.
+     *
      * @returns {boolean}
      */
     get is_running(): boolean;
@@ -123,7 +128,8 @@ export class GPUProfileSession {
      */
     begin_frame(frame_index: number, cpu_begin_ms: number): GPUFrameRecorder | null;
     /**
-     * Close a recorder opened by {@link begin_frame} and commit what it collected.
+     * Close a recorder opened by {@link begin_frame} and commit what it collected — after `stop()`
+     * too, which is waiting for exactly this.
      *
      * @param {GPUFrameRecorder} recorder
      * @param {number} cpu_submit_ms
@@ -133,9 +139,10 @@ export class GPUProfileSession {
     /**
      * Commit one frame.
      *
-     * Ignored when the session is not running, so a frame that lands after `stop()` — the readback
-     * for a frame already submitted, which is the ordinary case — is dropped rather than throwing
-     * inside somebody's render loop.
+     * Taken for as long as the stream is open: from `start()` until the capture is finished, which
+     * `stop()` holds off until every frame already begun has landed. Ignored before `start()`, once
+     * the capture is finished, and past the frame limit — frames begun before the limit was reached
+     * still land after it — rather than throwing inside somebody's render loop.
      *
      * @param {GPUProfileFrame} frame
      * @returns {void}
@@ -151,17 +158,24 @@ export class GPUProfileSession {
      */
     snapshot(): ArrayBuffer;
     /**
-     * End the recording and hand back the capture.
+     * End the recording, and resolve with the capture once every frame already begun has landed.
+     *
+     * No frame is begun after this — {@link begin_frame} hands out nothing — but the ones that were
+     * are kept. A frame is committed when its timestamp readback resolves, a `mapAsync` behind its
+     * submit, so when `stop()` is called the last frame or two are always still on their way; behind
+     * a first-use pipeline compile, which holds the queue for seconds, every frame of a short capture
+     * can be. Finishing the stream on the spot threw all of those away without a word.
      *
-     * Calling it twice returns the same bytes rather than complaining; a session that hit its
-     * frame limit has already stopped itself, and the caller awaiting `stop()` should still get
+     * Calling it again resolves with the same capture rather than complaining; a session that hit
+     * its frame limit has already stopped itself, and the caller awaiting `stop()` should still get
      * the capture.
      *
-     * @returns {ArrayBuffer}
+     * @returns {Promise<ArrayBuffer>}
      */
-    stop(): ArrayBuffer;
+    stop(): Promise<ArrayBuffer>;
     /**
-     * Resolves with the capture when the session ends, whichever way it ends.
+     * Resolves with the capture when the session ends, whichever way it ends — after the frames
+     * begun before the end have landed.
      *
      * @returns {Promise<ArrayBuffer>}
      */

package/src/shade/device/timing/profile/GPUProfileSession.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GPUProfileSession.d.ts","sourceRoot":"","sources":["../../../../../../src/shade/device/timing/profile/GPUProfileSession.js"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH;IAqGI;;;;;;OAMG;IACH;QAL4B,KAAK,GAAtB,MAAM;QACW,WAAW,GAA5B,MAAM;QAEW,IAAI,GAArB,MAAM;OAkBhB;IA7DD;;;;;;;OAOG;IACH,6BAEC;IAED;;;;;;OAMG;IACH,aAFU,MAAM,CAEkB;IAElC;;;;;OAKG;IACH,6BAA8B;IAE9B;;;;;;OAMG;IACH,yBAA0B;IA2B1B;;OAEG;IACH,oBAEC;IAED;;OAEG;IACH,0BAEC;IAED;;OAEG;IACH,8BAEC;IAED;;OAEG;IACH,4BAEC;IAED;;;;;OAKG;IACH,2BAEC;IAED;;;;;;OAMG;IACH,SAFa,IAAI,CAqBhB;IAED;;;;;;;;;;;OAWG;IACH,yBAJW,MAAM,gBACN,MAAM,GACJ,gBAAgB,GAAC,IAAI,CAkBjC;IAED;;;;;;OAMG;IACH,oBAJW,gBAAgB,iBAChB,MAAM,GACJ,IAAI,CAMhB;IAsCD;;;;;;;;;OASG;IACH,oBAHW,eAAe,GACb,IAAI,CAkEhB;IAED;;;;;;;OAOG;IACH,YAFa,WAAW,CAMvB;IAED;;;;;;;;OAQG;IACH,QAFa,WAAW,CAiBvB;IAOD;;;;OAIG;IACH,iCAaC;;CACJ;8BAzcY,OAAO,sBAAsB,EAAE,eAAe;+BAZ5B,qBAAqB;iCAFnB,uBAAuB"}
+{"version":3,"file":"GPUProfileSession.d.ts","sourceRoot":"","sources":["../../../../../../src/shade/device/timing/profile/GPUProfileSession.js"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH;IAkHI;;;;;;OAMG;IACH;QAL4B,KAAK,GAAtB,MAAM;QACW,WAAW,GAA5B,MAAM;QAEW,IAAI,GAArB,MAAM;OAkBhB;IA9DD;;;;;;;OAOG;IACH,6BAEC;IAED;;;;;;OAMG;IACH,aAFU,MAAM,CAEkB;IAElC;;;;;OAKG;IACH,6BAA8B;IAE9B;;;;;;;OAOG;IACH,yBAA0B;IA2B1B;;OAEG;IACH,oBAEC;IAED;;;;;;OAMG;IACH,0BAEC;IAED;;OAEG;IACH,8BAEC;IAED;;OAEG;IACH,4BAEC;IAED;;;;;OAKG;IACH,2BAEC;IAED;;;;;;OAMG;IACH,SAFa,IAAI,CAqBhB;IAED;;;;;;;;;;;OAWG;IACH,yBAJW,MAAM,gBACN,MAAM,GACJ,gBAAgB,GAAC,IAAI,CAoBjC;IAED;;;;;;;OAOG;IACH,oBAJW,gBAAgB,iBAChB,MAAM,GACJ,IAAI,CAiBhB;IAwDD;;;;;;;;;;OAUG;IACH,oBAHW,eAAe,GACb,IAAI,CAWhB;IAsED;;;;;;;OAOG;IACH,YAFa,WAAW,CAMvB;IAED;;;;;;;;;;;;;;OAcG;IACH,QAFa,QAAQ,WAAW,CAAC,CAehC;IAkBD;;;;;OAKG;IACH,iCAaC;;CACJ;8BAxhBY,OAAO,sBAAsB,EAAE,eAAe;+BAZ5B,qBAAqB;iCAFnB,uBAAuB"}