lecodes-sdk 2.3.0 → 2.4.0

package/src/runtime/device.ts

@@ -142,6 +142,35 @@ export const device = {
   set statsOverlay(on: boolean) {
     _creatorDevice.setStatsOverlay?.(!!on)
   },
+  /** Cap the frame rate: the host runs the frame — the tick, the 3D scene — at most `fps` times a
+   *  second. `0` removes the cap: the display's own rate (120 on a 120 Hz phone), or, with vsync
+   *  off, as fast as the host renders. A REQUEST, not a state the app owns: a phone asks its panel
+   *  for the rate (a 120 Hz panel at 60 shows every frame for a full period — even, cooler) and an
+   *  OEM may refuse the switch, in which case the host renders every second refresh instead; the
+   *  screen's own maximum always wins. The tick IS the frame here, so a cap of 30 is 30 Hz of game
+   *  logic and input sampling too — raise it for gameplay. Host state: it stays through a project
+   *  swap. A no-op on hosts whose loop has no pacing of its own (web, headless). */
+  setFrameRate(fps: number): void {
+    const n = +fps
+    _creatorDevice.setFrameRate?.(n > 0 && Number.isFinite(n) ? n : 0)
+  },
+  /** Vertical sync: `false` presents without waiting for the display's refresh — the lowest input
+   *  latency, tearing possible, and with no cap set (`setFrameRate(0)`) the loop renders as fast as
+   *  it can. Set a cap unless you are measuring. Desktop only: a mobile compositor never presents
+   *  outside the refresh. Returns whether the host took the request (`false` on a host without
+   *  the switch), so a settings menu can hide the toggle. */
+  setVsync(enabled: boolean): boolean {
+    if (!_creatorDevice.setVsync) return false
+    _creatorDevice.setVsync(!!enabled)
+    return true
+  },
+  /** The display's refresh rate in Hz: the fastest the screen offers the app — 120 on a 120 Hz
+   *  phone whatever mode a cap has put it in (an iPhone's 60 unless the app's Info.plist lifts the
+   *  floor), the monitor's current mode on desktop. The sensible choices of a frame-rate menu are
+   *  its divisors. 0 where the host cannot tell (web). */
+  get displayRefreshRate(): number {
+    return _creatorDevice.displayRefreshRate?.() ?? 0
+  },
   /** Device-orientation sensor (gyro + accelerometer, fused) for tilt/steering and magic-window /
    *  360° panoramas. Poll `attitude` / `gravity` inside setLoop; they return the freshest fused
    *  sample, so the sensor rate need not match your frame rate. Host-gated: a no-op with no sensor. */

package/src/version.ts

@@ -4,7 +4,7 @@
 // same manifest). Its MAJOR is the bundle ↔ runtime contract: a bundle's `// sdk:` header line
 // and a host's embedded version must agree on the major for the host to run the bundle; minor
 // and patch never gate anything (features are detected, never versioned).
-export const SDK_VERSION = "2.3.0"
+export const SDK_VERSION = "2.4.0"
 
 /** The major of a semver string, or null when it is not one. */
 export const sdkMajor = (version: string | null | undefined): number | null => {