@displayxr/inline3d 1.27.0 → 1.28.0

package/player.d.ts

@@ -267,7 +267,8 @@ export type PlayerAccent = 'azure' | 'violet' | 'magenta' | 'sunset' | 'amber' |
 
 /**
  * Pick the first source this browser can play from candidates listed best first; each is a URL, or
- * `{ src, type }` with a FULL `canPlayType` string (`'video/webm; codecs="vp9, opus"'`). The
- * DisplayXR Browser has no H.264/AAC, and a codec-less `'video/mp4'` still answers 'maybe'.
+ * `{ src, type }` with a FULL `canPlayType` string (`'video/webm; codecs="vp9, opus"'`). Only
+ * DisplayXR Browser 1.0.6+ plays H.264/AAC (via the OS decoders), and a codec-less `'video/mp4'`
+ * still answers 'maybe' — so list a VP9 WebM first when you have one.
  */
 export function pickSource(candidates: PlayerSource, canPlayType?: (type: string) => string): string | Blob | undefined;

package/splat.d.ts

@@ -379,7 +379,11 @@ export interface SplatOptions {
    * so a long subject still fits once the turntable turns it (default true).
    */
   fitSweep?: boolean;
-  /** Per-eye buffer scale; 0.5–0.7 is usually free (default 1). */
+  /**
+   * Per-eye buffer scale; 0.5–0.7 is usually free (default 1). Clamped to the device's GL limits: the whole store (2 × eye wide in 3D) is kept within
+   * min(MAX_TEXTURE_SIZE, MAX_RENDERBUFFER_SIZE, MAX_VIEWPORT_DIMS), both axes shrunk by one factor,
+   * with a one-time console warning. The handle's `renderScale` reports the value in force.
+   */
   renderScale?: number;
   feather?: number;
   /**
@@ -1008,11 +1012,18 @@ export interface SplatHandle {
   /**
    * `engine: 'playcanvas'` only. Change the per-eye buffer scale live (the `renderScale` option),
    * in (0, 4]; the backing store is resized on the next animation frame. Throws a RangeError
-   * otherwise.
+   * otherwise. The request is kept as given (`renderScaleRequested`); the store is still clamped
+   * to the device's GL limits, and `renderScale` reports what is in force.
    */
   setRenderScale(scale: number): SplatHandle;
-  /** `engine: 'playcanvas'` only. The current per-eye buffer scale. */
+  /**
+   * The per-eye buffer scale IN FORCE: the request times the device-limit clamp. E.g. 0.8 for a
+   * request of 1 on a device whose MAX_TEXTURE_SIZE (4096) cannot hold a 5120-wide SBS store.
+   * Both engines.
+   */
   readonly renderScale: number;
+  /** The per-eye buffer scale as requested (the option, or the last `setRenderScale`). Both engines. */
+  readonly renderScaleRequested: number;
   /**
    * `engine: 'playcanvas'` only. The 2D tier's EYE offset — a head-parallax analogue for a flat
    * screen with no tracked eyes (e.g. a phone's tilt). `{x, y}` is normalised in the mono camera's

package/viewer.d.ts

@@ -29,7 +29,11 @@ export interface SceneViewerOptions {
   orbit?: boolean;
   /** Degrees/second of turntable once idle. Ignored under prefers-reduced-motion. */
   idleSpin?: number;
-  /** Per-eye buffer scale; 0.5–0.7 is usually free after the interlace (default 1). */
+  /**
+   * Per-eye buffer scale; 0.5–0.7 is usually free after the interlace (default 1). Clamped to the device's GL limits: the whole store (2 × eye wide in 3D) is kept within
+   * min(MAX_TEXTURE_SIZE, MAX_RENDERBUFFER_SIZE, MAX_VIEWPORT_DIMS), both axes shrunk by one factor,
+   * with a one-time console warning. `effectiveRenderScale` reports the value in force.
+   */
   renderScale?: number;
   /** Edge fade in buffer px (needs EdgeFeather from ./three). */
   feather?: number;
@@ -96,6 +100,13 @@ export declare class SceneViewer {
   readonly monoCamera: object;
   /** True while the side-by-side backing store is in use. */
   readonly is3D: boolean;
+  /** The requested per-eye buffer scale (the `renderScale` option). */
+  renderScale: number;
+  /**
+   * The per-eye buffer scale in force: `renderScale` times the device-limit clamp the last resize
+   * applied (1 where the store fits the device's MAX_TEXTURE_SIZE & co.).
+   */
+  readonly effectiveRenderScale: number;
 
   /** Centre the subject on the zero-disparity plane and scale it to the tile. */
   fitTo(