reze-engine 0.42.3 → 0.50.0

package/dist/shaders/passes/hosted-api.js

@@ -0,0 +1,166 @@
+// The half of the effect API whose VALUES are module-local.
+//
+// An effect file is spliced WHOLE into every module it has a mount in. A file
+// with a trail and a lightEmit compiles its trail code inside the light module,
+// where it never runs but still has to resolve — so `rzTime()` has to exist
+// there even though a compute pass that writes lamp positions has no obvious
+// clock, and `rzFalloff()` has to exist there even though nothing calls it.
+//
+// EFFECT_SCENE_API (composite.ts) is the other half: names that mean the same
+// thing everywhere, written once. These are the ones that cannot be, because
+// each module keeps its clock and its viewport in a different uniform. So they
+// are written once HERE and the expression is the parameter — which is the
+// same trick the grid pass already used for one of them, generalised to all.
+//
+// The rule this file exists to make keepable: a hosting module includes every
+// block below. Not the ones its own mount happens to need — every one, because
+// what lands in it is the author's whole file.
+//
+// EXCEPT that EFFECT_SCENE_API already carries EFFECT_MATH_API and the Particle
+// struct, so the three modules built on it take those two by inheritance and
+// must not add them again. tests/hosted-api.test.mjs fails on a name declared
+// twice for exactly this reason — it is the mistake sharing blocks invites.
+/**
+ * The particle record, laid out by hand — declared in EVERY hosting module.
+ *
+ * Not only in the particle ones: `fn particleStep(p: Particle)` is part of the
+ * author's file, so the trail, field and lightEmit modules compile that
+ * signature as dead code and a missing struct is a compile error on a function
+ * the author was right to write. The trail module used to carry a hand-copied
+ * duplicate for exactly this reason.
+ *
+ * `age` and `life` sit in the padding that vec3f alignment would waste anyway
+ * (a vec3f occupies 12 bytes but aligns the next field to 16), so the struct is
+ * 48 bytes rather than the 64 a naive ordering costs. At 4096 particles that is
+ * 192KB instead of 256KB, and it is read every frame by both stages.
+ *
+ * `life <= 0` means "not alive" and is what the pool checks to recycle a slot,
+ * so a freshly zeroed buffer is entirely dead and every particle is born on the
+ * first step rather than needing a separate seeding pass.
+ *
+ * RzLight is the same kind of thing and lives in lights.ts, because it is that
+ * module's own type; every hosting module splices it for this same reason.
+ */
+export const PARTICLE_STRUCT_WGSL = /* wgsl */ `
+struct Particle {
+  pos: vec3f,
+  age: f32,
+  vel: vec3f,
+  life: f32,
+  size: f32,
+  rot: f32,
+  seed: f32,
+  // Aspect along the direction of travel. 1 or less is a square billboard; a
+  // raindrop is 10 or 20. Zero-initialised, so an effect that never sets it gets
+  // the square it expects.
+  stretch: f32,
+}
+`;
+/**
+ * `rzTime`/`rzDt`, from whatever the module calls its clock.
+ *
+ * A module with no clock of its own passes a literal. Zero dt is honest there:
+ * nothing spliced into it is being stepped, so a kernel that integrates would
+ * integrate by nothing rather than by a plausible-looking wrong number.
+ */
+export function clockApi(timeExpr, dtExpr) {
+    return /* wgsl */ `
+fn rzTime() -> f32 { return ${timeExpr}; }
+fn rzDt() -> f32 { return ${dtExpr}; }
+`;
+}
+/** `rzViewportHeight` — the render target's height in pixels, which is what a
+ *  point size in world units has to be divided by to become a pixel radius. */
+export function viewportApi(heightExpr) {
+    return /* wgsl */ `
+fn rzViewportHeight() -> f32 { return ${heightExpr}; }
+`;
+}
+/**
+ * The one cast number that is PER EFFECT rather than per engine.
+ *
+ * Author-visible, and published effects loop over it, so its meaning is pinned:
+ * how many of THIS effect's anchors asked for a trail. Deliberately not the
+ * anchor address space — that is RZ_MAX_ANCHORS in CAST_API, and the two being
+ * one number was the old trail bug. Everything else about the cast's shape is a
+ * constant and lives there.
+ */
+export function trailSlotsApi(trailCount) {
+    return /* wgsl */ `
+const RZ_TRAIL_SLOTS: i32 = ${trailCount};
+`;
+}
+/**
+ * Pure math — no bindings, no uniforms, identical in every module.
+ *
+ * These were duplicated in the particle and trail modules, byte for byte in the
+ * case of rzFalloff and to a `+ vec3f(0.0)` in the case of rzValueNoise. Two
+ * copies of a noise function is one bad merge away from an effect that looks
+ * different depending on which mount drew it, which is not a bug anyone would
+ * think to look for.
+ *
+ * EVERY hosting module includes this and none defines any of these itself, so
+ * "which module am I in" can never change what a helper returns.
+ */
+export const EFFECT_MATH_API = /* wgsl */ `
+fn rzHash11(x: f32) -> f32 {
+  var p = fract(x * 0.1031);
+  p = p * (p + 33.33);
+  return fract(p * (p + p));
+}
+fn rzHash21(p: vec2f) -> f32 {
+  var p3 = fract(vec3f(p.x, p.y, p.x) * 0.1031);
+  p3 = p3 + dot(p3, p3.yzx + 33.33);
+  return fract((p3.x + p3.y) * p3.z);
+}
+/** Three independent randoms from one seed — the usual need when spawning. */
+fn rzHash13(x: f32) -> vec3f {
+  return vec3f(rzHash11(x), rzHash11(x + 17.13), rzHash11(x + 41.71));
+}
+/**
+ * Compact-support falloff: 1 at the centre, exactly 0 at r, smooth between.
+ *
+ * It reaches exactly zero rather than merely getting small, because a glow that
+ * never quite ends has to be culled somewhere, and culling it wherever it looks
+ * close enough is what put a visible hard edge on the first halo effect.
+ */
+fn rzFalloff(d: f32, r: f32) -> f32 {
+  let x = clamp(d / max(r, 1e-6), 0.0, 1.0);
+  let f = 1.0 - x;
+  return f * f * f;
+}
+fn rzHash31(p: vec3f) -> f32 {
+  var p3 = fract(p * 0.1031);
+  p3 = p3 + dot(p3, p3.zyx + 31.32);
+  return fract((p3.x + p3.y) * p3.z);
+}
+fn rzValueNoise(p: vec3f) -> f32 {
+  let i = floor(p);
+  let f = fract(p);
+  let u = f * f * (3.0 - 2.0 * f);
+  let n000 = rzHash31(i);
+  let n100 = rzHash31(i + vec3f(1.0, 0.0, 0.0));
+  let n010 = rzHash31(i + vec3f(0.0, 1.0, 0.0));
+  let n110 = rzHash31(i + vec3f(1.0, 1.0, 0.0));
+  let n001 = rzHash31(i + vec3f(0.0, 0.0, 1.0));
+  let n101 = rzHash31(i + vec3f(1.0, 0.0, 1.0));
+  let n011 = rzHash31(i + vec3f(0.0, 1.0, 1.0));
+  let n111 = rzHash31(i + vec3f(1.0, 1.0, 1.0));
+  let x00 = mix(n000, n100, u.x);
+  let x10 = mix(n010, n110, u.x);
+  let x01 = mix(n001, n101, u.x);
+  let x11 = mix(n011, n111, u.x);
+  return mix(mix(x00, x10, u.y), mix(x01, x11, u.y), u.z);
+}
+/** Divergence-free flow — the field a wisp of smoke follows without a solver. */
+fn rzCurlNoise(p: vec3f) -> vec3f {
+  let e = 0.1;
+  let dx = vec3f(e, 0.0, 0.0);
+  let dy = vec3f(0.0, e, 0.0);
+  let dz = vec3f(0.0, 0.0, e);
+  let x0 = rzValueNoise(p - dx); let x1 = rzValueNoise(p + dx);
+  let y0 = rzValueNoise(p - dy); let y1 = rzValueNoise(p + dy);
+  let z0 = rzValueNoise(p - dz); let z1 = rzValueNoise(p + dz);
+  return normalize(vec3f((y1 - y0) - (z1 - z0), (z1 - z0) - (x1 - x0), (x1 - x0) - (y1 - y0)) + vec3f(1e-6));
+}
+`;

