@forgeax/engine-vfx 0.0.0-dev.8d955ade1c79

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,214 @@
+# @forgeax/engine-vfx
+
+Runtime-safe contract for code-first GPU particle effects. Authors write emitter metadata plus two WGSL functions; the engine owns allocation, scheduling, compaction, indirect drawing, recovery, and asset transport.
+
+> [!IMPORTANT]
+> Particle behavior is code, not an operator or node graph. Runtime players consume cooked programs and never compile WGSL.
+
+## Ownership
+
+The machine-readable asset boundary is
+[`asset-authority.schema.json`](../../asset-authority.schema.json). Author source
+and its WGSL module are authoritative; native cook produces the Pack payload and
+asset-local program artifact, while Catalog and runtime state are derived
+projections. Lifecycle evidence therefore runs from source validation through a
+successful cook receipt and runtime fingerprint check. A stale or missing
+artifact must be cold-cooked instead of being treated as current.
+
+| Package | Owns |
+|:--|:--|
+| `@forgeax/engine-vfx` | Source validation, cooked asset loading, `ParticleEffectPlayer`, FixedUpdate intents, deterministic spawn scheduling |
+| `@forgeax/engine-vfx-compiler` | WGSL composition, import resolution, Naga validation, reflection, deterministic cook |
+| `@forgeax/engine-vfx-render` | Persistent GPU state, compute passes, fixed-bounds culling, billboard/mesh projection, indirect draws |
+
+## Author source
+
+```ts
+import { defineParticleEffectSourceV2 } from '@forgeax/engine-vfx';
+
+export const sparks = defineParticleEffectSourceV2({
+  schemaVersion: 2,
+  emitters: [{
+    id: 'sparks',
+    capacity: 100_000,
+    backend: { required: 'gpu' },
+    space: 'world',
+    bounds: { kind: 'sphere', center: [0, 0, 0], radius: 12 },
+    schedule: { rate: 20_000, bursts: [{ time: 0, count: 2_000 }] },
+    program: { module: 'sparks.vfx.wgsl' },
+    renderers: [{ kind: 'billboard', material: SPARK_MATERIAL, blend: 'additive' }],
+    simulationWhenCulled: 'continue',
+  }],
+});
+```
+
+The parser rejects unknown fields. This Batch A slice is GPU-only and requires
+`backend: { required: 'gpu' }`; missing GPU capability fails structurally rather
+than selecting a hidden backend. CPU fallback, runtime compilation, raw author
+bindings, and CPU particle mirrors are not accepted. Batch B renderer metadata is
+executable: billboard advanced fields, ribbon strips, trail history, and beam
+endpoints each produce reflected resources and an indirect topology draw.
+
+New authoring tools may use `PARTICLE_CODE_DEFAULT_MODULE_ID` as an immediately
+cookable seed. The compiler owns that minimal WGSL module; advanced effects name
+game-authored `.vfx.wgsl` modules and remain code-first.
+
+A mesh renderer selects exactly one draw surface with `submesh` (default `0`):
+`{ kind: 'mesh', mesh, material, submesh: 2 }`. An out-of-range index fails
+preparation instead of silently drawing another submesh.
+
+## Batch B renderers and control
+
+```ts
+renderers: [
+  {
+    kind: 'billboard', material: SPARK_MATERIAL, blend: 'additive',
+    capacity: 4096, overflow: 'drop-oldest',
+    textureSheet: { columns: 4, rows: 4, frameRate: 12 },
+    pivot: [0.5, 0.25], softParticle: { distance: 0.4 }, sorting: 'back-to-front',
+  },
+  { kind: 'ribbon', stripKey: 'alive-index', capacity: 1024, overflow: 'drop-newest', width: 0.2 },
+  { kind: 'trail', historyLength: 8, capacity: 1024, overflow: 'drop-oldest', width: 0.15 },
+  { kind: 'beam', endpointField: 'velocity', capacity: 256, overflow: 'drop-newest', width: 0.08 },
+]
+```
+
+`ribbon`, `trail`, and `beam` have independent capacities, resource plans,
+shader entry points, and indirect draws. A renderer is never silently changed to
+a billboard. `textureSheet`, `pivot`, `softParticle`, and `sorting` are reflected
+into the billboard GPU path; soft particles require the explicitly registered
+scene-depth provider. Capacity overflow is reported through inspection.
+
+## Author WGSL
+
+```wgsl
+#import forgeax_vfx::prelude::{
+  VfxParticle,
+  VfxSpawnContext,
+  VfxUpdateContext,
+  vfx_integrate,
+  vfx_random_spawn,
+}
+
+fn vfx_spawn(ctx: VfxSpawnContext, particle: ptr<function, VfxParticle>) {
+  let angle = vfx_random_spawn(ctx, 0u) * 6.2831853;
+  (*particle).velocity = vec4<f32>(cos(angle), 2.0, sin(angle), 0.0);
+  (*particle).lifetime = 1.5;
+}
+
+fn vfx_update(ctx: VfxUpdateContext, particle: ptr<function, VfxParticle>) {
+  (*particle).velocity.y -= 9.8 * ctx.delta;
+  (*particle).size_rotation.z += ctx.delta * 2.0;
+  vfx_integrate(ctx, particle);
+}
+```
+
+The managed shell exposes this stable particle surface:
+
+| Field | Meaning |
+|:--|:--|
+| `position.xyz` | Emitter-local or world position; `.w` is available to author code |
+| `velocity.xyz` | Velocity used by `vfx_integrate`; `.w` is available to author code |
+| `color` | Linear HDR color and alpha |
+| `size_rotation.xy` | Billboard width/height; mesh uses `.x` as uniform scale |
+| `size_rotation.z` | Rotation in radians |
+| `age`, `lifetime` | Engine advances age and kills at `age >= lifetime` |
+| `alive` | Set to `0u` for explicit death |
+| `id` | Stable spawn identity for addressable random |
+
+Author modules must define exactly `vfx_spawn` and `vfx_update`. They must not declare shader stages, bind groups, bindings, or `forgeax_vfx_*` symbols. Reuse behavior with ordinary shader `#import`; imports are composed and validated at cook time.
+
+## Load and play
+
+```ts
+import { loadVfxGpuEffect, ParticleEffectPlayer } from '@forgeax/engine-vfx';
+
+const loaded = await loadVfxGpuEffect(assets, EFFECT_GUID);
+if (!loaded.ok) return loaded;
+
+const effect = world.allocSharedRef('ParticleEffectAsset', loaded.value);
+world.spawn({
+  component: ParticleEffectPlayer,
+  data: { effect, playing: true, seed: 42, timeScale: 1 },
+});
+```
+
+Install `createVfxRuntimeHost` from `@forgeax/engine-vfx-render`, attach each World once, and register `host.feature` with the Renderer. The host installs the loader and FixedUpdate intent producer.
+
+## Authoring projection
+
+Runtime-safe tools can inspect the cooked effect without importing the build-time
+compiler or duplicating renderer schemas:
+
+```ts
+import {
+  describeVfxGpuEffect,
+  isVfxGpuEffectAsset,
+} from '@forgeax/engine-vfx';
+
+const payload = assets.lookup(EFFECT_GUID);
+if (!isVfxGpuEffectAsset(payload)) return;
+
+const descriptor = describeVfxGpuEffect(payload);
+// descriptor.emitters: stable tree of program/stage/channel/event/renderer nodes
+// descriptor.timeline: rate, bursts and loop duration by emitter
+// descriptor.dependencies: module, asset and data-interface identities
+// descriptor.capabilities: executable / partial / unavailable truth
+```
+
+The descriptor is immutable, UI-neutral and versioned. It preserves the authored
+WGSL module ID in each cooked emitter, but intentionally omits WGSL bytes and
+compiler objects. `isVfxGpuEffectAsset` owns the stable cooked discriminator at
+the producer boundary; detailed artifact validation remains the Pack loader's
+responsibility.
+
+> [!IMPORTANT]
+> The descriptor is an inspection/read-model contract, not a second authoring
+> language. Source v2 plus `.vfx.wgsl` remain authoritative.
+
+## Runtime invariants
+
+- FixedUpdate is the only simulation clock; render frames consume ordered tick intents.
+- GPU particle buffers remain persistent and are never read back for ordinary simulation or drawing.
+- Time-zero bursts fire once per play cycle. Rate remainder and particle IDs survive frame-rate variation.
+- `vfx_random_spawn` and `vfx_random_update` are addressable by seed, particle ID, tick, and sample key.
+- Cold GPU preparation stalls effect time within the bounded queue. Post-start overflow reports `vfx-intent-queue-overflow`; ticks are not silently discarded.
+- Seed/effect changes and stop-to-play transitions restart the player at a fixed boundary.
+- `phaseTick` is effect-relative and resets to zero on replay or `restart-on-visible`; the existing `tick` remains the World-global FixedTime correlation key.
+- `replay(player)` advances an authored stopped player for exactly one FixedUpdate and never creates a second persistent play-state authority.
+
+`VfxGpuRuntime.inspectPlayers()` and `inspectPlayer(player)` expose stable keyed
+snapshots for every attached player and emitter. They report the asset GUID,
+program/layout fingerprints, parameter generation, pending patch count, channel
+counters, `cameraVisible`, `sessionEnabled`, phase/global ticks, schedule, bounds, renderer/stage metadata and the latest
+committed tick intent per emitter. Observation never selects a single global
+“latest intent,” so two players and multi-emitter effects remain distinguishable.
+
+## Culling policy
+
+| `simulationWhenCulled` | Hidden behavior | Visible transition |
+|:--|:--|:--|
+| `continue` | Simulate without projection or draw | Draw current state |
+| `pause` | Freeze simulation and effect time | Resume frozen state |
+| `restart-on-visible` | Freeze while hidden | Reset before drawing again |
+
+Bounds are required and conservatively tested against the camera frustum. Local-space bounds use the player's world transform and maximum axis scale.
+
+Camera culling and editor preview masking are independent runtime axes:
+
+- `setEmitterCameraVisibility` is renderer-owned frustum evidence and applies the authored culling policy.
+- `setEmitterSessionEnabled` is a non-authored preview mask used for mute/isolate. Disabled emitters neither simulate nor render retained output.
+- Neither API changes a cooked renderer's authored `enabled` field.
+
+## Structured recovery
+
+| Code | Repair |
+|:--|:--|
+| `vfx-source-version-unsupported` | Migrate behavior to WGSL and cold-cook schema v2 |
+| `vfx-source-invalid` | Repair `detail.path`; unknown and unsupported fields fail closed |
+| `vfx-asset-v2-program-missing` | Republish the asset-local `particle-effect/program.json` artifact |
+| `vfx-asset-v2-fingerprint-mismatch` | Cold-cook payload and program atomically |
+| `vfx-effect-unavailable` | Load the shared effect before the first FixedUpdate |
+| `vfx-intent-queue-overflow` | Recover the Renderer or restart the player; inspect render readiness |
+
+Device recovery discards the old render generation, clears VFX GPU state, and restarts players from source inputs. No stale handle or CPU particle mirror survives recovery.