@aethervtt/shard-render 0.0.1 → 0.1.0

package/dist/view-visibility.js

@@ -0,0 +1,46 @@
+import {
+  defineComponent,
+  defineResource,
+  onAdd,
+  t
+} from "@aethervtt/shard-core";
+import { Camera3d } from "./camera.js";
+import { warnFeatureMissing } from "./features.js";
+const VIEW_SHADOWS = ["keep", "hide"];
+const ViewVisibility = defineComponent(
+  "render/ViewVisibility",
+  {
+    hide: t.list(t.entity, {
+      description: "Entities this camera doesn't draw, with their descendants."
+    }),
+    shadows: t.enum(VIEW_SHADOWS, {
+      description: "keep: they still cast into this camera's shadows (a body its own camera doesn't draw). hide: its cascades leave them out too. Spot and point shadow maps are shared by every camera and always keep them."
+    })
+  },
+  {
+    description: "Hides entities from one camera (0070): other cameras still draw them. For a first-person body, split-screen markers, or a game master previewing a player view.",
+    requires: [Camera3d]
+  }
+);
+const NO_HIDDEN = 4294967295;
+const HiddenSetsResource = defineResource("render/HiddenSets", {
+  description: "Each camera's hidden slots (ViewVisibility, 0070), as the culls read them."
+});
+function observeViewVisibilityWithoutPlugin(world) {
+  world.observe(onAdd(ViewVisibility), ({ world: w }) => {
+    if (!w.hasResource(HiddenSetsResource))
+      warnFeatureMissing(
+        w,
+        "A camera has ViewVisibility",
+        "viewVisibilityPlugin",
+        "it hides nothing"
+      );
+  });
+}
+export {
+  HiddenSetsResource,
+  NO_HIDDEN,
+  VIEW_SHADOWS,
+  ViewVisibility,
+  observeViewVisibilityWithoutPlugin
+};

package/dist/view.d.ts

@@ -3,6 +3,7 @@ import type { RenderView } from './graph.js';
 import { type DrawList } from './instances.js';
 import { type PixelPerfectLayout } from './pixel-perfect.js';
 import { type PostSettings } from './post.js';
+import type { HiddenSet } from './view-visibility.js';
 export declare const TONEMAP_CURVES: readonly ['aces', 'agx', 'pbr-neutral', 'reinhard', 'none'];
 export type TonemapCurve = (typeof TONEMAP_CURVES)[number];
 /** The curve for cameras without a Tonemapping component. */