package/dist/shaders/passes/id-debug.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The id attachment, drawn so a person can look at it.
+ *
+ * The id buffer is correct or incorrect in ways nothing else in the frame can
+ * show: with no consumer, a perfect id buffer and a completely wrong one
+ * produce exactly the same picture. This pass exists so that "it works" is
+ * something seen rather than inferred.
+ *
+ * WHAT CORRECT LOOKS LIKE, and what each failure looks like instead:
+ *
+ *   - Every material is ONE FLAT COLOUR, with hard edges. Ids are names, not
+ *     quantities: a gradient anywhere, or fringing along an edge, means
+ *     something is interpolating or resolving them — the two failures the
+ *     no-resolve/no-blend rules exist to prevent.
+ *   - Parts differ from each other. A whole model in one colour means the
+ *     material index never made it into the uniform.
+ *   - The FLOOR is a fixed light grey, the reserved id, and never shares a
+ *     colour with a body part.
+ *   - Where nothing was drawn is BLACK — id 0, the reserved nothing, which is
+ *     also what the attachment clears to. Black *over geometry* means that draw
+ *     wrote no id; colour where the sky should be means the clear is wrong.
+ *
+ * Colours come from a hash of the pair, so neighbouring materials land on
+ * unrelated hues rather than adjacent shades of one — the point is telling them
+ * apart, not ordering them.
+ */
+export declare const ID_DEBUG_SHADER_WGSL = "\n// Multisampled and NEVER resolved, so it is read the way it is written: one\n// sample, by texel. Sample 0 is what every consumer of this attachment reads.\n@group(0) @binding(0) var idTex: texture_multisampled_2d<u32>;\n\n@vertex fn vs(@builtin(vertex_index) vi: u32) -> @builtin(position) vec4f {\n  let x = f32((vi & 1u) << 2u) - 1.0;\n  let y = f32((vi & 2u) << 1u) - 1.0;\n  return vec4f(x, y, 0.0, 1.0);\n}\n\n/** Integer hash \u2192 0..1. Distinct inputs land on unrelated outputs, which is the\n *  whole requirement: adjacent ids must not read as adjacent colours. */\nfn hashId(x: u32) -> f32 {\n  var h = x * 747796405u + 2891336453u;\n  h = ((h >> ((h >> 28u) + 4u)) ^ h) * 277803737u;\n  return f32((h >> 22u) ^ h) / 4294967295.0;\n}\n\n@fragment fn fs(@builtin(position) fragCoord: vec4f) -> @location(0) vec4f {\n  let ids = textureLoad(idTex, vec2<i32>(fragCoord.xy), 0);\n  let materialId = ids.x;\n  let objectId = ids.y;\n\n  // Nothing drawn here. Black, and it must cover exactly the empty space.\n  if (materialId == 0u && objectId == 0u) {\n    return vec4f(0.0, 0.0, 0.0, 1.0);\n  }\n  // The floor, at the top of the range. Flat light grey so it is unmistakable\n  // and cannot be confused with a hashed colour.\n  if (materialId == 65535u) {\n    return vec4f(0.72, 0.72, 0.75, 1.0);\n  }\n  // Hue from the material, brightness from the object, so two models wearing\n  // the same material index still read apart.\n  let h = hashId(materialId * 1973u + 9277u);\n  let shade = 0.55 + 0.45 * hashId(objectId * 6151u + 1u);\n  // Cheap hue ramp: three offset cosines. Saturated on purpose \u2014 this is a\n  // diagnostic, not a look.\n  let rgb = vec3f(\n    0.5 + 0.5 * cos(6.28318 * (h + 0.00)),\n    0.5 + 0.5 * cos(6.28318 * (h + 0.33)),\n    0.5 + 0.5 * cos(6.28318 * (h + 0.67)),\n  );\n  return vec4f(rgb * shade, 1.0);\n}\n";
+//# sourceMappingURL=id-debug.d.ts.map

