@forgeax/engine-render 0.1.24 → 0.1.25

package/dist/components/instances.d.ts

@@ -1,40 +1,22 @@
 /**
- * Per-entity instanced-draw transforms (ECS component).
+ * World-owned local transforms for one explicit instanced renderable.
+ * Packed column-major mat4 values compose as entityWorld * instanceLocal.
+ * ECS owns copying, mutation and entity lifetime, including large arrays.
+ * Renderer extraction derives its own snapshot and GPU residency; neither
+ * authoring nor glTF SceneAsset lowering requires a Renderer identity.
  *
- * Carries a variable-length `array<f32>` of column-major mat4 instance
- * transforms (16 f32 per instance, stride = 16; documented above and
- * enforced at the RenderSystem extract entry, NOT at the ECS write paths).
- *
- * The runtime RenderSystem consumer materialises a fresh `Float32Array`
- * snapshot on every `world.get(e, Instances).transforms` access (D-4
- * no-cache), reads the live count from the snapshot's `length`, and
- * uploads the bytes to a per-entity GPU storage buffer in the record stage
- * (`render-system-record.ts`).
- *
- * @example Spawn an entity rendering 10000 instanced cubes:
- *   const transforms = new Float32Array(10000 * 16);
- *   // ... fill column-major mat4 columns ...
- *   world.spawn(
- *     { component: MeshFilter,   data: { assetHandle: HANDLE_CUBE } },
- *     { component: MeshRenderer, data: { ... } },
- *     { component: Instances,    data: { transforms } },
- *   );
+ * @example
+ * const transforms = new Float32Array(20_000 * 16);
+ * for (let i = 0; i < 20_000; i++) {
+ *   transforms[i * 16] = transforms[i * 16 + 5] =
+ *     transforms[i * 16 + 10] = transforms[i * 16 + 15] = 1;
+ * }
+ * const entity = world.spawn({ component: Instances, data: { transforms } }).unwrap();
+ * world.set(entity, Instances, { transforms }).unwrap();
  */
 export declare const Instances: import("@forgeax/engine-ecs").Component<"Instances", {
     readonly transforms: "array<f32>";
 }>;
-/**
- * Type-level hint for `data` at the `Instances` spawn site.
- *
- * The runtime ECS column shape for `array<f32>` accepts a `Float32Array`
- * payload at spawn / set time (the bytes are copied into the BufferPool
- * slot). The `transforms` field is documented as `Float32Array` here so
- * AI-user IDE autocomplete picks up the typed-array shape.
- *
- * @example
- *   import type { InstancesData } from '@forgeax/engine-render';
- *   const data: InstancesData = { transforms: new Float32Array(N * 16) };
- */
 export type InstancesData = {
     readonly transforms: Float32Array;
 };

package/dist/components/instances.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../src/components/instances.ts"],"names":[],"mappings":"AAqKA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,SAAS;;EAEpB,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC;CACnC,CAAC"}
+{"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../src/components/instances.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,SAAS;;EAEpB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAA;CAAE,CAAC"}