@newkrok/nape-js 3.21.7 → 3.22.0

package/dist/{ConvexResult-D9juRiQz.d.cts → ConvexResult-BsMBE06r.d.ts}

@@ -1,3 +1,5 @@
+import { P as PhysicsMetricsData } from './PhysicsMetrics-QzFDRdGh.js';
+
 /**
  * 2D vector used for positions, velocities, forces, and other 2D quantities.
  *
@@ -1872,6 +1874,25 @@ declare class Space {
      */
     get deterministic(): boolean;
     set deterministic(value: boolean);
+    /**
+     * Enable the built-in performance profiler. When `true`, each `step()` call
+     * measures per-phase timings (broadphase, narrowphase, velocity solver,
+     * position solver, CCD, sleep) and collects entity counters (body, contact,
+     * constraint counts). Read results via {@link metrics}.
+     *
+     * **Performance:** adds ~14 `performance.now()` calls per step (~1 microsecond
+     * total). Default: `false`.
+     */
+    get profilerEnabled(): boolean;
+    set profilerEnabled(value: boolean);
+    /**
+     * Read-only snapshot of the last `step()` metrics.
+     * Returns a reused object (no allocation per call). Only populated when
+     * {@link profilerEnabled} is `true`; all values are zero otherwise.
+     *
+     * Call `metrics.toJSON()` for a plain-object copy suitable for logging.
+     */
+    get metrics(): PhysicsMetricsData;
     /**
      * Number of sub-steps performed per `step()` call. Each sub-step uses
      * `deltaTime / subSteps` and the same velocity/position iteration counts.

package/dist/{ConvexResult-D9juRiQz.d.ts → ConvexResult-DTGB_nRO.d.cts}

@@ -1,3 +1,5 @@
+import { P as PhysicsMetricsData } from './PhysicsMetrics-QzFDRdGh.cjs';
+
 /**
  * 2D vector used for positions, velocities, forces, and other 2D quantities.
  *
@@ -1872,6 +1874,25 @@ declare class Space {
      */
     get deterministic(): boolean;
     set deterministic(value: boolean);
+    /**
+     * Enable the built-in performance profiler. When `true`, each `step()` call
+     * measures per-phase timings (broadphase, narrowphase, velocity solver,
+     * position solver, CCD, sleep) and collects entity counters (body, contact,
+     * constraint counts). Read results via {@link metrics}.
+     *
+     * **Performance:** adds ~14 `performance.now()` calls per step (~1 microsecond
+     * total). Default: `false`.
+     */
+    get profilerEnabled(): boolean;
+    set profilerEnabled(value: boolean);
+    /**
+     * Read-only snapshot of the last `step()` metrics.
+     * Returns a reused object (no allocation per call). Only populated when
+     * {@link profilerEnabled} is `true`; all values are zero otherwise.
+     *
+     * Call `metrics.toJSON()` for a plain-object copy suitable for logging.
+     */
+    get metrics(): PhysicsMetricsData;
     /**
      * Number of sub-steps performed per `step()` call. Each sub-step uses
      * `deltaTime / subSteps` and the same velocity/position iteration counts.

package/dist/PhysicsMetrics-QzFDRdGh.d.cts

@@ -0,0 +1,40 @@
+/**
+ * Snapshot of per-step physics metrics collected when `Space.profilerEnabled` is true.
+ *
+ * All timing values are in **milliseconds**. Counter values are plain integers.
+ * The object is reused across steps (no allocation per frame).
+ */
+interface PhysicsMetricsData {
+    /** Total wall-clock time of the last `step()` call. */
+    totalStepTime: number;
+    /** Time spent in broadphase collision pair detection. */
+    broadphaseTime: number;
+    /** Time spent in narrowphase (prestep: contact generation, arbiter setup). */
+    narrowphaseTime: number;
+    /** Time spent in velocity integration + warm-start + velocity solver iterations. */
+    velocitySolverTime: number;
+    /** Time spent in position integration + position solver iterations. */
+    positionSolverTime: number;
+    /** Time spent in continuous collision detection (CCD). */
+    ccdTime: number;
+    /** Time spent in sleep management and island/forest processing. */
+    sleepTime: number;
+    /** Total number of bodies in the space. */
+    bodyCount: number;
+    /** Number of dynamic (awake) bodies. */
+    dynamicBodyCount: number;
+    /** Number of static bodies. */
+    staticBodyCount: number;
+    /** Number of kinematic bodies. */
+    kinematicBodyCount: number;
+    /** Number of sleeping bodies. */
+    sleepingBodyCount: number;
+    /** Number of active collision arbiters. */
+    contactCount: number;
+    /** Number of active constraints. */
+    constraintCount: number;
+    /** Number of broadphase pairs tested. */
+    broadphasePairCount: number;
+}
+
+export type { PhysicsMetricsData as P };

package/dist/PhysicsMetrics-QzFDRdGh.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Snapshot of per-step physics metrics collected when `Space.profilerEnabled` is true.
+ *
+ * All timing values are in **milliseconds**. Counter values are plain integers.
+ * The object is reused across steps (no allocation per frame).
+ */
+interface PhysicsMetricsData {
+    /** Total wall-clock time of the last `step()` call. */
+    totalStepTime: number;
+    /** Time spent in broadphase collision pair detection. */
+    broadphaseTime: number;
+    /** Time spent in narrowphase (prestep: contact generation, arbiter setup). */
+    narrowphaseTime: number;
+    /** Time spent in velocity integration + warm-start + velocity solver iterations. */
+    velocitySolverTime: number;
+    /** Time spent in position integration + position solver iterations. */
+    positionSolverTime: number;
+    /** Time spent in continuous collision detection (CCD). */
+    ccdTime: number;
+    /** Time spent in sleep management and island/forest processing. */
+    sleepTime: number;
+    /** Total number of bodies in the space. */
+    bodyCount: number;
+    /** Number of dynamic (awake) bodies. */
+    dynamicBodyCount: number;
+    /** Number of static bodies. */
+    staticBodyCount: number;
+    /** Number of kinematic bodies. */
+    kinematicBodyCount: number;
+    /** Number of sleeping bodies. */
+    sleepingBodyCount: number;
+    /** Number of active collision arbiters. */
+    contactCount: number;
+    /** Number of active constraints. */
+    constraintCount: number;
+    /** Number of broadphase pairs tested. */
+    broadphasePairCount: number;
+}
+
+export type { PhysicsMetricsData as P };