package/dist/shaders/passes/id-debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"id-debug.d.ts","sourceRoot":"","sources":["../../../src/shaders/passes/id-debug.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,oBAAoB,20DA8ChC,CAAA"}

package/dist/shaders/passes/id-debug.js

@@ -0,0 +1,74 @@
+import { GROUND_MATERIAL_ID } from "./ground";
+/**
+ * The id attachment, drawn so a person can look at it.
+ *
+ * The id buffer is correct or incorrect in ways nothing else in the frame can
+ * show: with no consumer, a perfect id buffer and a completely wrong one
+ * produce exactly the same picture. This pass exists so that "it works" is
+ * something seen rather than inferred.
+ *
+ * WHAT CORRECT LOOKS LIKE, and what each failure looks like instead:
+ *
+ *   - Every material is ONE FLAT COLOUR, with hard edges. Ids are names, not
+ *     quantities: a gradient anywhere, or fringing along an edge, means
+ *     something is interpolating or resolving them — the two failures the
+ *     no-resolve/no-blend rules exist to prevent.
+ *   - Parts differ from each other. A whole model in one colour means the
+ *     material index never made it into the uniform.
+ *   - The FLOOR is a fixed light grey, the reserved id, and never shares a
+ *     colour with a body part.
+ *   - Where nothing was drawn is BLACK — id 0, the reserved nothing, which is
+ *     also what the attachment clears to. Black *over geometry* means that draw
+ *     wrote no id; colour where the sky should be means the clear is wrong.
+ *
+ * Colours come from a hash of the pair, so neighbouring materials land on
+ * unrelated hues rather than adjacent shades of one — the point is telling them
+ * apart, not ordering them.
+ */
+export const ID_DEBUG_SHADER_WGSL = /* wgsl */ `
+// Multisampled and NEVER resolved, so it is read the way it is written: one
+// sample, by texel. Sample 0 is what every consumer of this attachment reads.
+@group(0) @binding(0) var idTex: texture_multisampled_2d<u32>;
+
+@vertex fn vs(@builtin(vertex_index) vi: u32) -> @builtin(position) vec4f {
+  let x = f32((vi & 1u) << 2u) - 1.0;
+  let y = f32((vi & 2u) << 1u) - 1.0;
+  return vec4f(x, y, 0.0, 1.0);
+}
+
+/** Integer hash → 0..1. Distinct inputs land on unrelated outputs, which is the
+ *  whole requirement: adjacent ids must not read as adjacent colours. */
+fn hashId(x: u32) -> f32 {
+  var h = x * 747796405u + 2891336453u;
+  h = ((h >> ((h >> 28u) + 4u)) ^ h) * 277803737u;
+  return f32((h >> 22u) ^ h) / 4294967295.0;
+}
+
+@fragment fn fs(@builtin(position) fragCoord: vec4f) -> @location(0) vec4f {
+  let ids = textureLoad(idTex, vec2<i32>(fragCoord.xy), 0);
+  let materialId = ids.x;
+  let objectId = ids.y;
+
+  // Nothing drawn here. Black, and it must cover exactly the empty space.
+  if (materialId == 0u && objectId == 0u) {
+    return vec4f(0.0, 0.0, 0.0, 1.0);
+  }
+  // The floor, at the top of the range. Flat light grey so it is unmistakable
+  // and cannot be confused with a hashed colour.
+  if (materialId == ${GROUND_MATERIAL_ID}u) {
+    return vec4f(0.72, 0.72, 0.75, 1.0);
+  }
+  // Hue from the material, brightness from the object, so two models wearing
+  // the same material index still read apart.
+  let h = hashId(materialId * 1973u + 9277u);
+  let shade = 0.55 + 0.45 * hashId(objectId * 6151u + 1u);
+  // Cheap hue ramp: three offset cosines. Saturated on purpose — this is a
+  // diagnostic, not a look.
+  let rgb = vec3f(
+    0.5 + 0.5 * cos(6.28318 * (h + 0.00)),
+    0.5 + 0.5 * cos(6.28318 * (h + 0.33)),
+    0.5 + 0.5 * cos(6.28318 * (h + 0.67)),
+  );
+  return vec4f(rgb * shade, 1.0);
+}
+`;

