@forgeax/engine-runtime 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,183 @@
+# `@forgeax/engine-runtime`
+
+> [!IMPORTANT]
+> Runtime is the sole public host-assembly entry for `createRenderer`. It selects browser/backend services, invokes render's internal construction seam, and cleans up partial construction. It does not own scene, skinning, animation, or render-domain APIs.
+
+## Assemble producer features
+
+`createRenderer(..., { membershipTiming })` forwards the Render-owned timing
+option without interpreting it. Runtime does not add a generic profiler or a
+second reason vocabulary. Capability refusal, timestamp capture, recovery
+fencing, and terminal records remain Render and RHI responsibilities.
+
+The host receives a heterogeneous list of producer-owned
+`RenderFeature<FrameData>` values through one `createRenderer` options bag.
+Import the feature contract and render vocabulary from
+`@forgeax/engine-render`; import only assembly from this package.
+
+```ts
+import { ok } from '@forgeax/engine-types';
+import type { RenderFeature } from '@forgeax/engine-render';
+import { createRenderer } from '@forgeax/engine-runtime';
+
+type FrameData = { readonly visibleCount: number };
+const feature = {
+  identity: 'package.feature',
+  extract: ({ owner }) => ok<FrameData>({ visibleCount: owner }),
+  prepare: (data) => {
+    void data.visibleCount;
+    return ok(undefined);
+  },
+  contribute: (data, context) => {
+    void data.visibleCount;
+    context.staging.addPass('named-pass', {
+      reads: [],
+      writes: [],
+      execute: ({ pass }) => void pass,
+    }).unwrap();
+    return ok(undefined);
+  },
+} satisfies RenderFeature<FrameData>;
+
+const renderer = await createRenderer(canvas, { features: [feature] });
+const ready = await renderer.ready;
+if (!ready.ok) throw ready.error;
+```
+
+`renderer.renderFeatureDiagnostics()` is the machine-readable lifecycle
+surface. Read `status` and `latestError?.code`; use `latestError?.hint` for
+the next action. `failed` retries on the next frame, `disabled` is revisited
+by `renderer.recover()`, and `disposed` is terminal. `dispose()` is
+idempotent. A pipeline switch preserves feature registration and rebuilds the
+active graph; use `renderer.registerPipeline(id, pipeline)` for that switch.
+
+Prepared compute remains a render-owned projection: program reflection,
+bindings, direct or indirect dispatch shape, and persistent GPU buffers become
+typed graph accesses before encoding. Runtime does not open a compute pass,
+submit a second command buffer, or infer fallback from a backend name. The
+selected render lane must be compatible with `RhiCaps.compute`, storage, and
+indirect capabilities before it reaches graph compilation.
+
+Hosts that need World- or asset-dependent setup after `renderer.ready` can call
+`await renderer.installRenderFeature(feature)`. It appends the producer to the same
+feature host, keeps identity/capability/error ownership unified, and is
+idempotent for the same feature object. The await includes declared
+material-shader prewarm before the feature can enter the host. A duplicate identity from a different
+object returns `render-feature-registration-conflict`; there is no parallel
+feature registry.
+
+## Asset producer readiness boundary
+
+Runtime consumes the validated Catalog and Pack/DDC projection; it does not
+make a source package ready. For a missing or failed asset, the host follows
+`inspect` -> producer `rebuild` or `cold-cook` -> `verify` -> retry of the same
+GUID. Branch on structured asset errors and evidence details, never on console
+text or a guessed file suffix.
+
+Importer registration, source plus Meta repair, DDC persistence, receipt
+creation, and Catalog publication belong to the build or dev producer host.
+`createRenderer` does not add a hidden importer registry or runtime source
+fallback. This keeps browser startup, player bundles, and render assembly
+outside the asset authoring and cooking boundary.
+
+## Assemble prepared graphics without a private seam
+
+Prepared graphics is still assembled by the runtime host. A producer imports
+the generic `RenderFeature` declaration from `@forgeax/engine-render`, keeps
+its frame data in its owning producer package, and
+uses `context.graphics` for opaque preparation references. Generation and
+recording remain render-host facts.
+
+```ts
+import { ok } from '@forgeax/engine-types';
+import type { RenderFeature } from '@forgeax/engine-render';
+import { createRenderer } from '@forgeax/engine-runtime';
+
+type PreparedFrame = { readonly items: readonly unknown[] };
+const frame: PreparedFrame = { items: [] };
+const feature = {
+  identity: 'package.prepared-feature',
+  extract: () => ok(frame),
+  prepare: (_data, context) => {
+    const pipeline = context.graphics.preparePipeline('package.pipeline', {
+      shader: 'package.shader',
+      vertexLayout: 'package.vertices',
+      colorFormats: ['rgba8unorm-srgb'],
+    });
+    if (!pipeline.ok) return pipeline;
+    void pipeline.value;
+    return ok(undefined);
+  },
+  contribute: () => ok(undefined),
+} satisfies RenderFeature<PreparedFrame>;
+
+const renderer = await createRenderer(canvas, { features: [feature] });
+```
+
+The five public terms remain distinct: `RenderFeature`, `RenderPipeline`,
+RenderGraph pass, Material pass, and prepared graphics. This is a host
+preparation recipe, not a visible particle draw path or a VFX production
+branch. Wave 2 leaves simulation, manifest changes, RPC/CLI transport, and
+private imports out of scope. See the detailed render contract in
+[`packages/render/README.md`](../render/README.md), the declarations in
+[`features/prepared-graphics.ts`](../render/src/features/prepared-graphics.ts), and the
+producer contract in [`packages/vfx/README.md`](../vfx/README.md).
+
+The four concepts stay separate: `RenderFeature` is a producer callback
+contract, `RenderPipeline` is full frame policy, a RenderGraph pass is a
+declared execution node, and a material pass is a shader-facing asset pass.
+The feature API and its structured error model are documented by
+[`@forgeax/engine-render`](../render/README.md); this README documents only
+the runtime assembly boundary.
+
+## Assemble a renderer
+
+```ts
+import { createRenderer } from '@forgeax/engine-runtime';
+
+try {
+  const renderer = await createRenderer(canvas);
+  const ready = await renderer.ready;
+  if (!ready.ok) return ready.error;
+  return renderer.draw([world], { cameraOwner: 0, resourceOwner: 0 });
+} catch (error) {
+  // EngineEnvironmentError reports unusable backend/environment setup.
+}
+```
+
+`createRenderer(canvas, options?, bundler?)` returns `Promise<Renderer>`. Construction failures reject with `EngineEnvironmentError`; after construction, `ready` and `draw` return `Result` values and `dispose()` is idempotent.
+
+## Import each domain from its owner
+
+| Need | Canonical package | Example imports |
+|:--|:--|:--|
+| Transforms and hierarchy | `@forgeax/engine-scene` | `Transform`, `ChildOf`, `scenePlugin` |
+| Joint binding | `@forgeax/engine-skinning` | `Skin`, `resolveSkinJoints` |
+| Graph playback | `@forgeax/engine-animation` | `AnimationPlayer`, `animationPlugin` |
+| Render vocabulary and frame interpretation | `@forgeax/engine-render` | `Camera`, `MeshFilter`, `MeshRenderer`, `DirectionalLight`, `Materials`, `Renderer` |
+
+```ts
+import { scenePlugin, Transform } from '@forgeax/engine-scene';
+import { Skin } from '@forgeax/engine-skinning';
+import { animationPlugin, AnimationPlayer } from '@forgeax/engine-animation';
+import { Camera, DirectionalLight, Materials, MeshFilter, MeshRenderer } from '@forgeax/engine-render';
+
+void [scenePlugin, Transform, Skin, animationPlugin, AnimationPlayer];
+void [Camera, DirectionalLight, Materials, MeshFilter, MeshRenderer];
+```
+
+> [!NOTE]
+> `@forgeax/engine-runtime` is not a compatibility barrel. Importing those domain tokens from runtime is unsupported; follow the focused package README for each domain's roster, errors, and setup.
+
+## Boundary
+
+```mermaid
+flowchart LR
+  Scene["scene"] --> App["app host"]
+  Skinning["skinning"] --> App
+  Animation["animation"] --> App
+  Render["render vocabulary and frame interpreter"] --> Runtime["runtime host assembly"]
+  Runtime --> App
+```
+
+`@forgeax/engine-render` owns `Renderer`, `RendererOptions`, render components, frame stages, prepared graphics, and render errors. Runtime owns only the concrete `createRenderer` host contract and `EngineEnvironmentError`; it never re-exports the moved domain APIs.