@@ -56,9 +57,17 @@ export interface CameraData {
     /** Scene luminance → pre-exposed HDR. */
     exposure: number;
     ev100: number;
-    /** Linear clear color, as displayed before the tonemap curve. */
+    /** Linear clear color, as displayed before the tonemap curve, premultiplied by its alpha. */
     clear: GPUColor;
+    /**
+     * Clears to an alpha below 1 (0052): the passes carry alpha to the target, the sky and the
+     * environment background aren't drawn, and light raises alpha, so the view composites over
+     * whatever is under its surface.
+     */
+    alphaOutput: boolean;
     msaa: number;
+    /** MSAA was asked for, but the device can't multisample HDR targets (0064): `msaa` is 1. */
+    msaaCapped: boolean;
     curve: number;
     dither: boolean;
     /** Culled draws of this camera, rebuilt each frame. */
@@ -67,6 +76,14 @@ export interface CameraData {
     transparent: DrawList;
     /** Deferred views: opaque draws the G-buffer can't take (custom lighting), drawn forward. */
     forwardOnly: DrawList;
+    /** Ground draws (0057): coplanar bands in (band, order) order, after opaque geometry. */
+    ground: DrawList;
+    /** Ground draws from the overlay band up: after transparent objects and projected fog (0058). */
+    overlay: DrawList;
+    /** Render layers this camera draws (Camera3d.layers). */
+    layers: number;
+    /** Slots it doesn't draw (ViewVisibility, 0070), while it has the component. */
+    hidden: HiddenSet | undefined;
     /** Renders through the G-buffer (RenderPath deferred). */
     deferred: boolean;
     /** G-buffer channel to show for a capture (-1: none), also forcing a G-buffer in forward views. */
@@ -85,7 +102,18 @@ export interface CameraData {
     post: PostSettings;
     /** Set for PixelPerfect cameras: the low-resolution target and how it scales up. */
     pixelPerfect: PixelPerfectLayout | undefined;
+    /** The display size and pixel ratio the last CameraMoved was sent for. */
+    movedWidth: number;
+    movedHeight: number;
+    movedRatio: number;
 }
+/**
+ * Sent after extraction, once per camera whose projection moved this frame (its unjittered view-
+ * projection, display size or pixel ratio changed), and on its first frame (0057).
+ */
+export declare const CameraMoved: import("@aethervtt/shard-core").EventDef<{
+    camera: Entity;
+}>;
 export declare const Cameras: import("@aethervtt/shard-core").ResourceDef<Map<number, CameraData>>;
 /** Global render settings the camera extraction applies to every view. */
 export interface ViewSettingsValue {

package/dist/view.js

@@ -1,6 +1,7 @@
 import {
   affine,
   defineComponent,
+  defineEvent,
   defineResource,
   defineSystem,
   frustum,
@@ -12,13 +13,15 @@ import { LogResource, Time } from "@aethervtt/shard-runtime";
 import { GlobalTransform } from "@aethervtt/shard-transform";
 import { RenderTargets } from "./assets.js";
 import { Camera3d, Exposure, exposureScale } from "./camera.js";
+import { warnFeatureMissing } from "./features.js";
 import { createDrawList } from "./instances.js";
+import { Lens, LensPath } from "./lens.js";
 import {
   PixelPerfect,
   PixelPerfectPath,
   pixelPerfectLayout
 } from "./pixel-perfect.js";
-import { Views, Window } from "./plugin.js";
+import { Gpu, Views, Window } from "./plugin.js";
 import {
   antialiasingOf,
   CORE_EFFECTS,
@@ -58,13 +61,21 @@ const RenderPath = defineComponent(
 const DeferredPath = defineResource("render/DeferredPath", {
   description: "Present when the deferred path (deferredPlugin) is installed."
 });
+const CameraMoved = defineEvent("render/CameraMoved", {
+  description: "A camera moved or its view resized: DOM overlays following the scene reposition."
+});
+function sameMatrix(a, b) {
+  for (let i = 0; i < 16; i++) if (a[i] !== b[i]) return false;
+  return true;
+}
 const Cameras = defineResource("render/Cameras", {
   description: "Per-camera render data by entity, extracted each frame.",
   init: () => /* @__PURE__ */ new Map()
 });
 const ViewSettings = defineResource("render/ViewSettings", {
   description: "Render settings shared by all views: the default MSAA sample count, and the display density past which it is skipped.",
-  init: () => ({ msaa: 4, msaaMaxPixelRatio: 1.5 })
+  init: () => ({ msaa: 4, msaaMaxPixelRatio: 1.5 }),
+  hostWritable: true
 });
 const scratchProj = mat4.create();
 const scratchSnap = affine.create();
@@ -90,32 +101,6 @@ function viewAliases(cam) {
   return cam.msaa > 1 ? MSAA_ALIASES : NO_MSAA_ALIASES;
 }
 const reportedEffects = /* @__PURE__ */ new WeakMap();
-const reportedDeferred = /* @__PURE__ */ new WeakSet();
-function warnMissingDeferred(world) {
-  if (reportedDeferred.has(world)) return;
-  reportedDeferred.add(world);
-  world.tryResource(LogResource)?.log(
-    "warn",
-    "A camera asks for RenderPath deferred, but deferredPlugin isn't installed; it renders forward",
-    {
-      code: "render/feature-missing",
-      hint: "Add deferredPlugin from '@aethervtt/shard-render' (forwardPlugin includes it)."
-    }
-  );
-}
-const reportedPixel = /* @__PURE__ */ new WeakSet();
-function warnMissingPixelPerfect(world) {
-  if (reportedPixel.has(world)) return;
-  reportedPixel.add(world);
-  world.tryResource(LogResource)?.log(
-    "warn",
-    "A camera has PixelPerfect, but pixelPerfectPlugin isn't installed; it renders at full resolution",
-    {
-      code: "render/feature-missing",
-      hint: "Add pixelPerfectPlugin from '@aethervtt/shard-render' (forwardPlugin includes it)."
-    }
-  );
-}
 function warnMissingEffects(world, missing) {
   const reported = reportedEffects.get(world) ?? 0;
   const fresh = missing & ~reported;
@@ -148,6 +133,8 @@ const extractCameras = defineSystem({
     const installed = world.tryResource(PostFeatures)?.effects ?? CORE_EFFECTS;
     const deferredInstalled = world.hasResource(DeferredPath);
     const pixelInstalled = world.hasResource(PixelPerfectPath);
+    const lensInstalled = world.hasResource(LensPath);
+    const maxSamples = world.resource(Gpu).capabilities.hdrSampleCount;
     for (const table of q.tables) {
       const projection = table.column(Camera3d, "projection");
       const fovY = table.column(Camera3d, "fovY");
@@ -158,13 +145,22 @@ const extractCameras = defineSystem({
       const clear = table.column(Camera3d, "clearColor");
       const target = table.column(Camera3d, "target");
       const active = table.column(Camera3d, "active");
+      const layers = table.column(Camera3d, "layers");
       const g = table.column(GlobalTransform, "matrix");
       const ev = table.column(Exposure, "ev100");
       const path = table.has(RenderPath) ? table.column(RenderPath, "mode") : void 0;
       const hasTonemap = table.has(Tonemapping);
       const curve = hasTonemap ? table.column(Tonemapping, "curve") : void 0;
       const dither = hasTonemap ? table.column(Tonemapping, "dither") : void 0;
-      if (table.has(PixelPerfect) && !pixelInstalled) warnMissingPixelPerfect(world);
+      if (table.has(PixelPerfect) && !pixelInstalled)
+        warnFeatureMissing(
+          world,
+          "A camera has PixelPerfect",
+          "pixelPerfectPlugin",
+          "it renders at full resolution"
+        );
+      if (table.has(Lens) && !lensInstalled)
+        warnFeatureMissing(world, "A camera has Lens", "lensPlugin", "it renders unbent");
       const pixel = pixelInstalled && table.has(PixelPerfect);
       const ppu = pixel ? table.column(PixelPerfect, "pixelsPerUnit") : void 0;
       const snap = pixel ? table.column(PixelPerfect, "snap") : void 0;
@@ -205,12 +201,18 @@ const extractCameras = defineSystem({
             exposure: 1,
             ev100: 0,
             clear: { r: 0, g: 0, b: 0, a: 1 },
+            alphaOutput: false,
             msaa: 1,
+            msaaCapped: false,
             curve: 1,
             dither: true,
             draws: createDrawList(),
             transparent: createDrawList(),
             forwardOnly: createDrawList(),
+            ground: createDrawList(),
+            overlay: createDrawList(),
+            layers: 4294967295,
+            hidden: void 0,
             deferred: false,
             gbufferDebug: -1,
             lodState: new Uint8Array(0),
@@ -220,11 +222,15 @@ const extractCameras = defineSystem({
             frames: 0,
             debug: 0,
             post: createPostSettings(),
-            pixelPerfect: void 0
+            pixelPerfect: void 0,
+            movedWidth: 0,
+            movedHeight: 0,
+            movedRatio: 0
           };
           cameras.set(entity, cam);
         }
         cam.orthographic = projection[i] !== 0;
+        cam.layers = layers[i];
         let height = orthoHeight[i];
         cam.pixelPerfect = void 0;
         if (ppu && cam.orthographic) {
@@ -258,7 +264,13 @@ const extractCameras = defineSystem({
         }
         const wantsDeferred = path ? path[i] === 1 : false;
         cam.deferred = wantsDeferred && deferredInstalled;
-        if (wantsDeferred && !deferredInstalled) warnMissingDeferred(world);
+        if (wantsDeferred && !deferredInstalled)
+          warnFeatureMissing(
+            world,
+            "A camera asks for RenderPath deferred",
+            "deferredPlugin",
+            "it renders forward"
+          );
         const missing = extractPost(table, i, cam, delta, true, installed);
         if (missing !== 0) warnMissingEffects(world, missing);
         const world_ = g.subarray(i * 12, i * 12 + 12);
@@ -275,6 +287,12 @@ const extractCameras = defineSystem({
         if (cam.frames > 0) mat4.copy(cam.prevViewProj, cam.viewProjNoJitter);
         mat4.multiply(cam.viewProjNoJitter, scratchProj, cam.view);
         if (cam.frames === 0) mat4.copy(cam.prevViewProj, cam.viewProjNoJitter);
+        if (cam.frames === 0 || !sameMatrix(cam.viewProjNoJitter, cam.prevViewProj) || cam.displayWidth !== cam.movedWidth || cam.displayHeight !== cam.movedHeight || cam.pixelRatio !== cam.movedRatio) {
+          cam.movedWidth = cam.displayWidth;
+          cam.movedHeight = cam.displayHeight;
+          cam.movedRatio = cam.pixelRatio;
+          world.send(CameraMoved, { camera: entity });
+        }
         const jitter = cam.post.jitter;
         if (cam.post.effects & PostEffect.Taa) {
           const k = cam.frames % 8 + 1;
@@ -309,10 +327,14 @@ const extractCameras = defineSystem({
         cam.ev100 = ev[i];
         cam.exposure = exposureScale(ev[i]);
         const c = i * 4;
-        cam.clear = { r: clear[c], g: clear[c + 1], b: clear[c + 2], a: clear[c + 3] };
+        const ca = Math.min(1, Math.max(0, clear[c + 3]));
+        cam.clear = { r: clear[c] * ca, g: clear[c + 1] * ca, b: clear[c + 2] * ca, a: ca };
+        cam.alphaOutput = ca < 1;
         const aa = antialiasingOf(table, i);
         const dense = settings.msaaMaxPixelRatio > 0 && cam.pixelRatio >= settings.msaaMaxPixelRatio;
-        cam.msaa = cam.deferred ? 1 : aa < 0 ? dense ? 1 : settings.msaa : aa === 3 ? 4 : 1;
+        const msaa = cam.deferred ? 1 : aa < 0 ? dense ? 1 : settings.msaa : aa === 3 ? 4 : 1;
+        cam.msaa = Math.min(msaa, maxSamples);
+        cam.msaaCapped = cam.msaa < msaa;
         cam.curve = curve ? curve[i] : TONEMAP_CURVES.indexOf(DEFAULT_CURVE);
         cam.dither = dither ? dither[i] !== 0 : true;
         cam.frames++;
@@ -333,7 +355,7 @@ const extractCameras = defineSystem({
             name: `pixel-perfect:${entity}`,
             target: shown,
             order: order[i] + 0.5,
-            data: { upscale: cam.pixelPerfect }
+            data: { upscale: cam.pixelPerfect, alphaOutput: cam.alphaOutput }
           });
         }
       }
@@ -374,6 +396,7 @@ function cameraOf(view) {
   return view.data.camera;
 }
 export {
+  CameraMoved,
   Cameras,
   DEFAULT_CURVE,
   DeferredPath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aethervtt/shard-render",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
@@ -16,6 +16,10 @@
     "./noise": {
       "types": "./dist/noise.d.ts",
       "default": "./dist/noise.js"
+    },
+    "./surface": {
+      "types": "./dist/surface.d.ts",
+      "default": "./dist/surface.js"
     }
   },
   "files": [
@@ -24,15 +28,15 @@
     "README.md"
   ],
   "dependencies": {
-    "@aethervtt/shard-assets": "0.0.1",
-    "@aethervtt/shard-core": "0.0.1",
-    "@aethervtt/shard-gpu": "0.0.1",
-    "@aethervtt/shard-mesh": "0.0.1",
-    "@aethervtt/shard-noise": "0.0.1",
-    "@aethervtt/shard-runtime": "0.0.1",
-    "@aethervtt/shard-shader": "0.0.1",
-    "@aethervtt/shard-texture": "0.0.1",
-    "@aethervtt/shard-transform": "0.0.1"
+    "@aethervtt/shard-assets": "0.1.0",
+    "@aethervtt/shard-core": "0.1.0",
+    "@aethervtt/shard-gpu": "0.1.0",
+    "@aethervtt/shard-mesh": "0.1.0",
+    "@aethervtt/shard-noise": "0.1.0",
+    "@aethervtt/shard-runtime": "0.1.0",
+    "@aethervtt/shard-shader": "0.1.0",
+    "@aethervtt/shard-texture": "0.1.0",
+    "@aethervtt/shard-transform": "0.1.0"
   },
   "repository": {
     "type": "git",
@@ -44,6 +48,6 @@
     "provenance": true
   },
   "shard": {
-    "buildSha": "d6c5c6aef4675575c878b02cf2c8f738b4190229"
+    "buildSha": "8e14c9896f82a3554b156f1ffdd68f2cc3e7d78a"
   }
 }