package/dist/shaders/passes/particles.d.ts

@@ -0,0 +1,66 @@
+/** Where the cast/trail history sits in the shared storage buffer. */
+export type CastLayout = {
+    subjects: number;
+    samples: number;
+    base: number;
+    trailBase: number;
+    /** The scene's anchor CAP — the address space, not how many asked for trails. */
+    slots: number;
+    /** How many of this effect's anchors asked for a trail. AUTHOR-VISIBLE as
+     *  RZ_TRAIL_SLOTS: published effects loop over it, so its meaning is pinned
+     *  even though the address space it used to share is now a separate number. */
+    trailCount: number;
+    /** This effect's local slot → scene slot. Identity while one effect exists. */
+    alias: number[];
+};
+/** How the author's quads combine with the scene. */
+type ParticleBlend = "alpha" | "additive";
+type ParticleSource = {
+    /** The author's WGSL verbatim. */
+    wgsl: string;
+    /** Simultaneous particles. Fixed at install; the pool recycles rather than grows. */
+    count: number;
+    blend: ParticleBlend;
+    /** Feed the bloom pyramid. Off by default — rain should not glow. */
+    bloom: boolean;
+};
+/** Bytes per particle. Explicitly padded — see the struct below. */
+export declare const PARTICLE_STRIDE = 48;
+/** `// @particles 4096` — how many live at once. */
+export declare function parseParticleCount(wgsl: string, max: number): number;
+/** `// @bloom` — opt in to the bloom pyramid. Sparks want it; rain does not. */
+export declare function parseParticleBloom(wgsl: string): boolean;
+/** `// @blend additive` — default is straight alpha. */
+export declare function parseParticleBlend(wgsl: string): ParticleBlend;
+/** Does the source define the particle contract? All three are required together. */
+export declare function particleEntryPoints(wgsl: string): {
+    init: boolean;
+    step: boolean;
+    shade: boolean;
+};
+/**
+ * Spawn, age, recycle.
+ *
+ * One kernel for both birth and update, because a dead slot and a new particle
+ * are the same write — a pool that recycles has no allocation and therefore no
+ * spawn-rate bookkeeping to get wrong. The cost is that lifetimes are staggered
+ * only by whatever the author randomises in `particleInit`, which for rain and
+ * snow is exactly right, and for a burst is what the age offset is for.
+ */
+export declare function buildParticleComputeShader(src: ParticleSource, cast: CastLayout): string;
+/**
+ * One camera-facing quad per live particle.
+ *
+ * Six vertices, no index or vertex buffer: the corners are derived from
+ * `vertex_index` and the particle is read from storage by `instance_index`, so a
+ * draw is `draw(6, count)` and there is nothing to upload per frame. The billboard
+ * basis comes from the VIEW matrix's rows rather than from a look-at, which keeps
+ * the quad square on screen no matter where the camera rolls.
+ *
+ * A dead particle collapses to a degenerate quad instead of being culled on the
+ * CPU — the alternative is a compacted draw list, which costs a prefix sum and a
+ * readback every frame to save vertices the rasteriser was going to reject anyway.
+ */
+export declare function buildParticleRenderShader(src: ParticleSource, cast: CastLayout): string;
+export {};
+//# sourceMappingURL=particles.d.ts.map

