lecodes-gl-lite 2.0.0 → 2.0.2

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "lecodes-gl-lite",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "main": "src/index.ts",
   "dependencies": {
     "ogl": "^1.0.11",
-    "lecodes-sdk": "2.0.0",
-    "lecodes-web-runtime": "2.0.0",
-    "lecodes-web-shared": "2.0.0"
+    "lecodes-sdk": "2.0.2",
+    "lecodes-web-runtime": "2.0.2",
+    "lecodes-web-shared": "2.0.2"
   },
   "scripts": {
     "dev": "vite",

package/src/index.ts

@@ -3,3 +3,9 @@
 // library (an editor's viewport); the web host runs Filament, not this.
 export { createViewerLite, basePropsLite } from './webgl/createViewerLite'
 export type { ViewerOptions } from './webgl/createViewerLite'
+// The stores of an engine on its own (what it fetched, what it captured), and their shape for a
+// host that hands over its own.
+export { ownStores } from './webgl/stores'
+export type { EngineStores } from './webgl/stores'
+// KTX2 as a picture (the basis transcoder, no GPU): an editor's thumbnails.
+export { decodeKtx2Image, isKtx2Bytes } from './webgl/decoders'

package/src/webgl/createViewerLite.ts

@@ -20,8 +20,7 @@
 // bloom (no-op). The headless backend records those instead (recording.ts).
 
 import { Camera, Geometry, Mesh, GLTFSkin, Program, Renderer, RenderTarget, Texture, Transform, type OGLRenderingContext } from 'ogl'
-import { _fetch, getBlob, getBuffer as getFetchedBuffer, getLocalName, hasLocalBuffer, putBuffer, putLocalBuffer } from 'lecodes-web-shared/src/utils/fetch'
-import { getPlayer, removePlayers } from 'lecodes-web-shared/src/utils/mediaplayer'
+import { ownStores, type EngineStores } from './stores'
 import type { CanvasHost } from 'lecodes-web-shared/src/canvas/createCanvasHost'
 import {
   identity, intersectRayBox, intersectRaySphere, invertTRS, multiply, orthographic,
@@ -66,6 +65,9 @@ export type ViewerOptions = {
   /** Clear to transparent instead of the skybox color (and open the context with an alpha
    *  channel). Capture hosts use this so PNG thumbnails composite over any page theme. */
   transparent?: boolean
+  /** The fetched buffers and the media players of the host the engine runs under (./stores.ts);
+   *  absent = the engine's own. */
+  stores?: EngineStores
 }
 
 const FOV = 60 // vertical fov set by the native setViewport (scene.cpp) — matches the core default
@@ -110,6 +112,7 @@ const GLTF_UNIFORM_ALIAS: Record<string, string> = {
 }
 
 export const createViewerLite = async (canvas: HTMLCanvasElement, options: ViewerOptions = {}) => {
+  const { fetch: _fetch, getBlob, getBuffer: getFetchedBuffer, getLocalName, hasLocalBuffer, putBuffer, putLocalBuffer, getPlayer, removePlayers } = options.stores ?? ownStores
   const renderer = new Renderer({
     canvas,
     dpr: 1, // set per-resize to the host's resolution factor (devicePixelRatio × CSS zoom); see _onResize

package/src/webgl/stores.ts

@@ -0,0 +1,28 @@
+// What the engine reads of whoever embeds it: the buffers that were fetched (a GLB, a texture, a
+// shader — by the id the SDK holds) and the media players behind a video texture.
+//
+// An engine on its own (an editor's viewport with no host under it) keeps them itself: `ownStores`.
+// An engine under a host (lecodes-web-host's `engine3d`) is HANDED the host's — the bundle fetches
+// through the host, and the id it passes to the engine is an id of the host's store. The shape is
+// written out here, with no type of another package in it: the host writes the same shape in its
+// own contract.
+import { _fetch, getBlob, getBuffer, getLocalName, hasLocalBuffer, putBuffer, putLocalBuffer } from 'lecodes-web-shared/src/utils/fetch'
+import { getPlayer, removePlayers } from 'lecodes-web-shared/src/utils/mediaplayer'
+
+export type EngineStores = {
+  fetch(url: string, options: any, onComplete: (systemId: number, statusCode: number) => void, onReject: (err: Error) => void): unknown
+  getBuffer(systemId: number): ArrayBuffer
+  getBlob(systemId: number): Blob
+  /** Store bytes; the id they are read back by. */
+  putBuffer(buffer: ArrayBuffer): number
+  /** A resource of the app's own, by name (what `fetchLocal` answers with). */
+  putLocalBuffer(name: string, buffer: ArrayBuffer): void
+  hasLocalBuffer(name: string): boolean
+  /** The name a local resource's id was made from. */
+  getLocalName(systemId: number): string | undefined
+  getPlayer(id: number): HTMLVideoElement | HTMLAudioElement | null | undefined
+  removePlayers(): void
+}
+
+/** The engine's own stores: what it uses when it is handed none. */
+export const ownStores: EngineStores = { fetch: _fetch, getBuffer, getBlob, putBuffer, putLocalBuffer, hasLocalBuffer, getLocalName, getPlayer, removePlayers }