@forgeax/engine-vfx-render 0.1.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,163 @@
+# @forgeax/engine-vfx-render
+
+Production RenderFeature and host for persistent GPU particle simulation and indirect billboard, mesh, ribbon, trail, and beam drawing.
+
+## Host recipe
+
+```ts
+import { createVfxRuntimeHost } from '@forgeax/engine-vfx-render';
+import { createRenderer } from '@forgeax/engine-runtime';
+
+const vfx = createVfxRuntimeHost({
+  camera: {
+    read: world => readActiveParticleCamera(world),
+  },
+  maxQueuedTicks: 8,
+});
+
+const attached = await vfx.attachWorld({ world, assets });
+if (!attached.ok) return attached;
+
+const renderer = await createRenderer(canvas, { features: [vfx.feature] });
+```
+
+Create the host before the Renderer and pass `host.feature` at Renderer
+construction. `attachWorld` installs the schema-v2 Pack loader and one
+FixedUpdate producer. `detachWorld` removes both the system and runtime
+resource. Material and mesh GUIDs resolve through the attached World's
+`AssetRegistry`.
+
+When the Registry comes from `createApp`, select
+`vfxGpuEffectContribution` in the App's `assetDecoders` option. The App and
+host share that exact GPU decoder lease; a different `particle-effect`
+decoder remains a closed owner conflict. A manually created Registry can use
+`installVfxRuntimeDecoder` before `attachWorld`.
+
+## Frame path
+
+| Stage | Work |
+|:--|:--|
+| Extract | Read camera and ordered GPU tick intents from each attached World |
+| Prepare | Reuse/create program, particle, scan, indirect, per-tick uniform, per-renderer projection, mesh, and graphics resources |
+| Contribute | Record spawn/update/scan/compact, one projection dispatch per renderer, then dependent indirect draws |
+| Recover | Drop generation-owned GPU state and restart affected runtime players |
+| Dispose | Release feature-owned state; the Renderer resolver destroys RHI resources exactly once |
+
+The generic render seam accepts persistent compute programs/buffers/bindings, external GPU vertex buffers, and indirect draw commands. Renderer code does not enumerate VFX kinds.
+
+## GPU state
+
+| Buffer | Lifetime | CPU traffic |
+|:--|:--|:--|
+| Particle state | Emitter instance | Initial clear only |
+| Alive flags, scan scratch, stable indices | Emitter instance | Initial clear only |
+| Indirect commands | Emitter instance | Static geometry fields at creation; instance count on GPU |
+| Tick uniforms | Bounded ring | One small write per fixed tick |
+| Renderer projection instances | Renderer instance | None after allocation |
+| Mesh geometry/index data | Prepared graphics cache | Initial upload |
+| Ribbon strip resources | Ribbon renderer | Initial allocation; GPU indirect count |
+| Trail history resources | Trail renderer | Initial allocation; GPU history updates |
+| Beam endpoint resources | Beam renderer | Initial allocation; GPU endpoint projection |
+
+There is no steady-state particle readback or CPU particle upload.
+Bindings retained by an attached player keep their transitive buffers alive. When a player,
+emitter, or World disappears, untouched GPU resources leave the live cache immediately and their
+buffers are destroyed only after the submitted queue work completes. Renderer recovery and dispose
+use the same owner path.
+
+## Rendering
+
+- Billboard projection uses camera right/up, particle width/height, and `size_rotation.z`; color and HDR material values are packed per renderer on GPU.
+- Mesh renderers consume the explicitly selected `MeshAsset` submesh geometry/index data and one independent projected instance stream per renderer.
+- Multiple renderers on one emitter receive independent material values and indirect command offsets.
+- A material pass named `particle-billboard` or `particle-mesh` selects that renderer's authored
+  shader module and render state. Ordinary `Forward` passes are ignored because their vertex layout
+  is not a particle projection contract; absence of a matching particle pass uses the package-owned
+  built-in shader. The render owner derives whether the selected shader consumes a group-0
+  scene-depth texture from its binding contract, so authored shaders retain their own group-0
+  layout and are not given an unrelated depth binding.
+- A custom particle material with a non-empty `parameters` schema receives the standard material
+  bind group at group 1. Numeric parameters are uploaded through the shader-schema UBO layout;
+  texture parameters resolve their authored TextureAsset and optional SamplerAsset through the
+  attached World and the renderer's shared GPU residency store. Materials with no parameters keep
+  the original group-0-only contract.
+- The renderer owns bind-group resource leases. Per-preparation material UBOs are destroyed exactly
+  once when the prepared graphics generation retires or recovers; texture and sampler residency
+  remains owned by the shared GPU resource store.
+- Billboard blend is explicit: `additive`, premultiplied `alpha`, or `opaque-cutout`.
+- Scene color/depth target formats and sample counts derive from RenderFeature targets.
+- Fixed bounds cull projection/draw before graph contribution; simulation follows the source culling policy.
+- Camera-frustum results publish through `setEmitterCameraVisibility`; session mute/isolate is a separate mask that suppresses compute and draw contribution while retaining prepared bindings as warm state. A paused player can therefore be isolated and restored without a new simulation intent or GPU-resource reallocation.
+- WGSL runtime time is the effect-relative `phaseTick`; the world-global tick remains an internal ring-selection and correlation clock. Replay and deterministic seek therefore restart shader time as well as CPU scheduling.
+
+Billboard texture sheets, pivot, soft-particle depth sampling, and sorting are
+executed from the reflected renderer contract. Ribbon, trail, and beam use
+independent resource plans and shader entry points. Parent variants and CPU
+counterparts remain outside this runtime boundary.
+
+Material texture and sampler bindings remain executable for particle materials;
+the advanced renderer fields augment that shared material path.
+
+## Runtime inspection
+
+`host.inspect(world)` returns one immutable aggregate for the attached world:
+
+| Field | Meaning |
+|:--|:--|
+| `generation` | Host attachment generation; changes when a new World realm is attached |
+| `players[]` | Keyed per-player snapshots, including every emitter rather than one latest intent |
+| `diagnostics[]` | Runtime-owned structured diagnostics for the same world |
+
+The aggregate is `undefined` for an unattached World. A freshly attached empty
+World returns an explicit empty aggregate, which lets tools distinguish “ready,
+no player” from “not attached.” Realm-local entity handles are never reused as
+cross-World identity; consumers must pair them with the host generation and
+asset GUID.
+
+`host.acquireControl(world)` is the command-side counterpart to inspection. It
+returns a generation-bound lease for replay and runtime-only emitter session
+masks, so product hosts do not reach through the public host into
+`VFX_GPU_RUNTIME_RESOURCE_KEY`. Every command revalidates the attachment
+generation, runtime resource and live `ParticleEffectPlayer`; detach,
+reattach, or player destruction therefore returns a structured
+`VfxRuntimeHostControlError` instead of mutating a stale realm. Acquire a new
+lease after any host generation change. These controls are transient runtime
+intent and do not modify authored `ParticleEffectPlayer` data.
+
+`createVfxRenderInspectSnapshot` and `topologyRecoveryHint` expose structured
+readiness and recovery evidence. Device loss or a stale generation discards the
+affected topology resources and rebuilds them from cooked reflection.
+
+## Capabilities and recovery
+
+The feature requires RHI `compute` and `indirectDrawing`. Capability absence disables registration through the standard RenderFeature capability error; it never guesses a backend by package name and never silently falls back to CPU.
+
+Expected first-use pipeline preparation may report bounded `render-feature-preparation-failed` warm-up. Persistent preparation errors, WebGPU validation errors, or any later `render-feature-stage-failed` are failures. Renderer recovery creates a fresh resource generation and invokes the feature recovery hook before rendering resumes.
+
+## Verification oracle
+
+`apps/hello/boss-lightning` is the production path:
+
+| Gate | Proof |
+|:--|:--|
+| `smoke:browser` | Dev Pack/import transport, Browser WebGPU validation, loader, runtime, camera readiness |
+| `smoke` | Dawn 300 frames, billboard and mesh pixel energy, readiness deadline, explicit recovery |
+| `smoke:falsify` | Disable-VFX, zero-emitter, missing-depth, and topology-fallback modes produce explicit structured failures |
+| `scripts/bench/vfx-batch-b.mjs` | Exact 10K/100K/1M total capacity, 30 warm-up plus 60 sampled frames, zero particle readback, and per-adapter p95 budget |
+
+```sh
+pnpm --filter @forgeax/hello-boss-lightning smoke:browser
+pnpm --filter @forgeax/hello-boss-lightning smoke
+pnpm --filter @forgeax/hello-boss-lightning smoke:falsify
+node apps/hello/boss-lightning/scripts/smoke-public-only.mjs
+node scripts/bench/vfx-batch-b.mjs
+```
+
+The hardware product target is p95 <= 33.34 ms. CI's forced lavapipe adapter is
+a software correctness reference, not evidence of hardware GPU throughput, so
+its p95 is recorded but is not treated as an FPS gate. Reports include
+`adapterClass`, `performanceGated`, the hardware target, and
+`allocatedCapacity`. A hardware run must satisfy the target, and every tier
+must allocate exactly the declared total capacity.
+
+Null/backend unit tests prove graph and resource structure; they do not replace Browser or Dawn execution.