@solidrt/3d 0.0.46 → 0.0.47

package/AGENTS.md

@@ -12,9 +12,9 @@ blendMode and pointer events like any element. Design rationale:
 - Two layers. The imperative core is Solid-free: `createScene`,
   `createMesh(geometry, material)`, `add`/`remove`, `setTransform`,
   `setVisible` - plain objects with dirty flags, batched to a microtask,
-  one `setDrawParams` (the uModel matrix) per changed mesh and ONE
-  `setTargetParams` (the shared uViewProj) per camera change, however many
-  meshes. The component
+  one `setDrawParams` (uModel, plus uNormal for materials declaring it)
+  per changed mesh and ONE `setTargetParams` (the shared uViewProj +
+  uCamPos) per camera change, however many meshes. The component
   face (`Scene`/`Group`/`Mesh`/`PerspectiveCamera`) syncs props into that
   core over context and renders nothing itself.
 - Rendering is the runtime's. The target is `render: "auto"`: it
@@ -23,9 +23,23 @@ blendMode and pointer events like any element. Design rationale:
   own `onFrame` writing a signal (declarative) or `setTransform` on a
   `ref`-grabbed node (the frame-rate escape hatch - signals carry
   structure, per-frame motion goes straight to the scene).
-- One vertex layout everywhere: `aPos` vec3 + `aNormal` vec3 + `aUV` vec2,
-  uint16-indexed. Geometry GPU buffers are lazy, shared, and app-lifetime
-  (owner-scoped free would break sharing); `disposeGeometry` frees them.
+- Two named vertex layouts (`Geometry.layout`, absent = "standard"):
+  "standard" is `aPos` vec3 + `aNormal` vec3 + `aUV` vec2 - what every
+  generator emits - and "colored" appends `aColor` vec4, the per-vertex
+  data channel (a tint, baked AO, any four scalars; standard name, your
+  contents). Derive colored geometry with `withColors(geometry, fill)` -
+  fill is a flat 4-per-vertex array or a per-vertex callback receiving
+  `(index, pos, normal, uv)`. Geometry and material layouts must match
+  (layout is stride); a mismatched pair throws at add(). The whole layout
+  ships whether a material reads every attribute or not (inactive
+  attributes only keep the stride), so colored vertices cost 12 floats
+  regardless - keep data-light passes (a wireframe reading only aPos) on
+  standard geometry.
+  Indices are uint16 or uint32 - the `Geometry.indices` array type picks
+  the draw's index format, so hand-built geometry past 64k vertices just
+  uses a Uint32Array (generators emit uint16). Geometry GPU buffers are
+  lazy, shared, and app-lifetime (owner-scoped free would break sharing);
+  `disposeGeometry` frees them.
 - Materials dedupe hard: one program + one pipeline per material CLASS
   (unlit color, unlit map), `depth: true` + `cull: "back"`; an instance is
   just per-entry uniforms (`uColor`) and bindings (`uMap`).
@@ -34,42 +48,131 @@ blendMode and pointer events like any element. Design rationale:
 
 | Component | Props |
 | --- | --- |
-| `Scene` | `width`, `height` (target pixels), `clearColor?`, `label?`, `ref?(scene)` |
+| `Scene` | `width`, `height` (target pixels), `clearColor?`, `label?`, `ref?(scene)`, `output?(texture)` |
 | `Group` | `position?`, `rotation?` (Euler radians, x-y-z order), `scale?` (number = uniform), `visible?`, `ref?(node)` |
 | `Mesh` | `geometry`, `material`, transforms as Group, `ref?(mesh)` |
 | `PerspectiveCamera` | `fov?` (vertical DEGREES, default 60), `near?`, `far?`, `position?`, `lookAt?`, `up?` |
 
+Output composition: without `output`, `Scene` emits a minimal
+`<texture width height>` leaf and nothing else is forwarded - anything
+more goes through `output(texture)`, which renders in place of that leaf:
+a `<d-texture>`, a leaf with blendMode/fit/pointer/layout props, or a
+post-effect chain (`createShaderTarget` sampling the id with a
+covering-triangle pass; created in the callback it disposes with the
+Scene). Return null for no leaf at all and compose `scene.texture`
+elsewhere. Called once, untracked, inside the scene context. Scene
+`width`/`height` are target pixels and the leaf's own width/height are
+layout, so render and display size separate - render at 2x and display
+smaller for supersampling.
+
 Camera control: `createOrbitCamera(scene, { target?, azimuth?, elevation?,
 distance?, min/maxDistance?, min/maxElevation?, orbitSpeed?, rotateSpeed?,
-zoomSpeed? })` - drag-to-rotate, wheel-to-zoom, optional auto-orbit. Spread
+zoomSpeed?, zoomAnchor?, rotateAnchor?, panSpeed?, viewport?, clampTarget? })`
+- drag-to-rotate, pinch- and wheel-to-zoom, two-finger pan, optional
+auto-orbit. Input runs on core's `createTransform` recognizer, so drag and
+pinch arbitrate in the app-wide gesture arena (a viewport inside a scroller
+does not double-handle) and rotation starts after the recognizer's slop;
+`zoomSpeed` weights both wheel and pinch. Two-finger translation pans (the
+scene tracks the fingers 1:1 at target depth, weighted by `panSpeed`) when
+`viewport()` supplies `{ height, fov }` for the pixel-to-world mapping -
+without it, it rotates like one finger; `clampTarget(target)` bounds where
+a pan may put the pivot. Zoom aims
+at the target unless `zoomAnchor(x, y, {eye, target})` maps the pinch focal
+/ wheel cursor to a world point (ground hit, target-depth plane, ...) - then
+that point stays pinned under the pointer and the target slides toward it;
+only the app can build that mapping, since fov, aspect and element placement
+are app state. Pair it with `rotateAnchor({eye, target})`: called at gesture
+start, its point is projected onto the view axis and re-seats the pivot
+without moving the picture, so a drag after an anchored zoom orbits what the
+camera looks at, not wherever the zoom left the target. Spread
 `orbit.handlers` onto the input-owning element, call `orbit.update(dt)`
 from your onFrame (no frame loop of its own), and use its return - true
-when the pose changed - to gate per-frame dependents like a `uCamPos`
-write. `orbiting()` is reactive (HUD-safe); the pose is plain state via
+when the pose changed - to gate per-frame dependents like reprojecting
+HUD overlays. `orbiting()` is reactive (HUD-safe); the pose is plain state via
 `pose()`/`set()` (also the debug-command shape). It drives position and
 target only; fov/near/far stay on scene.setCamera. In a component tree,
 reach the scene via `<Scene ref>` or useScene().
 
-Geometry: `box(w?, h?, d?)`, `plane(w?, h?)` (XY, faces +z - rotate
-`[-Math.PI/2, 0, 0]` for a floor), `sphere(radius?, wSeg?, hSeg?)`,
-`torusKnot(radius?, tube?, tubularSeg?, radialSeg?, p?, q?)` (standing
-y-up, unlike Three's z-up).
+Overlay projection: `scene.project(point)` maps a world point to scene
+pixels (top-left origin, y down - the output texture's own space; `w` is
+clip-space w, the camera-forward distance) and returns null for a point
+at or behind the camera plane. It reflects a pending `setCamera`
+immediately, so set-then-project in one tick is exact. `scene.viewProj(out?)`
+copies the view-projection matrix for batch work. Never rebuild the
+camera matrices by hand for a HUD.
+
+Geometry: `box(w?, h?, d?)`; `plane(w?, h?)`, `circle(radius?, seg?)` and
+`ring(inner?, outer?, seg?)` (XY, facing +z - rotate `[-Math.PI/2, 0, 0]`
+for a floor); `sphere(radius?, wSeg?, hSeg?)`;
+`cylinder(rTop?, rBottom?, height?, radialSeg?)` (y axis, capped; unequal
+radii taper it) and `cone(radius?, height?, radialSeg?)`;
+`torus(radius?, tube?, radialSeg?, tubularSeg?)` (lying flat, hole on the
+y axis) and `torusKnot(radius?, tube?, tubularSeg?, radialSeg?, p?, q?)`
+(standing y-up) - both oriented for the y-up world, unlike Three's z-up.
+`withColors(geometry, fill, label?)` derives a "colored"-layout copy of
+any standard-layout geometry (generator or hand-built), adding the
+`aColor` vec4 channel; the source is untouched.
+`fillColors(vertices, fill, first?, count?)` is the in-place primitive
+under it: writes the aColor slots of a colored-layout interleave you
+already own (a merging builder's packed buffer), reading pos/normal/uv
+from the buffer itself - so a packer that bakes transforms while writing
+hands the baker world-space vertices. `fill` indexes relative to
+`first`. It trusts the buffer's layout (no tag to check); withColors is
+the checked path.
+
+Profile kit (2D outlines to solids, real texture UVs): a `Profile` is a
+closed XY polygon, bare `[x, y]` points crease, `{ p, smooth }` points
+share an averaged normal - `fillet(points, radius, segs?)` and
+`roundRect(w?, h?, radius?, segs?)` emit those (arc corners smooth).
+Winding is normalized, so either authoring direction works.
+`extrude(profile, depth?, bevel?, bevelSegs?)` sweeps along z, centered,
+with a quarter-round bevel at both rims; `lathe(profile, segs?, angle?,
+start?)` revolves a CLOSED (x = radius, y = height) profile about the y
+axis - watertight by construction, flat caps on partial sweeps;
+`shape(profile)` fills one flat (facing +z, like circle);
+`triangulate(points)` is the ear-clipping core (fan fallback, never drops
+a cap), exported for custom flat work. These pick uint16/uint32 indices
+by vertex count automatically.
+
 Materials:
 
 - `unlit({ color?, map? })` - straight `[r, g, b, a?]` 0..1, premultiplied
   internally.
 - `shaderMaterial({ vertex, fragment, params?, textures?, depth?,
   depthWrite?, blend?, cull?, topology?, label? })` - your own GLSL, the
-  custom-look escape hatch. The vertex stage MUST declare and use BOTH
-  `uniform mat4 uModel` (the mesh's world matrix, per entry) and
-  `uniform mat4 uViewProj` (the camera, shared target-level params) -
-  transform with `uViewProj * uModel * vec4(aPos, 1.0)`; attributes come
-  from the shared layout by name; sources without
-  `#version` get the standard pipeline preamble. App-driven uniforms
-  beyond uModel/uViewProj: seed via `params`, then write per mesh with
+  custom-look escape hatch. The STANDARD UNIFORM SET: the vertex stage
+  MUST declare and use `uniform mat4 uModel` (the mesh's world matrix,
+  per entry) and `uniform mat4 uViewProj` (the camera, shared
+  target-level params) - transform with
+  `uViewProj * uModel * vec4(aPos, 1.0)`; a source missing either throws
+  at shaderMaterial() creation. The rest is opt-in by declare-and-use:
+  `uniform vec3 uCamPos` (the camera's world position, shared and written
+  with uViewProj - the specular/fresnel view vector is
+  `normalize(uCamPos - worldPos)`) and `uniform mat4 uNormal` (the world
+  inverse-transpose, written beside uModel for this material's meshes;
+  take `mat3(uNormal)` - correct under non-uniform scale, where
+  mat3(uModel) bends normals off the surface). Attributes come from the
+  geometry's layout by name; a vertex stage reading `in vec4 aColor` opts
+  the material into the "colored" layout, and its meshes then need
+  `withColors()` geometry. Sources without `#version` get the standard
+  pipeline preamble. App-driven uniforms beyond the standard set: seed
+  via `params`, then write per mesh with
   `setMeshParams(mesh, { name: value })` (validated names; values persist
   across entry rebuilds; frame-rate-safe like setTransform).
 
+Lighting GLSL (`@solidrt/3d/glsl`): exported string constants composed
+into shaderMaterial sources with plain template literals - `LIT_VERTEX`
+(the standard vertex stage: clip position plus vWorldPos/vNormal/vUv
+varyings, normals via mat3(uNormal)), `LIT_VERTEX_COLORED` (the same
+plus the colored layout's aColor forwarded raw as vColor - using it opts
+the material into that layout) and the pure functions `HEMISPHERE`
+(`hemisphere(n, sky, ground)`), `LAMBERT` (`lambert(n, l)`),
+`BLINN_SPECULAR` (`blinnSpecular(n, v, l, shininess)`), `FRESNEL`
+(`fresnel(n, v, power)`). Lights, colors and exponents are arguments, so
+nothing is pinned but the function names; future lit material classes
+compose from these same constants - customizing never means leaving the
+system.
+
 ## Traps
 
 - The y-down clip flip is baked into `perspective()`; scene code and
@@ -87,13 +190,18 @@ Materials:
   v1.
 - Transforms have ONE write path: `setTransform`/`setVisible` (or the
   props that call them). Mutating `node.position` directly does not sync.
-- A camera change is ONE `setTargetParams` write (uViewProj is target
-  state), independent of mesh count - never reintroduce per-mesh camera
-  writes. Scene scale honestly: hundreds to a
+- A camera change is ONE `setTargetParams` write (uViewProj + uCamPos are
+  target state), independent of mesh count - never reintroduce per-mesh
+  camera writes (uEye-style per-mesh params are exactly the O(scene) cost
+  the shared channel removed). Scene scale honestly: hundreds to a
   few thousand objects, bounded by the interpreter, not the GPU.
 - Entry rebuild order: `setGeometry`/`setMaterial` re-add the entry at the
   list END. Irrelevant while everything is opaque + depth-tested; revisit
   when transparency lands.
+- `lathe` takes a CLOSED profile (a cross-section with thickness, or run
+  to the axis at x = 0) - it is a solid of revolution, NOT Three's open
+  polyline shell. An "open" outline must be closed by the author;
+  otherwise the shape is simply wrong, there is no open-profile mode.
 - `useScene()`/`Group`/`Mesh` throw outside `<Scene>` (default-less
   context).
 - A `shaderMaterial` INSTANCE is the pipeline handle: identical sources
@@ -101,14 +209,16 @@ Materials:
   content-keyed caches are the anti-pattern the GPU layer avoids). Create
   one per look at app scope, share across meshes, `dispose()` when done
   for good.
-- A shaderMaterial vertex stage without `uniform mat4 uModel` (declared
-  AND used) throws at mesh attach - the scene seeds uModel on every entry
-  and the engine rejects unknown uniform names. One without `uViewProj`
-  also throws at attach when it is the scene's ONLY material class: after
-  the first camera sync, _attach re-issues the shared uViewProj (same
-  value, one write) so the coverage error lands at add() instead of
-  inside a later camera-sync microtask. Only the very first attach (no
-  camera sync yet) reports it asynchronously, from the sync that attach
-  schedules. With other declaring materials present it silently ignores
-  the camera instead (partial coverage is legal). Declare and use both,
-  always.
+- The standard-set contract is checked TEXTUALLY at shaderMaterial()
+  creation (uModel and uViewProj must appear in the vertex source) and
+  strictly at add() for the per-entry names: a uModel or uNormal that is
+  declared but never USED compiles out, and the scene's entry seed then
+  throws at attach (the engine rejects unknown entry uniform names). The
+  shared names have no such backstop - a declared-but-unused uViewProj or
+  uCamPos is skipped silently (shared params tolerate zero coverage), so
+  the symptom is an untransformed or unlit render, not an error. Use what
+  you declare.
+- The layout scan is textual the same way: any `aColor` token in the
+  vertex source - a comment counts - selects the "colored" layout, and
+  the material then rejects standard geometry at add(). Do not mention
+  aColor you do not read.

package/README.md

@@ -4,6 +4,8 @@ A retained 3D scene graph for SolidRT: meshes, materials and a camera,
 declared as Solid components, rendered by the runtime into an ordinary
 texture in your UI tree.
 