package/dist/shaders/passes/particles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"particles.d.ts","sourceRoot":"","sources":["../../../src/shaders/passes/particles.ts"],"names":[],"mappings":"AAwBA,sEAAsE;AACtE,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,iFAAiF;IACjF,KAAK,EAAE,MAAM,CAAA;IACb;;mFAE+E;IAC/E,UAAU,EAAE,MAAM,CAAA;IAClB,+EAA+E;IAC/E,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB,CAAA;AAiCD,qDAAqD;AACrD,KAAK,aAAa,GAAG,OAAO,GAAG,UAAU,CAAA;AAEzC,KAAK,cAAc,GAAG;IACpB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,aAAa,CAAA;IACpB,qEAAqE;IACrE,KAAK,EAAE,OAAO,CAAA;CACf,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,eAAe,KAAK,CAAA;AAkDjC,oDAAoD;AACpD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAOpE;AAED,gFAAgF;AAChF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wDAAwD;AACxD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAE9D;AAED,qFAAqF;AACrF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAMlG;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM,CA0CxF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM,CA6GvF"}

package/dist/shaders/passes/particles.js

@@ -0,0 +1,279 @@
+import { RZ_LIGHT_STRUCT_WGSL } from "../lights";
+import { audioApi } from "../audio-api";
+import { lyricsApi } from "../lyrics-api";
+import { anchorAliasWgsl } from "../anchor-table";
+import { midiApi } from "../midi-api";
+import { CAST_API } from "../cast-api";
+import { clockApi, EFFECT_MATH_API, PARTICLE_STRUCT_WGSL, trailSlotsApi, viewportApi } from "./hosted-api";
+/**
+ * The trail accessors, in the PARTICLE module.
+ *
+ * Sparks are the reason: the original hand ribbon shed sparks along its path,
+ * and as real particles they need to SPAWN on that path — which means
+ * particleInit reading the same recorded history the trail draws from. One
+ * effect file, two mounts, one buffer.
+ */
+/** Shared with the grid pass, which reads the same buffer for the same reason:
+ *  a kernel that displaces fog has to know where the dancer's feet are. */
+function castApi(cast) {
+    return (
+    // rzSubjectCount FIRST, because CAST_API is written against it and this
+    // module has no view uniform to read the engine's count out of. Scanning
+    // for a subject whose bounding sphere has a radius is the same answer by a
+    // different route — the seam is named at the top of cast-api.ts.
+    `
+fn rzSubjectCount() -> i32 {
+  var n = 0;
+  for (var i = 0; i < RZ_SUBJECTS; i++) {
+    if (_rzCast[i * 3 + 2].w > 0.0) { n = i + 1; }
+  }
+  return n;
+}
+` +
+        CAST_API +
+        trailSlotsApi(cast.trailCount) +
+        anchorAliasWgsl(cast.alias));
+}
+/** Bytes per particle. Explicitly padded — see the struct below. */
+export const PARTICLE_STRIDE = 48;
+const CAMERA_STRUCT = /* wgsl */ `
+struct CameraU {
+  view: mat4x4f,
+  proj: mat4x4f,
+  camPos: vec3f,
+  targetHeight: f32,
+}
+`;
+const PARTICLE_UNIFORMS = /* wgsl */ `
+struct ParticleU {
+  time: f32,
+  dt: f32,
+  count: u32,
+  frame: u32,
+}
+`;
+/**
+ * This module's half of the prelude: the camera, from its own uniform.
+ *
+ * The rest — hashes, noise, falloff, clock, viewport — is shared with every
+ * other module that hosts an effect's source, because an author's helper must
+ * mean the same thing in whichever one it lands in.
+ */
+const PRELUDE = 
+// The hashes, the noise and rzFalloff, identical in every module that hosts an
+// effect's source; then the clock and the viewport, which cannot be, because
+// this module keeps both in its own uniforms.
+EFFECT_MATH_API +
+    clockApi("pu.time", "pu.dt") +
+    viewportApi("cam.targetHeight") +
+    /* wgsl */ `
+${RZ_LIGHT_STRUCT_WGSL}
+fn rzCameraPos() -> vec3f { return cam.camPos; }
+fn rzCameraRight() -> vec3f { return vec3f(cam.view[0][0], cam.view[1][0], cam.view[2][0]); }
+fn rzCameraUp() -> vec3f { return vec3f(cam.view[0][1], cam.view[1][1], cam.view[2][1]); }
+fn rzCameraForward() -> vec3f { return vec3f(cam.view[0][2], cam.view[1][2], cam.view[2][2]); }
+/** World point → (uv, view distance), same contract as the field mounts' rzProject. */
+fn rzProject(p: vec3f) -> vec3f {
+  let clip = cam.proj * cam.view * vec4f(p, 1.0);
+  let w = max(clip.w, 1e-4);
+  return vec3f(clip.xy / w * 0.5 + 0.5, clip.w);
+}
+fn rzCamPos() -> vec3f { return cam.camPos; }
+`;
+/** `// @particles 4096` — how many live at once. */
+export function parseParticleCount(wgsl, max) {
+    const m = /^\s*\/\/\s*@particles\s+(\d+)\s*$/m.exec(wgsl);
+    if (!m)
+        return 0;
+    // Clamped rather than rejected: an author asking for a million gets the most
+    // the engine will give and a scene that still runs, which is a better failure
+    // than a compile error naming a number they had no way to know.
+    return Math.max(1, Math.min(max, parseInt(m[1], 10)));
+}
+/** `// @bloom` — opt in to the bloom pyramid. Sparks want it; rain does not. */
+export function parseParticleBloom(wgsl) {
+    return /^\s*\/\/\s*@bloom\s*$/m.test(wgsl);
+}
+/** `// @blend additive` — default is straight alpha. */
+export function parseParticleBlend(wgsl) {
+    return /^\s*\/\/\s*@blend\s+additive\s*$/m.test(wgsl) ? "additive" : "alpha";
+}
+/** Does the source define the particle contract? All three are required together. */
+export function particleEntryPoints(wgsl) {
+    return {
+        init: /\bfn\s+particleInit\s*\(/.test(wgsl),
+        step: /\bfn\s+particleStep\s*\(/.test(wgsl),
+        shade: /\bfn\s+particleShade\s*\(/.test(wgsl),
+    };
+}
+/**
+ * Spawn, age, recycle.
+ *
+ * One kernel for both birth and update, because a dead slot and a new particle
+ * are the same write — a pool that recycles has no allocation and therefore no
+ * spawn-rate bookkeeping to get wrong. The cost is that lifetimes are staggered
+ * only by whatever the author randomises in `particleInit`, which for rain and
+ * snow is exactly right, and for a burst is what the age offset is for.
+ */
+export function buildParticleComputeShader(src, cast) {
+    return (PARTICLE_STRUCT_WGSL +
+        CAMERA_STRUCT +
+        PARTICLE_UNIFORMS +
+        `
+@group(0) @binding(0) var<storage, read_write> particles: array<Particle>;
+@group(0) @binding(1) var<uniform> pu: ParticleU;
+@group(0) @binding(2) var<uniform> cam: CameraU;
+@group(0) @binding(3) var<storage, read> _rzCast: array<vec4f>;
+` +
+        castApi(cast) +
+        audioApi(0, 4) +
+        midiApi(0, 5) +
+        lyricsApi(0, 6) +
+        PRELUDE +
+        "\n// ── user effect ──\n" +
+        src.wgsl +
+        /* wgsl */ `
+@compute @workgroup_size(64)
+fn main(@builtin(global_invocation_id) gid: vec3u) {
+  let i = gid.x;
+  if (i >= pu.count) { return; }
+  var p = particles[i];
+  if (p.life <= 0.0 || p.age >= p.life) {
+    // The seed is stable per SLOT and per generation, so a particle looks the
+    // same every time the scene is replayed at the same moment — which is what
+    // keeps an exported video identical to the preview.
+    let generation = floor(pu.time * 0.37) + f32(i) * 0.618;
+    p = particleInit(i, rzHash11(generation));
+    // age is NOT reset here. WGSL zero-initialises a var, so an author who
+    // ignores it starts at zero anyway — while one who sets it to a fraction of
+    // its life staggers the pool, which is the difference between snow and a
+    // pulse of snow arriving all at once every few seconds.
+  } else {
+    p = particleStep(p, pu.dt);
+    p.age = p.age + pu.dt;
+  }
+  particles[i] = p;
+}
+`);
+}
+/**
+ * One camera-facing quad per live particle.
+ *
+ * Six vertices, no index or vertex buffer: the corners are derived from
+ * `vertex_index` and the particle is read from storage by `instance_index`, so a
+ * draw is `draw(6, count)` and there is nothing to upload per frame. The billboard
+ * basis comes from the VIEW matrix's rows rather than from a look-at, which keeps
+ * the quad square on screen no matter where the camera rolls.
+ *
+ * A dead particle collapses to a degenerate quad instead of being culled on the
+ * CPU — the alternative is a compacted draw list, which costs a prefix sum and a
+ * readback every frame to save vertices the rasteriser was going to reject anyway.
+ */
+export function buildParticleRenderShader(src, cast) {
+    return (`override BLOOM: bool = ${src.bloom ? "true" : "false"};
+override ADDITIVE: bool = ${src.blend === "additive" ? "true" : "false"};\n` +
+        PARTICLE_STRUCT_WGSL +
+        CAMERA_STRUCT +
+        PARTICLE_UNIFORMS +
+        `
+@group(0) @binding(0) var<storage, read> particles: array<Particle>;
+@group(0) @binding(1) var<uniform> pu: ParticleU;
+@group(0) @binding(2) var<uniform> cam: CameraU;
+@group(0) @binding(3) var<storage, read> _rzCast: array<vec4f>;
+` +
+        castApi(cast) +
+        audioApi(0, 4) +
+        midiApi(0, 5) +
+        lyricsApi(0, 6) +
+        PRELUDE +
+        "\n// ── user effect ──\n" +
+        src.wgsl +
+        /* wgsl */ `
+struct VSOut {
+  @builtin(position) clip: vec4f,
+  @location(0) uv: vec2f,
+  @location(1) @interpolate(flat) id: u32,
+}
+
+@vertex
+fn vs(@builtin(vertex_index) vi: u32, @builtin(instance_index) ii: u32) -> VSOut {
+  var out: VSOut;
+  out.id = ii;
+  let p = particles[ii];
+  // Two triangles, corners in the order 0,1,2, 2,1,3.
+  let quad = array<vec2f, 6>(
+    vec2f(-1.0, -1.0), vec2f(1.0, -1.0), vec2f(-1.0, 1.0),
+    vec2f(-1.0, 1.0), vec2f(1.0, -1.0), vec2f(1.0, 1.0),
+  );
+  let c = quad[vi];
+  out.uv = c * 0.5 + 0.5;
+  if (p.life <= 0.0) {
+    // Degenerate: off the near plane, rasterises nothing.
+    out.clip = vec4f(0.0, 0.0, -2.0, 1.0);
+    return out;
+  }
+  let right = vec3f(cam.view[0][0], cam.view[1][0], cam.view[2][0]);
+  let up = vec3f(cam.view[0][1], cam.view[1][1], cam.view[2][1]);
+  let s = sin(p.rot);
+  let k = cos(p.rot);
+  var r = vec2f(c.x * k - c.y * s, c.x * s + c.y * k);
+  // Stretched along the direction of travel ON SCREEN — which is not the world
+  // direction once the camera is off-axis. Rain falling straight down is nearly
+  // a point when viewed from above and a long streak from the side, and taking
+  // the velocity's components in the camera's own basis is what gets both right.
+  // Rotation is ignored while stretched: the velocity IS the orientation.
+  if (p.stretch > 1.0) {
+    let vr = dot(p.vel, right);
+    let vu = dot(p.vel, up);
+    let vlen = length(vec2f(vr, vu));
+    if (vlen > 1e-5) {
+      let d = vec2f(vr, vu) / vlen;
+      r = vec2f(d.y, -d.x) * c.x + d * (c.y * p.stretch);
+    }
+  }
+  let world = p.pos + (right * r.x + up * r.y) * p.size;
+  out.clip = cam.proj * cam.view * vec4f(world, 1.0);
+  return out;
+}
+
+struct FSOut {
+  @location(0) color: vec4f,
+  // The scene's aux target: (bloom mask, coverage). Materials write it, so a
+  // particle that skipped it would punch a hole in the mask of whatever it drew
+  // over.
+  //
+  // vec4f even though the target is rg8unorm and only .rg land: that target's
+  // blend factors reference SrcAlpha, and a fragment with no alpha channel is
+  // rejected outright — "reading alpha but it is missing from fragment output".
+  // The material shaders declare vec4f here for the same reason.
+  @location(1) mask: vec4f,
+}
+
+@fragment
+fn fs(in: VSOut) -> FSOut {
+  let p = particles[in.id];
+  let c = particleShade(p, in.uv);
+  if (c.a <= 0.0) { discard; }
+  var out: FSOut;
+  // PREMULTIPLIED: the scene's colour target blends with srcFactor \"one\", so a
+  // straight-alpha fragment would come out over-bright wherever it is
+  // translucent — which is most of a soft particle.
+  out.color = vec4f(c.rgb * c.a, c.a);
+  // The mask's OPERATOR must match the colour's, or the composite invents bands.
+  //
+  // The composite divides the HDR colour by this coverage to un-premultiply
+  // before tone mapping. An ALPHA effect writes (gate, 1.0) and lets the
+  // src-alpha blend make alpha-over coverage, exactly as the materials do. An
+  // ADDITIVE effect's pipeline blends this target with factor ONE instead, and
+  // writes its values directly — coverage SUMS like the colour does, so
+  // Σ(rgb·a)/Σa returns the true colour even where the effect overlaps itself.
+  // With summed colour over alpha-over coverage, every self-overlap divided into
+  // a bright white bar — visible only over the background, because the model's
+  // own coverage is already 1 there and the divide is a no-op. That mismatch,
+  // not geometry, was the banding that survived every geometry fix.
+  let mg = select(vec2f(select(0.0, 1.0, BLOOM), 1.0), vec2f(select(0.0, c.a, BLOOM), c.a), ADDITIVE);
+  out.mask = vec4f(mg.x, mg.y, 0.0, c.a);
+  return out;
+}
+`);
+}