route-graphics 1.46.1 → 1.48.0

package/README.md

@@ -80,6 +80,27 @@ other backend. The selected value is available as `app.rendererType`. Inline
 shader effects always provide both GLSL and WGSL so the same state works on
 either backend.
 
+For scene/editor/preview handoffs, use `await app.reset({ eventHandler })`
+instead of destroying and recreating the renderer. Reset clears the display tree,
+animations, audio playback, keyboard bindings, DOM input controls, cursor state,
+snapshot audio-effect requests, and pending render callbacks while preserving the
+same canvas and GPU context. A render that reset interrupts is reported to the
+previous `eventHandler` as `renderComplete` with `aborted: true`, and the first
+render after a reset calls `onFirstRender` again.
+It accepts runtime initialization overrides, including width/height and plugins;
+renderer backend, fallback policy, and debug mode must remain unchanged.
+Loaded assets stay owned by the instance: use `unloadAssets()` for media no longer
+needed, and `destroy()` when the rendering surface is permanently discarded.
+Serialize reset with asset loading and unloading. This avoids repeated WebGL
+context creation during rapid view changes, which can exhaust WebKit's context
+accounting even after explicit context loss ([WebKit bug 218305](https://bugs.webkit.org/show_bug.cgi?id=218305)).
+
+Run `bun run build && node scripts/testRendererReset.mjs` to verify 40 resets in
+Chromium and WebKit reuse one context, clear runtime state, and release the context
+on final destruction, and that reset removes input controls and keyboard
+bindings, stops animations, and keeps pointer events working. CI runs it in the
+browser suite; the `reset-stops-audio` AVT spec covers audio.
+
 `createAssetBufferManager()` may keep image and video assets as direct source
 URLs when possible, while audio and font assets remain buffer-backed.
 
@@ -102,6 +123,20 @@ Use `renderComplete` when playback completion is required. The PNG CLI waits
 for scene readiness before applying `--time`; `--wait-for-render-complete`
 retains its separate playback-completion meaning.
 
+`extractBase64()` encodes the frame as a PNG data URL. To scale or re-encode
+the frame instead, such as for a thumbnail, take the same pixels as a canvas
+and skip encoding and decoding a full-size PNG:
+
+```javascript
+const frame = await app.extractCanvas();
+const thumbnail = document.createElement("canvas");
+thumbnail.width = 400;
+thumbnail.height = 225;
+thumbnail.getContext("2d").drawImage(frame, 0, 0, 400, 225);
+```
+
+Both take an optional element label to extract that element alone.
+
 Assets loaded by an app instance can be released after no rendered or
 transitioning element still references them: