@kalyptos/narcissus 0.1.1 → 0.1.2

package/dist/element/index.d.ts

@@ -1,9 +1,10 @@
 import { Controls } from '../controls/index.ts';
 import { type Engine } from '../engine/index.ts';
 /**
- * attributes: src, the url of a world.json; budget, the splats a frame may draw; view-distance in
- * metres; camera, the pose to open on as E,N,H,yaw,pitch,dist; sky as r,g,b from 0 to 1. camera
- * and sky are read when a world opens and when the element starts.
+ * attributes: src, the url of a world.json; budget, the splats a frame may draw, which otherwise
+ * adapts to the frame rate; view-distance in metres; camera, the pose to open on as
+ * E,N,H,yaw,pitch,dist, its focus on the ground there when H is left empty, as the opening view's;
+ * sky as r,g,b from 0 to 1. camera and sky are read when a world opens and when the element starts.
  * events: ready, with the World as its detail, and error, with a message.
  * after an error, such as a browser without webgpu, its own content shows in place of the canvas,
  * or the message when it has none.

package/dist/element/index.js

@@ -1,16 +1,16 @@
-import { b as e, h as t, p as n, s as r, t as i } from "../controls-BCrDCO3z.js";
+import { b as e, h as t, p as n, s as r, t as i } from "../controls-mxyJLzqv.js";
 //#region src/element/index.ts
-var a = 4e3, o = [
+var a = 4e3, o = 4e6, s = [2e6, 6e6], c = 2e6, l = [
 	.62,
 	.72,
 	.8
-], s = document.createElement("template");
-s.innerHTML = "<style>\n:host { display: block; position: relative; box-sizing: border-box; width: 100%; aspect-ratio: 16 / 9; }\ncanvas { position: absolute; inset: 0; width: 100%; height: 100%; touch-action: none; }\n[hidden] { display: none; }\n</style><canvas></canvas><slot hidden></slot><p part=\"message\" hidden></p>";
-function c() {
+], u = document.createElement("template");
+u.innerHTML = "<style>\n:host { display: block; position: relative; box-sizing: border-box; width: 100%; aspect-ratio: 16 / 9; }\ncanvas { position: absolute; inset: 0; width: 100%; height: 100%; touch-action: none; }\n[hidden] { display: none; }\n</style><canvas></canvas><slot hidden></slot><p part=\"message\" hidden></p>";
+function d() {
 	let e = navigator;
 	return e.userAgentData?.mobile ?? /Mobi|Android/i.test(e.userAgent);
 }
-var l = class extends HTMLElement {
+var f = class extends HTMLElement {
 	static observedAttributes = [
 		"src",
 		"budget",
@@ -26,7 +26,7 @@ var l = class extends HTMLElement {
 	constructor() {
 		super();
 		let e = this.attachShadow({ mode: "open" });
-		e.append(s.content.cloneNode(!0)), this.#e = e.querySelector("canvas"), this.#t = e.querySelector("slot"), this.#n = e.querySelector("p");
+		e.append(u.content.cloneNode(!0)), this.#e = e.querySelector("canvas"), this.#t = e.querySelector("slot"), this.#n = e.querySelector("p");
 	}
 	get engine() {
 		return this.#r;
@@ -44,13 +44,20 @@ var l = class extends HTMLElement {
 		this.#r && (e === "src" ? this.#l(this.#r) : this.#r.configure(this.#s()));
 	}
 	#s() {
-		let e = (e, t) => {
-			let n = Number(this.getAttribute(e));
-			return n > 0 && Number.isFinite(n) ? n : t;
-		};
-		return {
-			budget: e("budget", c() ? 2e6 : 4e6),
-			viewDistance: e("view-distance", a)
+		let e = (e) => {
+			let t = Number(this.getAttribute(e));
+			return t > 0 && Number.isFinite(t) ? t : null;
+		}, t = e("budget"), n = e("view-distance") ?? a;
+		return t === null ? d() ? {
+			budget: c,
+			viewDistance: n
+		} : {
+			budget: o,
+			budgetRange: s,
+			viewDistance: n
+		} : {
+			budget: t,
+			viewDistance: n
 		};
 	}
 	async #c() {
@@ -64,7 +71,7 @@ var l = class extends HTMLElement {
 					n[0],
 					n[1],
 					n[2]
-				] : o
+				] : l
 			});
 			if (t !== this.#o) return r.destroy();
 			this.#r = r, r.onLost((e) => this.#f(`The graphics device stopped (${e}).`)), this.#a.observe(this), this.#u(), await this.#l(r);
@@ -84,11 +91,16 @@ var l = class extends HTMLElement {
 			return this.#f(`Could not load the world (${t}).`);
 		}
 		if (o !== this.#o) return;
-		let c = (t, n) => e.ground(t, n) ?? s.extent.h[0], l = t(this.getAttribute("camera") ?? "") ?? {
+		let c = (t, n) => e.ground(t, n) ?? s.extent.h[0], l = (this.getAttribute("camera") ?? "").split(","), u = l.length === 6 && l[2].trim() === "", d = t((u ? l.with(2, "0") : l).join(",")), f = d ?? {
 			...n(s),
 			...r
 		};
-		this.#i?.destroy(), this.#i = new i(this.#e, e, c, l), this.dispatchEvent(new CustomEvent("ready", { detail: s }));
+		if (u || !d) {
+			let t = await e.groundAt(f.e, f.n).catch(() => void 0);
+			if (o !== this.#o) return;
+			f.h = t ?? s.extent.h[0];
+		}
+		this.#i?.destroy(), this.#i = new i(this.#e, e, c, f), this.dispatchEvent(new CustomEvent("ready", { detail: s }));
 	}
 	#u() {
 		this.#r?.resize(this.clientWidth, this.clientHeight, devicePixelRatio);
@@ -102,6 +114,6 @@ var l = class extends HTMLElement {
 		this.#t.hidden = !t, this.#n.hidden = t, this.#n.textContent = e, this.dispatchEvent(new CustomEvent("error", { detail: e }));
 	}
 };
-customElements.get("narcissus-viewer") || customElements.define("narcissus-viewer", l);
+customElements.get("narcissus-viewer") || customElements.define("narcissus-viewer", f);
 //#endregion
-export { l as NarcissusViewer };
+export { f as NarcissusViewer };

package/dist/engine/engine.d.ts

@@ -32,6 +32,8 @@ export interface Engine {
     /** world point under canvas css pixel (x, y), or null over nothing */
     pick(x: number, y: number): Promise<[number, number, number] | null>;
     ground(e: number, n: number): number | undefined;
+    /** ground(e, n) once every .idx over (e, n) is read */
+    groundAt(e: number, n: number): Promise<number | undefined>;
     /**
      * tops, as world heights, of the solid splats the next frame draws over cells x cells of 1 m from the
      * south-west corner (west, south), rows south to north, NaN where none; null if no frame comes

package/dist/engine/gpu/pool.d.ts

@@ -3,17 +3,17 @@ import type { Drawn } from '../types.ts';
 export declare class Pool {
     #private;
     /** GEOMETRY_WORDS per record */
-    readonly geometry: GPUBuffer;
+    geometry: GPUBuffer;
     /** COLOUR_WORDS per record */
-    readonly colour: GPUBuffer;
+    colour: GPUBuffer;
     /** Page per table slot */
-    readonly pages: GPUBuffer;
+    pages: GPUBuffer;
     /** Cluster per slot */
-    readonly clusters: GPUBuffer;
-    readonly list: GPUBuffer;
+    clusters: GPUBuffer;
+    list: GPUBuffer;
     listed: number;
     /** splats */
-    readonly capacity: number;
+    capacity: number;
     constructor(device: GPUDevice, capacity: number);
     /** clusters the pool can hold */
     get slots(): number;
@@ -39,5 +39,7 @@ export declare class Pool {
     draw(drawn: Drawn[]): void;
     /** world position of the floating origin; rewrites every page origin */
     setOrigin(origin: readonly [number, number, number]): void;
+    /** room for capacity splats, the pages held staying in place; new buffers, so new bind groups */
+    grow(capacity: number): void;
     destroy(): void;
 }

package/dist/engine/plan/cut.d.ts

@@ -1,4 +1,4 @@
-import type { PageNode, Tree, Wanted } from '../world/tree.ts';
+import { type PageNode, type Tree, type Wanted } from '../world/tree.ts';
 /** a page refined in the last plan stays refined until its count reaches the target times this */
 export declare const MARGIN: number;
 /** ms a refinement seen on screen stays while off screen */
@@ -34,7 +34,7 @@ export interface Plan {
     idx: Wanted[];
     /** ids the pool must keep: the cut, its ancestors and held pages */
     keep: Set<number>;
-    /** splats of the cut inside the frustum */
+    /** splats of the cut's quadrants inside the frustum */
     planned: number;
     /** of planned, the splats not resident yet */
     missing: number;

package/dist/engine/plan/draw.d.ts

@@ -1,3 +1,4 @@
+import { type PageRow } from '../../format/index.ts';
 import type { Drawn } from '../types.ts';
 import type { PageNode } from '../world/tree.ts';
 export declare const FADE_MS = 250;
@@ -14,3 +15,4 @@ export declare class Fader {
         fading: boolean;
     };
 }
+export declare function quadrantSplats({ count, quadrants }: PageRow, q: number): number;

package/dist/engine/plan/footprint.d.ts

@@ -10,3 +10,8 @@ export interface Footprint {
 export declare function centreWeight(left: number, right: number, bottom: number, top: number): number;
 /** box shifted by origin into view m; tan is tan(fov / 2), margin widens the viewport */
 export declare function footprint(box: ArrayLike<number>, m: ArrayLike<number>, width: number, height: number, tan: number, near: number, far: number, margin?: number, out?: Footprint, origin?: readonly [number, number, number]): Footprint;
+/**
+ * bit q set where quadrant q of a page overlaps the viewport: quarter q of its square (x, y, side),
+ * within the box; arguments as footprint's
+ */
+export declare function shownQuadrants(box: ArrayLike<number>, [x, y, side]: readonly [number, number, number], m: ArrayLike<number>, width: number, height: number, tan: number, near: number, far: number, origin?: readonly [number, number, number]): number;

package/dist/engine/quality.d.ts

@@ -2,9 +2,15 @@ export declare const MIN_BUDGET = 500000;
 export declare const MAX_PIXELS: number;
 export declare function pixelRatio(width: number, height: number, ratio: number, scale: number): number;
 export declare function percentile(values: readonly number[], fraction: number): number;
+/** holds SLOW_FPS with the budget first, within range, then the render scale */
 export declare class Quality {
     #private;
+    /** budget alone stays fixed */
+    constructor(budget: number, [min, max]?: readonly [number, number]);
     get scale(): number;
+    /** splats a frame may draw */
+    get budget(): number;
     full(): void;
-    sample(ms: number, now: number, consecutive: boolean): boolean;
+    /** ms since the last frame; planned, the splats the plan draws; true when the scale or budget changed */
+    sample(ms: number, now: number, consecutive: boolean, planned: number): boolean;
 }

package/dist/engine/types.d.ts

@@ -15,6 +15,8 @@ export interface Camera {
 export interface Settings {
     /** splats the engine may draw per frame */
     budget: number;
+    /** the budget adapts within it to hold 30 fps, starting from budget; without it the budget stays */
+    budgetRange?: readonly [number, number];
     /** metres; the far clip and the planner's reach */
     viewDistance: number;
 }
@@ -46,6 +48,8 @@ export interface Stats {
     };
     /** splats the pool holds at most */
     capacity: number;
+    /** splats a frame may draw now */
+    budget: number;
     scale: number;
     loading: boolean;
 }

package/dist/engine/world/tree.d.ts

@@ -43,6 +43,8 @@ export declare class Tree {
     wanted(): Wanted[];
     /** the lowest extent minimum h of the finest page over (e, n), or undefined outside the world */
     ground(e: number, n: number): number | undefined;
+    /** adds every unit over (e, n) that the tree knows of and lacks, each .idx read by fetch */
+    load(e: number, n: number, fetch: (path: string) => Promise<Idx>): Promise<void>;
     /**
      * removes every non-root unit with no page in keep and no added unit below it, deepest first;
      * returns the ids of the pages it removed

package/dist/index.js

@@ -1,4 +1,4 @@
-import { S as e, _ as t, a as n, b as r, c as i, d as a, f as o, g as s, h as c, i as l, l as u, m as d, n as f, o as p, p as m, r as h, s as g, t as _, u as v, v as y, x as b, y as x } from "./controls-BCrDCO3z.js";
+import { S as e, _ as t, a as n, b as r, c as i, d as a, f as o, g as s, h as c, i as l, l as u, m as d, n as f, o as p, p as m, r as h, s as g, t as _, u as v, v as y, x as b, y as x } from "./controls-mxyJLzqv.js";
 import { t as S } from "./ports-DZRKjdYD.js";
 import { t as C } from "./http-DL7R39Nc.js";
 //#region src/engine/plugins/grade.wgsl?raw

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@kalyptos/narcissus",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"description": "A WebGPU engine and tools for Guldmund Trees, streamed gaussian-splat scenes",
 	"license": "BSD-3-Clause",
 	"repository": {