@niivue/niivue 1.0.0-rc.21 → 1.0.0-rc.23

package/README.md

@@ -87,10 +87,13 @@ Add a `<canvas>` to your page and attach NiiVue to it:
 
 ### Backend-specific distributions
 
-By default, `@niivue/niivue` includes both backends (WebGPU + WebGL2 fallback):
+By default, `@niivue/niivue` includes both backends and renders with WebGL2. Opt in to WebGPU with the `backend` option; if WebGPU is unavailable or fails to initialize, it falls back to WebGL2:
 
 ```js
 import NiiVue from '@niivue/niivue'
+
+const nv = new NiiVue() // WebGL2
+const nvGpu = new NiiVue({ backend: 'webgpu' }) // WebGPU, WebGL2 fallback
 ```
 
 You can also import backend-only builds to reduce package size:

package/dist/NVDocument.d.ts

@@ -153,7 +153,7 @@ export type NVDocumentSlidePlane = {
 export type NVDocumentData = {
     version: number;
     created: string;
-    scene: {
+    scene?: {
         azimuth?: number;
         elevation?: number;
         scaleMultiplier?: number;
@@ -164,19 +164,19 @@ export type NVDocumentData = {
         clipPlaneColor?: number[];
         isClipPlaneCutaway?: boolean;
     };
-    layout: Partial<LayoutConfig>;
-    ui: Partial<UIConfig>;
-    volume: Partial<VolumeRenderConfig>;
-    mesh: Partial<MeshRenderConfig>;
-    draw: Partial<DrawConfig>;
-    interaction: Partial<InteractionConfig>;
-    clipPlanes: number[];
+    layout?: Partial<LayoutConfig>;
+    ui?: Partial<UIConfig>;
+    volume?: Partial<VolumeRenderConfig>;
+    mesh?: Partial<MeshRenderConfig>;
+    draw?: Partial<DrawConfig>;
+    interaction?: Partial<InteractionConfig>;
+    clipPlanes?: number[];
     /** RLE-compressed drawing bitmap (if a drawing was active) */
     drawingBitmapRLE?: Uint8Array;
     /** Uncompressed length of drawing bitmap */
     drawingBitmapLength?: number;
-    volumes: NVDocumentVolume[];
-    meshes: NVDocumentMesh[];
+    volumes?: NVDocumentVolume[];
+    meshes?: NVDocumentMesh[];
     signals?: SerializedSignal[];
     annotations?: VectorAnnotation[];
     annotationConfig?: Partial<AnnotationConfig>;

package/dist/NVTypes.d.ts

@@ -1024,6 +1024,7 @@ export type GraphConfig = {
 export type NiiVueOptions = {
     instances?: NVInstance[];
     globalCamera?: NVGlobalCamera;
+    /** Rendering backend. Defaults to 'webgl2' ('webgpu' in the WebGPU-only build). */
     backend?: BackendType;
     isAntiAlias?: boolean;
     devicePixelRatio?: number;

package/dist/documentJson.d.ts

@@ -1,6 +1,11 @@
-/** Serialize an NVD document object to a JSON string, tagging typed arrays. */
+/** Serialize an NVD document object to a JSON string, tagging typed arrays
+ * and non-finite numbers. Throws on a typed-array kind the decoder cannot
+ * rebuild (BigInt64Array, ...) rather than emitting a tag it would not
+ * recognise. */
 export declare function encodeDocumentJSON(doc: unknown): string;
-/** Parse a JSON NVD document string, reconstructing tagged typed arrays. */
+/** Parse a JSON NVD document string, reconstructing tagged typed arrays and
+ * non-finite numbers. A bare `null` (what an older encoder wrote for a
+ * non-finite number) is left as `null`. */
 export declare function decodeDocumentJSON(text: string): unknown;
 /** True when the bytes are a JSON document (first non-whitespace byte is `{`).
  * CBOR NVDs start with a map marker (>= 0xa0), never `{` (0x7b), so this cleanly