@displayxr/inline3d 1.31.0 → 1.32.0

package/CHANGELOG.md

@@ -5,6 +5,55 @@ entry points (`.`, `./three`) are frozen for 1.x, while the **scene subpaths** (
 `./splat`, `./model`) are a preview tier whose options may change in any release. Entries below say
 which tier they touch, because that is what tells you whether an upgrade can move your pixels.
 
+## 1.32.0 — 2026-10-06
+
+Touches the **core** additively (one new handle method, two new exports) and the **preview tier**
+(`./splat`, PlayCanvas backend).
+
+
+### Hosted signalling server (`signaling/`, not part of the npm package)
+
+- **`welcome` is now always the first message a joined peer receives.** With a real TURN key the
+  server awaits a credential mint between reserving a peer's slot and welcoming it; another peer
+  joining or signalling in that window used to reach the first peer *before* its own welcome, and
+  that welcome's `peers` then omitted the newcomer. Messages addressed to a not-yet-welcomed peer
+  are now held and flushed behind its welcome, and the roster is read when the welcome is sent. The
+  SDK was already tolerant of the old order (its transport replays early `peer-joined`s); raw
+  `dxr-signal/1` clients were not. No protocol field changed.
+
+### Core — `handle.displayMetrics()`
+
+- **`handle.displayMetrics()`** → `{ canvasSizeM, metersPerCssPx, displaySizeM, nominalViewerM,
+  eyeSeparationM, source }`: the tile in physical units, derived from `getDisplayInfo()` (panel
+  pitch × `devicePixelRatio` × the canvas's CSS box). Never rejects. Anything the display can't
+  report comes from `DISPLAY_METRICS_DEFAULTS` and is flagged in `source`. **Eye separation is
+  always the 63 mm default**, because no browser or runtime surface reports one. Also exported as
+  the pure `displayMetricsFrom(info, rect, dpr)`.
+
+### `./splat` (PlayCanvas backend)
+
+- **`handle.setStereo({ ipdFactor, parallaxFactor })`**: live stereo strength. It re-declares the
+  rig in force on the next frame with no cut (pose, focus and framing kept). Keys merge, a `null`
+  key returns to the asset's own value, and `setStereo(null)` clears both. Sticky across
+  `setSource` / `setRig`. `handle.rig.stereoDefault` holds the asset's own values.
+  docs/playcanvas-adapter.md §setStereo.
+- **`handle.setDepthEnvelope({ maxFrontM, edgeM, bandM, stage, rects, viewerM, canvasSizeM })`**:
+  the frame envelope. Content may come out of the glass only well inside the frame and away from 2D
+  elements. Gaussians past the cap slide back along their own rays from the declared camera rig,
+  so the picture, the sort order and the stereo rule all hold. It is tile-wide and keyed on the
+  live declared rig (convergence, lens, `ipdFactor × metersToVirtual`), so every asset is covered
+  from its first frame, through crossfades and through `setStereo`, with no per-asset install.
+  Camera rigs only. docs/splat-effects.md §Depth envelope.
+- `setStereo({ ipdScale, parallaxScale })`: the same scalars RELATIVE to each asset's own
+  (`rig.stereoDefault`), re-applied to every asset `setSource` brings in. Per scalar, the absolute
+  and relative keys are exclusive; the last one given wins.
+- **`splatHandle.displayMetrics()`**: the core tile's `displayMetrics()`, on the splat handle.
+- The deferred PlayCanvas handle (what `addSplat` returns before the engine module loads) now has
+  `setStereo`, `setDepthEnvelope` and `displayMetrics`. A call right after `addSplat` was
+  `not a function`. A test now pins this.
+- `STAGE_ORDER` gains `'envelope'` (between `custom` and `cull`), so a page's custom effect runs
+  before the cap.
+
 ## 1.31.0 — 2026-10-05
 
 The 1.29 `./call` option spellings stay accepted (with their warning) for one more release; they go in 1.32.