+_@solidrt/3d is experimental: expect more API churn here than in the rest of SolidRT._
+
 ```tsx
 import { createSignal, onFrame, render } from "@solidrt/core"
 import { box, Mesh, PerspectiveCamera, Scene, unlit } from "@solidrt/3d"
@@ -27,16 +29,31 @@ The scene compiles to one depth-buffered GPU draw target: one draw entry
 per mesh, one shared pipeline per material class, cross-mesh occlusion
 from the shared depth buffer. A static scene costs zero GPU passes - the
 runtime re-renders the target only when something changes - and a moved
-mesh costs one uniform write.
+mesh costs one uniform write. By default `<Scene>` composites the target
+as a plain `<texture>` leaf; the `output` prop receives the texture id
+and replaces that leaf - place a `<d-texture>`, add paint or pointer
+props, chain a post-effect shader target, or return null and composite
+`scene.texture` yourself.
 
 There is also an imperative layer underneath (`createScene`, `createMesh`,
 `setTransform`, ...) usable without components, plus a small math module
-(`@solidrt/3d/math`: column-major mat4, perspective, lookAt).
+(`@solidrt/3d/math`: column-major mat4, perspective, lookAt). For HUD
+overlays, `scene.project(point)` maps a world point to scene pixels.
+Custom materials get a standard uniform set - per-mesh `uModel`/`uNormal`,
+shared `uViewProj`/`uCamPos`, each written once per change - and
+`@solidrt/3d/glsl` exports the lighting pieces (hemisphere, lambert,
+blinn, fresnel, a standard vertex stage) to compose your own lit looks
+from plain template literals.
 
 v1 scope: unlit color/textured materials plus `shaderMaterial` (your own
-GLSL as a first-class material), box/plane/sphere geometry, one
-perspective camera with an orbit control (`createOrbitCamera`: drag,
-zoom, auto-orbit). Lights, transparency, model loading and picking are
+GLSL as a first-class material), geometry generators (box, plane, circle,
+ring, sphere, cylinder, cone, torus, torus knot), a profile kit for custom
+solids (`extrude` with bevels, `lathe`, flat `shape`, with `fillet`/
+`roundRect`/`triangulate` helpers), a per-vertex data channel
+(`withColors` adds an `aColor` vec4 - tint, baked AO, any four scalars -
+to any geometry, for materials that read it), one perspective camera
+with an orbit control (`createOrbitCamera`: drag, pinch/wheel zoom, auto-orbit).
+Lights, transparency, model loading and picking are
 staged next - see `okf/research/scene-graph-3d.md` for the roadmap. Full
 usage notes and traps: [AGENTS.md](AGENTS.md); runnable examples:
 [examples/](examples/).

package/examples/scene-post-effect.tsx

@@ -0,0 +1,82 @@
+// The `output` prop: Scene hands you its texture id and you compose the
+// leaf yourself, in place of the built-in `<texture>`. Here a fragment
+// pass samples the scene and adds chromatic aberration plus a vignette,
+// and the scene renders at 2x display size - the post pass doubles as the
+// downsample (the default linear sampler box-averages the 2x2 quad), so
+// the same chain is also free supersampling. Sampled textures are live
+// dependencies: the post pass re-renders exactly when the scene target
+// does, and a static scene still costs zero passes.
+//
+// The same slot takes a `<d-texture>`, a leaf with blendMode/fit/pointer
+// props, or `() => null` (headless - composite scene.texture elsewhere).
+import { createSignal, onFrame, pct, render } from "@solidrt/core"
+import { createShaderTexture } from "@solidrt/core/gpu"
+import { box, Group, Mesh, PerspectiveCamera, plane, Scene, sphere, unlit } from "@solidrt/3d"
+
+const SIZE = 720 // display pixels (the leaf)
+const RENDER = SIZE * 2 // target pixels (the scene)
+
+// vUV, iResolution, and fragColor come from the standard shader-texture
+// preamble; uSource is bound via the `textures` option.
+const POST = `
+  uniform sampler2D uSource;
+  void main() {
+    vec2 c = vUV - 0.5;
+    float r2 = dot(c, c);
+    // Chromatic aberration: red and blue sample at slightly shifted radii.
+    vec2 shift = c * r2 * 0.04;
+    vec3 col = vec3(
+      texture(uSource, vUV + shift).r,
+      texture(uSource, vUV).g,
+      texture(uSource, vUV - shift).b);
+    // Vignette.
+    col *= 1.0 - 1.1 * r2;
+    fragColor = vec4(col, 1.0);
+  }`
+
+function App() {
+  let [spin, setSpin] = createSignal(0)
+  onFrame(tick => setSpin(tick / 2000))
+
+  let cube = box()
+  let floor = plane(6, 6, "floor")
+  let ball = sphere(0.35)
+
+  return (
+    <window>
+      <view width={pct(100)} height={pct(100)} viewBox={[SIZE, SIZE]}>
+        <Scene
+          width={RENDER}
+          height={RENDER}
+          clearColor={[0.07, 0.07, 0.1, 1]}
+          label="scene-post"
+          output={tex => {
+            // Created inside the callback, the post target disposes with
+            // the Scene.
+            let post = createShaderTexture(POST, SIZE, SIZE, null, { textures: { uSource: tex } })
+            return <texture src={post} width={SIZE} height={SIZE} />
+          }}
+        >
+          <PerspectiveCamera fov={55} position={[0, 1.6, 3.6]} lookAt={[0, 0.3, 0]} />
+          <Mesh
+            geometry={floor}
+            material={unlit({ color: [0.16, 0.17, 0.22] })}
+            rotation={[-Math.PI / 2, 0, 0]}
+          />
+          <Group rotation={[0, spin(), 0]}>
+            <Mesh geometry={cube} material={unlit({ color: [0.85, 0.3, 0.3] })} position={[0, 0.5, 0]} />
+            <Mesh
+              geometry={cube}
+              material={unlit({ color: [0.9, 0.8, 0.35] })}
+              position={[-1.1, 0.7, 0]}
+              scale={[0.5, 1.4, 0.5]}
+            />
+            <Mesh geometry={ball} material={unlit({ color: [0.35, 0.65, 0.9] })} position={[1.1, 0.35, 0]} />
+          </Group>
+        </Scene>
+      </view>
+    </window>
+  )
+}
+
+render(() => <App />)

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@solidrt/3d",
-  "version": "0.0.46",
+  "version": "0.0.47",
   "license": "MIT",
   "author": "Antoine van Wel",
   "type": "module",
   "main": "src/index.ts",
   "exports": {
     ".": "./src/index.ts",
-    "./math": "./src/math.ts"
+    "./math": "./src/math.ts",
+    "./glsl": "./src/glsl.ts"
   },
   "files": [
     "src/",
@@ -16,6 +17,6 @@
   ],
   "peerDependencies": {
     "@solidjs/signals": "2.0.0-beta.31",
-    "@solidrt/core": "0.0.46"
+    "@solidrt/core": "0.0.47"
   }
 }

package/src/components.tsx

@@ -7,7 +7,7 @@
 // structure and slow state, per-frame motion goes straight to the scene.
 
 import { createContext, createEffect, onCleanup, untrack, useContext } from "@solidrt/core"
-import type { ParentComponent, VoidComponent } from "@solidrt/core"
+import type { Element, ParentComponent, TextureId, VoidComponent } from "@solidrt/core"
 import {
   add,
   createGroup,
@@ -54,18 +54,29 @@ function syncNode(node: SceneNode, props: TransformProps): void {
 }
 
 export type SceneProps = {
+  /** Target pixels. With `output`, the leaf's own width/height are layout,
+   * so render size and display size separate (supersampling). */
   width: number
   height: number
   clearColor?: [number, number, number, number]
   label?: string
   ref?: (scene: SceneHandle) => void
+  /**
+   * Compose the output yourself: called once (untracked) with the scene's
+   * texture id, and its return renders in place of the built-in `<texture>`
+   * leaf - a `<d-texture>`, a leaf carrying paint/pointer/layout props, or
+   * a post-effect chain (a shader target sampling the id; created in the
+   * callback it disposes with the Scene). Return null to render no leaf.
+   */
+  output?: (texture: TextureId) => Element
 }
 
 /**
  * Owns a draw target and composites it as an ordinary `<texture>` leaf, so
  * the output takes layout, transforms, blendMode, and pointer events like
- * any element. Children (Mesh/Group/PerspectiveCamera) render nothing
- * themselves - they populate the retained scene through context.
+ * any element - or hand `output` the texture id and compose it yourself.
+ * Children (Mesh/Group/PerspectiveCamera) render nothing themselves - they
+ * populate the retained scene through context.
  */
 export let Scene: ParentComponent<SceneProps> = props => {
   let scene = untrack(() =>
@@ -76,9 +87,14 @@ export let Scene: ParentComponent<SceneProps> = props => {
     ([w, h]) => scene.setSize(w, h),
   )
   untrack(() => props.ref)?.(scene)
+  let output = untrack(() => props.output)
   return (
     <SceneContext value={{ scene, parent: scene.root }}>
-      <texture src={scene.texture} width={props.width} height={props.height} />
+      {output ? (
+        untrack(() => output(scene.texture))
+      ) : (
+        <texture src={scene.texture} width={props.width} height={props.height} />
+      )}
       {props.children}
     </SceneContext>
   )