@woosh/meep-engine 2.127.0 → 2.127.1

package/package.json

@@ -5,7 +5,7 @@
   "description": "Pure JavaScript game engine. Fully featured and production ready.",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.127.0",
+  "version": "2.127.1",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/engine/ecs/EntityComponentDataset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EntityComponentDataset.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityComponentDataset.js"],"names":[],"mappings":"AAyHA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wDAfyB,MAAM;IAiB3B;;;;OAIG;IACH,wBAA+B;IAE/B;;;;;OAKG;IACH,yBAAsC;IAEtC;;;;;;;;;OASG;IACH,2BAAkC;IAElC;;;;;OAKG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAgC;IAEhC;;;;OAIG;IACH,2BAAuB;IAEvB;;;;OAIG;IACH,mBAAgB;IAEhB;;;;OAIG;IACH,oBAAgB;IAEhB;;;;;;;OAOG;IACH,mBAAe;IAEf;;;OAGG;IACH,0BAFU,OAAO,MAAM,CAAC,CAEO;IAE/B;;;OAGG;IACH,0BAFU,OAAO,MAAM,CAAC,CAEO;IAG/B;;;;OAIG;IACH,+BAA4B;IAE5B;;;;OAIG;IACH,kCAA+B;IAE/B;;;OAGG;IACH,kBAAe;IAGf;;;;;;OAMG;IACH,mEAkCC;IAED;;;;;OAKG;IACH,kDAHW,OAAO,GACL,OAAO,CAqDnB;IAED;;;;;OAKG;IACH,qDAHW,OAAO,GACL,OAAO,CA6DnB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,yBAFa,MAAM,CAIlB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,qBACN,EAAE,SAmCZ;IAED;;;;OAIG;IACH,4BAHW,MAAM,GACJ,EAAE,CAyBd;IAED;;;;;OAKG;IACH,yBAJW,OAAO,GACL,IAAI,CA0LhB;IAED;;;;OAIG;IACH,mCAHW,OAAO,GACL,OAAO,CAenB;IAED;;;;;OAKG;IACH,gCAHW,gBAAc,GACb,OAAO,CASlB;IAED;;;OAGG;IACH,uBAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,kCAHW,OAAO,GACL,OAAO,CAgBnB;IAED;;;;OAIG;IACH,4BAHW,gBAAc,GACZ,OAAO,CAanB;IAED;;;;OAIG;IACH,sCAFa,OAAO,CAkBnB;IAED;;;;OAIG;IACH,iCAHW,MAAM,GACJ,IAAI,CAmBhB;IAED;;;;;OAKG;IACH,+BAHW,MAAM,GACJ,MAAM,CAOlB;IAED;;;;OAIG;IACH,2BAiBC;IAED;;;OAGG;IACH,gBAFa,MAAM,CAQlB;IAED;;;;;OAKG;IACH,gCAJW,MAAM,GAEJ,IAAI,CAQhB;IAED;;;;OAIG;IACH,0BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,qCAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,wBAHW,MAAM,GACJ,OAAO,CAwCnB;IAED;;;;;OAKG;IACH,2BAHW,MAAM,EAAE,GACN,IAAI,CAQhB;IAED;;;;;OAKG;IACH,qCAJW,MAAM,iBAEJ,IAAI,CAUhB;IAED;;;;;OAKG;IACH,4CAJW,MAAM,mBACN,MAAM,GACJ,IAAI,CAiBhB;IAED;;;;;;;OAOG;IACH,mDAgBC;IAED;;;;OAIG;IACH,iCAHW,gBAAc,GACZ,MAAM,CAalB;IAED;;;;OAIG;IACH,wCAFa,MAAM,CAUlB;IAED;;;;;;;OAOG;IACH;gBAFqB,MAAM;;MA2B1B;IAED;;;;;;;;OAQG;IACH,mCAJW,MAAM,0BAEJ,IAAI,CAqBhB;IAED;;;;;;;OAOG;IACH,4CALW,MAAM,mBACN,MAAM,4BAEJ,IAAI,CA4BhB;IAED;;;;;OAKG;IACH,oCAJW,MAAM,mBACN,MAAM,OAUhB;IAED;;;;;;OAMG;IACH,6BAJW,MAAM,sBAEJ,OAAO,CAInB;IAED;;;;;OAKG;IACH,6BAJW,MAAM,0BAiBhB;IAED;;;;;;;OAOG;IACH,iCALW,MAAM,0BAahB;IAED;;;;;;;OAOG;IACH,iGAFa,IAAI,CAiBhB;IAED;;;;;;;;;;;;;OAaG;IACH,gEAJ6B,OAAO,YACzB,MAAM,GACJ,IAAI,CAyEhB;IAED;;;;;;;OAOG;IACH,uEAFa,IAAI,CA0DhB;IAkBD;;;;;;;;;;OAUG;IACH,yEAFa,IAAI,CAahB;IAED;;;;;;OAMG;IACH,2CALW,MAAM,qCAGJ,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,+CAyBC;IAED;;;;;;OAMG;IACH,iDAsBC;IAED;;;;;OAKG;IACH,wCAgCC;IAED;;;;;OAKG;IACH,0CA2BC;IAED;;;;;;;;;OASG;IACH,kCARW,MAAM,sCAGJ,IAAI,CAuBhB;IAED;;;;;;;;;OASG;IACH,qCARW,MAAM,sCAGJ,OAAO,CAkCnB;IAED;;;;;;;;;;OAUG;IACH,+BATW,MAAM,cACN,MAAM,uCAGJ,IAAI,CAiChB;IAED;;;;;;;;;;OAUG;IACH,kCATW,MAAM,cACN,MAAM,sCAGJ,OAAO,CA2CnB;IAED;;;;;;;OAOG;IACH,sDAHa,IAAI,CAkBhB;IAED;;;;OAIG;IACH,+BAHW,MAAM,GACJ,OAAO,CAenB;IAED;;;;OAIG;IACH,SAHa,IAAI,CAShB;IAED;;;;;OAKG;IACH,YAHa,IAAI,CAehB;IAED;;;;OAIG;IACH,yCAHW,MAAM,GACJ,IAAI,wBAAkB,CAiBlC;IAED;;;;;OAKG;IACH,mBAHW,sBAAsB,6BACpB,IAAI,CA6DhB;IAED;;;;;OAKG;IACH,2EAFa,IAAI,CAgDhB;IAED;;;OAGG;IACH,WAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,oDAFa,IAAI,CAgBhB;IAGL;;;;;OAKG;IACH,mCAFU,OAAO,CAEwC;IAIzD;;OAEG;IACH,4BA/mBgB,UAAU,MAAM,CAAC,CA+mBoB;IAErD;;OAEG;IACH,iCAjZe,MAAM,wCAGJ,OAAO,CA8Y+B;IAtnBnD;;;OAGG;IACH,qBAFY,UAAU,MAAM,CAAC,CAY5B;CAolBJ;mBAh+DkB,oCAAoC"}
+{"version":3,"file":"EntityComponentDataset.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityComponentDataset.js"],"names":[],"mappings":"AAyHA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wDAfyB,MAAM;IAiB3B;;;;OAIG;IACH,wBAA+B;IAE/B;;;;;OAKG;IACH,yBAAsC;IAEtC;;;;;;;;;OASG;IACH,2BAAkC;IAElC;;;;;OAKG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAgC;IAEhC;;;;OAIG;IACH,2BAAuB;IAEvB;;;;OAIG;IACH,mBAAgB;IAEhB;;;;OAIG;IACH,oBAAgB;IAEhB;;;;;;;OAOG;IACH,mBAAe;IAEf;;;OAGG;IACH,0BAFU,OAAO,MAAM,CAAC,CAEO;IAE/B;;;OAGG;IACH,0BAFU,OAAO,MAAM,CAAC,CAEO;IAG/B;;;;OAIG;IACH,+BAA4B;IAE5B;;;;OAIG;IACH,kCAA+B;IAE/B;;;OAGG;IACH,kBAAe;IAGf;;;;;;OAMG;IACH,mEAkCC;IAED;;;;;OAKG;IACH,kDAHW,OAAO,GACL,OAAO,CAqDnB;IAED;;;;;OAKG;IACH,qDAHW,OAAO,GACL,OAAO,CA6DnB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,yBAFa,MAAM,CAIlB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,qBACN,EAAE,SAmCZ;IAED;;;;;OAKG;IACH,4BAHW,MAAM,GACJ,EAAE,CAyBd;IAED;;;;;OAKG;IACH,yBAJW,OAAO,GACL,IAAI,CA0LhB;IAED;;;;OAIG;IACH,mCAHW,OAAO,GACL,OAAO,CAenB;IAED;;;;;OAKG;IACH,gCAHW,gBAAc,GACb,OAAO,CASlB;IAED;;;OAGG;IACH,uBAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,kCAHW,OAAO,GACL,OAAO,CAgBnB;IAED;;;;OAIG;IACH,4BAHW,gBAAc,GACZ,OAAO,CAanB;IAED;;;;OAIG;IACH,sCAFa,OAAO,CAkBnB;IAED;;;;OAIG;IACH,iCAHW,MAAM,GACJ,IAAI,CAmBhB;IAED;;;;;OAKG;IACH,+BAHW,MAAM,GACJ,MAAM,CAOlB;IAED;;;;OAIG;IACH,2BAiBC;IAED;;;OAGG;IACH,gBAFa,MAAM,CAQlB;IAED;;;;;OAKG;IACH,gCAJW,MAAM,GAEJ,IAAI,CAQhB;IAED;;;;OAIG;IACH,0BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,qCAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,wBAHW,MAAM,GACJ,OAAO,CAwCnB;IAED;;;;;OAKG;IACH,2BAHW,MAAM,EAAE,GACN,IAAI,CAQhB;IAED;;;;;OAKG;IACH,qCAJW,MAAM,iBAEJ,IAAI,CAUhB;IAED;;;;;OAKG;IACH,4CAJW,MAAM,mBACN,MAAM,GACJ,IAAI,CAiBhB;IAED;;;;;;;OAOG;IACH,mDAgBC;IAED;;;;OAIG;IACH,iCAHW,gBAAc,GACZ,MAAM,CAalB;IAED;;;;OAIG;IACH,wCAFa,MAAM,CAUlB;IAED;;;;;;;OAOG;IACH;gBAFqB,MAAM;;MA2B1B;IAED;;;;;;;;OAQG;IACH,mCAJW,MAAM,0BAEJ,IAAI,CAqBhB;IAED;;;;;;;OAOG;IACH,4CALW,MAAM,mBACN,MAAM,4BAEJ,IAAI,CA4BhB;IAED;;;;;OAKG;IACH,oCAJW,MAAM,mBACN,MAAM,OAUhB;IAED;;;;;;OAMG;IACH,6BAJW,MAAM,sBAEJ,OAAO,CAInB;IAED;;;;;OAKG;IACH,6BAJW,MAAM,0BAiBhB;IAED;;;;;;;OAOG;IACH,iCALW,MAAM,0BAahB;IAED;;;;;;;OAOG;IACH,iGAFa,IAAI,CAiBhB;IAED;;;;;;;;;;;;;OAaG;IACH,gEAJ6B,OAAO,YACzB,MAAM,GACJ,IAAI,CAyEhB;IAED;;;;;;;OAOG;IACH,uEAFa,IAAI,CA0DhB;IAkBD;;;;;;;;;;OAUG;IACH,yEAFa,IAAI,CAahB;IAED;;;;;;OAMG;IACH,2CALW,MAAM,qCAGJ,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,+CAyBC;IAED;;;;;;OAMG;IACH,iDAsBC;IAED;;;;;OAKG;IACH,wCAgCC;IAED;;;;;OAKG;IACH,0CA2BC;IAED;;;;;;;;;OASG;IACH,kCARW,MAAM,sCAGJ,IAAI,CAuBhB;IAED;;;;;;;;;OASG;IACH,qCARW,MAAM,sCAGJ,OAAO,CAkCnB;IAED;;;;;;;;;;OAUG;IACH,+BATW,MAAM,cACN,MAAM,uCAGJ,IAAI,CAiChB;IAED;;;;;;;;;;OAUG;IACH,kCATW,MAAM,cACN,MAAM,sCAGJ,OAAO,CA2CnB;IAED;;;;;;;OAOG;IACH,sDAHa,IAAI,CAkBhB;IAED;;;;OAIG;IACH,+BAHW,MAAM,GACJ,OAAO,CAenB;IAED;;;;OAIG;IACH,SAHa,IAAI,CAShB;IAED;;;;;OAKG;IACH,YAHa,IAAI,CAehB;IAED;;;;OAIG;IACH,yCAHW,MAAM,GACJ,IAAI,wBAAkB,CAiBlC;IAED;;;;;OAKG;IACH,mBAHW,sBAAsB,6BACpB,IAAI,CA6DhB;IAED;;;;;OAKG;IACH,2EAFa,IAAI,CAgDhB;IAED;;;OAGG;IACH,WAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,oDAFa,IAAI,CAgBhB;IAGL;;;;;OAKG;IACH,mCAFU,OAAO,CAEwC;IAIzD;;OAEG;IACH,4BA/mBgB,UAAU,MAAM,CAAC,CA+mBoB;IAErD;;OAEG;IACH,iCAjZe,MAAM,wCAGJ,OAAO,CA8Y+B;IAtnBnD;;;OAGG;IACH,qBAFY,UAAU,MAAM,CAAC,CAY5B;CAolBJ;mBAj+DkB,oCAAoC"}

package/src/engine/ecs/EntityComponentDataset.js

@@ -477,7 +477,8 @@ export class EntityComponentDataset {
     }
 
     /**
-     * Get all components associated with a given entity
+     * Get all components associated with a given entity.
+     * Note that this method allocates. If performance is important - prefer alternatives.
      * @param {number} entity_id
      * @returns {[]} all components attached to the entity, array is not compacted
      */

package/src/engine/graphics/render/frame_graph/RenderGraph.d.ts

@@ -1,6 +1,35 @@
 /**
  * Based on the Frostbite's GDC paper "FrameGraph: Extensible Rendering Architecture in Frostbite" by Yuriy O'Donnell
- * @see https://github.com/skaarj1989/FrameGraph
+ * @example
+ *      const graph = new RenderGraph("My Graph");
+ *
+ *      const pass_data = {};
+ *      const pass = graph.add("GBuffer Pass", pass_data, (data, resources, context) => {
+ *
+ *          context.beginRenderPass({
+ *              depth_attachment: resources.get(data.depth),
+ *              color_attachments:[
+ *                  resources.get(data.normal),
+ *                  resources.get(data.albedo),
+ *             ]
+ *          });
+ *
+ *          for (const renderable in renderables){
+ *              drawMesh(context, renderable.mesh, renderable.material);
+ *          }
+ *
+ *          context.endRenderPass();
+ *
+ *      });
+ *
+ *      pass_data.depth = pass.create("depth", {...});
+ *      pass_data.albedo = pass.create("albedo", {...});
+ *      pass_data.normal = pass.create("normal", {...});
+ *
+ *
+ *      graph.compile();
+ *      graph.execute(context);
+ *
  */
 export class RenderGraph {
     /**
@@ -54,6 +83,7 @@ export class RenderGraph {
      * @template T
      * @param {string} name
      * @param {T} descriptor
+     * @returns {number}
      */
     create_resource<T_1>(name: string, descriptor: T_1): number;
     /**
@@ -73,10 +103,10 @@ export class RenderGraph {
     private _createResourceNode;
     /**
      *
-     * @param {number} res
-     * @returns {number}
+     * @param {number} node_id
+     * @returns {number} ID of the cloned resource node
      */
-    clone_resource(res: number): number;
+    clone_resource(node_id: number): number;
     /**
      * @template T
      * @param {string} name
@@ -91,13 +121,14 @@ export class RenderGraph {
      */
     is_valid_resource(id: any): boolean;
     /**
+     * Add a new pass to the graph.
      * @template T
      * @param {string} name
      * @param {T} data
      * @param {function(data:T, resources: RenderPassResources, context:IRenderContext):void} execute
-     * @returns {RenderGraphBuilder}
+     * @returns {RenderPassBuilder}
      */
-    add<T_3>(name: string, data: T_3, execute: any): RenderGraphBuilder;
+    add<T_3>(name: string, data: T_3, execute: any): RenderPassBuilder;
     /**
      * Perform validation, useful for debugging
      * Typically done before compilation
@@ -113,6 +144,18 @@ export class RenderGraph {
      */
     execute(context: IRenderContext): void;
     /**
+     * Should only call after {@link compile}
+     *
+     * @see https://github.com/skaarj1989/FrameGraph/blob/viewer/JsonWriter.hpp
+     * @return {{passes: [], resources: []}}
+     */
+    exportToJson(): {
+        passes: [];
+        resources: [];
+    };
+    /**
+     * Export the graph diagram in GraphViz DOT format.
+     * Useful for debugging.
      * @see https://en.wikipedia.org/wiki/DOT_(graph_description_language)
      * @return {string}
      */
@@ -125,5 +168,5 @@ export class RenderGraph {
 }
 import { ResourceEntry } from "./ResourceEntry.js";
 import { ResourceNode } from "./ResourceNode.js";
-import { RenderGraphBuilder } from "./RenderGraphBuilder.js";
+import { RenderPassBuilder } from "./RenderPassBuilder.js";
 //# sourceMappingURL=RenderGraph.d.ts.map

package/src/engine/graphics/render/frame_graph/RenderGraph.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RenderGraph.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderGraph.js"],"names":[],"mappings":"AAQA;;;GAGG;AACH;IA6BI;;;OAGG;IACH,mBAFW,MAAM,EAOhB;IArCD;;;;OAIG;IACH,MAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,qBAAkB;IAElB;;;;OAIG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAyB;IAazB;;;;OAIG;IACH,qBAHW,MAAM,sBAahB;IAED;;;;OAIG;IACH,oBAHW,MAAM,qBAmBhB;IAED;;;;OAIG;IACH,qBAHW,MAAM,KAKhB;IAED;;;;OAIG;IACH,2BAHW,MAAM,2BAWhB;IAED;;;;;OAKG;IACH,6BAYC;IAED;;;;;;OAMG;IACH,4BAeC;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACJ,MAAM,CAkBlB;IAED;;;;;;OAMG;IACH,2BALW,MAAM,wDAGJ,MAAM,CAUlB;IAED;;;OAGG;IACH,4BAHa,OAAO,CAQnB;IAED;;;;;;OAMG;IACH,eALW,MAAM,4BAGJ,kBAAkB,CA2B9B;IAED;;;;;;OAMG;IACH,iEAFa,OAAO,CAOnB;IAED,gBA6FC;IAED;;;OAGG;IACH,uCA2CC;IAED;;;OAGG;IACH,eAFY,MAAM,CAiEjB;IAGL;;;OAGG;IACH,wBAFU,OAAO,CAEkB;CANlC;8BAld6B,oBAAoB;6BACrB,mBAAmB;mCAJb,yBAAyB"}
+{"version":3,"file":"RenderGraph.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderGraph.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH;IA6BI;;;OAGG;IACH,mBAFW,MAAM,EAOhB;IArCD;;;;OAIG;IACH,MAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,qBAAkB;IAElB;;;;OAIG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAyB;IAazB;;;;OAIG;IACH,qBAHW,MAAM,sBAahB;IAED;;;;OAIG;IACH,oBAHW,MAAM,qBAmBhB;IAED;;;;OAIG;IACH,qBAHW,MAAM,KAKhB;IAED;;;;;OAKG;IACH,2BAJW,MAAM,oBAEJ,MAAM,CAWlB;IAED;;;;;OAKG;IACH,6BAYC;IAED;;;;;;OAMG;IACH,4BAeC;IAED;;;;OAIG;IACH,wBAHW,MAAM,GACJ,MAAM,CAkBlB;IAED;;;;;;OAMG;IACH,2BALW,MAAM,wDAGJ,MAAM,CAUlB;IAED;;;OAGG;IACH,4BAHa,OAAO,CAQnB;IAED;;;;;;;OAOG;IACH,eALW,MAAM,4BAGJ,iBAAiB,CA2B7B;IAED;;;;;;OAMG;IACH,iEAFa,OAAO,CAQnB;IAED,gBA6FC;IAED;;;OAGG;IACH,uCA2CC;IAED;;;;;OAKG;IACH;gBAFqB,EAAE;mBAAa,EAAE;MA2DrC;IAED;;;;;OAKG;IACH,eAFY,MAAM,CAiEjB;IAGL;;;OAGG;IACH,wBAFU,OAAO,CAEkB;CANlC;8BAtjB6B,oBAAoB;6BACrB,mBAAmB;kCAJd,wBAAwB"}

package/src/engine/graphics/render/frame_graph/RenderGraph.js

@@ -1,6 +1,6 @@
 import { assert } from "../../../../core/assert.js";
 import LineBuilder from "../../../../core/codegen/LineBuilder.js";
-import { RenderGraphBuilder } from "./RenderGraphBuilder.js";
+import { RenderPassBuilder } from "./RenderPassBuilder.js";
 import { RenderPassNode } from "./RenderPassNode.js";
 import { RenderPassResources } from "./RenderPassResources.js";
 import { ResourceEntry } from "./ResourceEntry.js";
@@ -8,7 +8,36 @@ import { ResourceNode } from "./ResourceNode.js";
 
 /**
  * Based on the Frostbite's GDC paper "FrameGraph: Extensible Rendering Architecture in Frostbite" by Yuriy O'Donnell
- * @see https://github.com/skaarj1989/FrameGraph
+ * @example
+ *      const graph = new RenderGraph("My Graph");
+ *
+ *      const pass_data = {};
+ *      const pass = graph.add("GBuffer Pass", pass_data, (data, resources, context) => {
+ *
+ *          context.beginRenderPass({
+ *              depth_attachment: resources.get(data.depth),
+ *              color_attachments:[
+ *                  resources.get(data.normal),
+ *                  resources.get(data.albedo),
+ *             ]
+ *          });
+ *
+ *          for (const renderable in renderables){
+ *              drawMesh(context, renderable.mesh, renderable.material);
+ *          }
+ *
+ *          context.endRenderPass();
+ *
+ *      });
+ *
+ *      pass_data.depth = pass.create("depth", {...});
+ *      pass_data.albedo = pass.create("albedo", {...});
+ *      pass_data.normal = pass.create("normal", {...});
+ *
+ *
+ *      graph.compile();
+ *      graph.execute(context);
+ *
  */
 export class RenderGraph {
     /**
@@ -103,11 +132,13 @@ export class RenderGraph {
      * @template T
      * @param {string} name
      * @param {T} descriptor
+     * @returns {number}
      */
     create_resource(name, descriptor) {
         assert.isString(name, 'name');
         assert.defined(descriptor, 'descriptor');
         assert.notNull(descriptor, 'descriptor');
+        assert.isObject(descriptor, 'descriptor');
 
         const resource = this._createResourceEntry(descriptor);
 
@@ -160,11 +191,11 @@ export class RenderGraph {
 
     /**
      *
-     * @param {number} res
-     * @returns {number}
+     * @param {number} node_id
+     * @returns {number} ID of the cloned resource node
      */
-    clone_resource(res) {
-        const node = this.getResourceNode(res);
+    clone_resource(node_id) {
+        const node = this.getResourceNode(node_id);
 
         const entry = this.__resource_registry[node.resource_id];
 
@@ -210,11 +241,12 @@ export class RenderGraph {
     }
 
     /**
+     * Add a new pass to the graph.
      * @template T
      * @param {string} name
      * @param {T} data
      * @param {function(data:T, resources: RenderPassResources, context:IRenderContext):void} execute
-     * @returns {RenderGraphBuilder}
+     * @returns {RenderPassBuilder}
      */
     add(name, data, execute) {
         assert.isString(name, 'name');
@@ -227,7 +259,7 @@ export class RenderGraph {
 
         const pass_nodes = this.__pass_nodes;
 
-        const builder = new RenderGraphBuilder();
+        const builder = new RenderPassBuilder();
         const node = new RenderPassNode();
 
         node.id = pass_nodes.length;
@@ -253,6 +285,7 @@ export class RenderGraph {
     validate(problem_consumer, problem_consumer_context) {
 
         // TODO implement
+        // TODO check for "read before write"
 
         return true;
     }
@@ -402,6 +435,73 @@ export class RenderGraph {
     }
 
     /**
+     * Should only call after {@link compile}
+     *
+     * @see https://github.com/skaarj1989/FrameGraph/blob/viewer/JsonWriter.hpp
+     * @return {{passes: [], resources: []}}
+     */
+    exportToJson() {
+
+        const resources = [];
+
+        this.__resource_registry.forEach((entry, entry_id) => {
+            const node = this.getResourceNode(entry.resource_id);
+
+            const j = {
+                id: entry_id,
+                name: node.name,
+                transient: entry.isTransient(),
+            };
+
+            const description = entry.resource_descriptor?.toString();
+
+            if (description) {
+                j.description = description;
+            }
+
+            if (entry.producer !== null) {
+                j.createdBy = entry.producer.id;
+            }
+
+            const readers = [];
+            const writers = [];
+
+            this.__pass_nodes.forEach(pass => {
+                if (pass.reads(entry.resource_id)) {
+                    readers.push(pass.id);
+                }
+                if (pass.writes(entry.resource_id)) {
+                    writers.push(pass.id);
+                }
+            })
+
+            if (readers.length > 0) {
+                j.readers = readers;
+            }
+            if (writers.length > 0) {
+                j.writers = writers;
+            }
+
+            resources[entry_id] = j;
+        })
+
+        return {
+            passes: this.__pass_nodes.map(node => {
+                return {
+                    id: node.id,
+                    name: node.name,
+                    culled: !node.can_execute(),
+                    reads: node.resource_reads,
+                    writes: node.resource_writes,
+                }
+            }),
+            resources
+        }
+    }
+
+    /**
+     * Export the graph diagram in GraphViz DOT format.
+     * Useful for debugging.
      * @see https://en.wikipedia.org/wiki/DOT_(graph_description_language)
      * @return {string}
      */

package/src/engine/graphics/render/frame_graph/RenderPassBuilder.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Allows you to declare resources for the pass, reading/writing/creating resources that will be used by the pass.
+ *
+ * @example
+ *      const pass_data = {};
+ *      const pass_builder = graph.add("pass", pass_data, (data, resources, context) => { ... });
+ *      pass_data.resource_a = pass_builder.create("A", {});
+ */
+export class RenderPassBuilder {
+    /**
+     *
+     * @param {RenderGraph} graph
+     * @param {RenderPassNode} node
+     */
+    init(graph: RenderGraph, node: RenderPassNode): void;
+    /**
+     * Create a new resource.
+     * Creation implies writing as well.
+     * @param {string} name
+     * @param {ResourceDescriptor} descriptor
+     * @returns {number} resource ID
+     */
+    create(name: string, descriptor: ResourceDescriptor): number;
+    /**
+     * Read an existing resource
+     * @param {number} resource
+     * @returns {number} resource ID same as the input
+     */
+    read(resource: number): number;
+    /**
+     * Write a resource
+     * @param {number} resource
+     * @returns {number} resource ID
+     */
+    write(resource: number): number;
+    /**
+     * Indicate that this pass has side effects.
+     * Will force the node to always be executed, regardless if it contributes to the final outputs of the graph or not.
+     * Useful for debug purposes or cases where some of the resources written are not part of the graph.
+     */
+    make_side_effect(): void;
+    #private;
+}
+//# sourceMappingURL=RenderPassBuilder.d.ts.map

package/src/engine/graphics/render/frame_graph/RenderPassBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderPassBuilder.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderPassBuilder.js"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH;IAgBI;;;;OAIG;IACH,qDAMC;IAED;;;;;;OAMG;IACH,aAJW,MAAM,mCAEJ,MAAM,CAYlB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,MAAM,CASlB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,MAAM,CAsBlB;IAED;;;;OAIG;IACH,yBAEC;;CACJ"}

package/src/engine/graphics/render/frame_graph/{RenderGraphBuilder.js → RenderPassBuilder.js}

@@ -1,12 +1,22 @@
 import { assert } from "../../../../core/assert.js";
 
-export class RenderGraphBuilder {
+/**
+ * Allows you to declare resources for the pass, reading/writing/creating resources that will be used by the pass.
+ *
+ * @example
+ *      const pass_data = {};
+ *      const pass_builder = graph.add("pass", pass_data, (data, resources, context) => { ... });
+ *      pass_data.resource_a = pass_builder.create("A", {});
+ */
+export class RenderPassBuilder {
+
     /**
      *
      * @type {RenderGraph}
      * @private
      */
     #graph = null;
+
     /**
      *
      * @type {RenderPassNode}
@@ -20,12 +30,16 @@ export class RenderGraphBuilder {
      * @param {RenderPassNode} node
      */
     init(graph, node) {
+        assert.defined(graph, 'graph');
+        assert.defined(node, 'node');
+
         this.#graph = graph;
         this.#node = node;
     }
 
     /**
-     * Create a new resource
+     * Create a new resource.
+     * Creation implies writing as well.
      * @param {string} name
      * @param {ResourceDescriptor} descriptor
      * @returns {number} resource ID
@@ -45,18 +59,21 @@ export class RenderGraphBuilder {
     /**
      * Read an existing resource
      * @param {number} resource
-     * @returns {number}
+     * @returns {number} resource ID same as the input
      */
     read(resource) {
         assert.isNonNegativeInteger(resource, 'resource');
+        assert.defined(this.#graph.getResourceEntry(resource), 'resource node');
 
-        return this.#node.read(resource);
+        const node = this.#node;
+
+        return node.read(resource);
     }
 
     /**
      * Write a resource
      * @param {number} resource
-     * @returns {number}
+     * @returns {number} resource ID
      */
     write(resource) {
         assert.isNonNegativeInteger(resource, 'resource');
@@ -81,7 +98,9 @@ export class RenderGraphBuilder {
     }
 
     /**
-     * Will force the node to be executed
+     * Indicate that this pass has side effects.
+     * Will force the node to always be executed, regardless if it contributes to the final outputs of the graph or not.
+     * Useful for debug purposes or cases where some of the resources written are not part of the graph.
      */
     make_side_effect() {
         this.#node.has_side_effects = true;

package/src/engine/graphics/render/frame_graph/RenderPassNode.d.ts

@@ -51,6 +51,7 @@ export class RenderPassNode extends GraphNode {
     /**
      *
      * @param {number} resource
+     * @returns {number} same as the input
      */
     read(resource: number): number;
     /**

package/src/engine/graphics/render/frame_graph/RenderPassNode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RenderPassNode.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderPassNode.js"],"names":[],"mappings":"AAIA;IAEI;;;OAGG;IACH,kBAAc;IAEd;;;OAGG;IACH,kBAFU,OAAO,CAEQ;IAEzB;;;OAGG;IACH,UAAU;IAEV;;;OAGG;IACH,kBAFU,MAAM,EAAE,CAEI;IAEtB;;;OAGG;IACH,gBAFU,MAAM,EAAE,CAEE;IAEpB;;;OAGG;IACH,iBAFU,MAAM,EAAE,CAEG;IAErB;;;;OAIG;IACH,YAHW,MAAM,GACL,OAAO,CAMlB;IAED;;;;OAIG;IACH,UAHW,MAAM,GACL,OAAO,CAMlB;IAED;;;;OAIG;IACH,WAHW,MAAM,GACL,OAAO,CAMlB;IAED,0BAOC;IAED;;;OAGG;IACH,eAFW,MAAM,UAUhB;IAED;;;OAGG;IACH,eAFY,OAAO,CAIlB;CACJ;0BAvGyB,gBAAgB"}
+{"version":3,"file":"RenderPassNode.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderPassNode.js"],"names":[],"mappings":"AAIA;IAEI;;;OAGG;IACH,kBAAc;IAEd;;;OAGG;IACH,kBAFU,OAAO,CAEQ;IAEzB;;;OAGG;IACH,UAAU;IAEV;;;OAGG;IACH,kBAFU,MAAM,EAAE,CAEI;IAEtB;;;OAGG;IACH,gBAFU,MAAM,EAAE,CAEE;IAEpB;;;OAGG;IACH,iBAFU,MAAM,EAAE,CAEG;IAErB;;;;OAIG;IACH,YAHW,MAAM,GACL,OAAO,CAMlB;IAED;;;;OAIG;IACH,UAHW,MAAM,GACL,OAAO,CAMlB;IAED;;;;OAIG;IACH,WAHW,MAAM,GACL,OAAO,CAMlB;IAED,0BAOC;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,MAAM,CAUlB;IAED;;;OAGG;IACH,eAFY,OAAO,CAIlB;CACJ;0BAxGyB,gBAAgB"}

package/src/engine/graphics/render/frame_graph/RenderPassNode.js

@@ -85,6 +85,7 @@ export class RenderPassNode extends GraphNode {
     /**
      *
      * @param {number} resource
+     * @returns {number} same as the input
      */
     read(resource) {
         if (this.reads(resource)) {

package/src/engine/graphics/render/frame_graph/ResourceEntry.d.ts

@@ -48,7 +48,15 @@ export class ResourceEntry<T> {
      * @param {RenderResourceManager} resources
      */
     destroy(resources: RenderResourceManager): void;
+    /**
+     *
+     * @return {boolean}
+     */
     isImported(): boolean;
+    /**
+     *
+     * @return {boolean}
+     */
     isTransient(): boolean;
     toString(): any;
 }

package/src/engine/graphics/render/frame_graph/ResourceEntry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ResourceEntry.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/ResourceEntry.js"],"names":[],"mappings":"AAIA;;GAEG;AACH;IACI;;;OAGG;IACH,aAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,qBAFU,wBAAsB,IAAI,CAET;IAE3B;;;OAGG;IACH,kBAFU,MAAM,CAEK;IAErB;;;OAGG;IACH,UAFU,CAAC,GAAC,IAAI,CAEA;IAEhB;;;;OAIG;IACH,UAFU,OAAO,CAEA;IAEjB;;;OAGG;IACH,UAFU,iBAAe,IAAI,CAEb;IAEhB;;;OAGG;IACH,MAFU,iBAAe,IAAI,CAEjB;IAEZ;;;OAGG;IACH,+CAIC;IAED;;;OAGG;IACH,gDAIC;IAED,sBAEC;IAED,uBAEC;IAED,gBAQC;CACJ"}
+{"version":3,"file":"ResourceEntry.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/ResourceEntry.js"],"names":[],"mappings":"AAIA;;GAEG;AACH;IACI;;;OAGG;IACH,aAFU,MAAM,CAEW;IAE3B;;;OAGG;IACH,qBAFU,wBAAsB,IAAI,CAET;IAE3B;;;OAGG;IACH,kBAFU,MAAM,CAEK;IAErB;;;OAGG;IACH,UAFU,CAAC,GAAC,IAAI,CAEA;IAEhB;;;;OAIG;IACH,UAFU,OAAO,CAEA;IAEjB;;;OAGG;IACH,UAFU,iBAAe,IAAI,CAEb;IAEhB;;;OAGG;IACH,MAFU,iBAAe,IAAI,CAEjB;IAEZ;;;OAGG;IACH,+CAIC;IAED;;;OAGG;IACH,gDAIC;IAED;;;OAGG;IACH,cAFY,OAAO,CAIlB;IAED;;;OAGG;IACH,eAFY,OAAO,CAIlB;IAED,gBAQC;CACJ"}

package/src/engine/graphics/render/frame_graph/ResourceEntry.js

@@ -69,10 +69,18 @@ export class ResourceEntry {
         resources.release(this.resource);
     }
 
+    /**
+     *
+     * @return {boolean}
+     */
     isImported() {
         return this.imported;
     }
 
+    /**
+     *
+     * @return {boolean}
+     */
     isTransient() {
         return !this.imported;
     }

package/src/engine/graphics/render/frame_graph/RenderGraphBuilder.d.ts

@@ -1,33 +0,0 @@
-export class RenderGraphBuilder {
-    /**
-     *
-     * @param {RenderGraph} graph
-     * @param {RenderPassNode} node
-     */
-    init(graph: RenderGraph, node: RenderPassNode): void;
-    /**
-     * Create a new resource
-     * @param {string} name
-     * @param {ResourceDescriptor} descriptor
-     * @returns {number} resource ID
-     */
-    create(name: string, descriptor: ResourceDescriptor): number;
-    /**
-     * Read an existing resource
-     * @param {number} resource
-     * @returns {number}
-     */
-    read(resource: number): number;
-    /**
-     * Write a resource
-     * @param {number} resource
-     * @returns {number}
-     */
-    write(resource: number): number;
-    /**
-     * Will force the node to be executed
-     */
-    make_side_effect(): void;
-    #private;
-}
-//# sourceMappingURL=RenderGraphBuilder.d.ts.map

package/src/engine/graphics/render/frame_graph/RenderGraphBuilder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RenderGraphBuilder.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderGraphBuilder.js"],"names":[],"mappings":"AAEA;IAcI;;;;OAIG;IACH,qDAGC;IAED;;;;;OAKG;IACH,aAJW,MAAM,mCAEJ,MAAM,CAYlB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,MAAM,CAMlB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,MAAM,CAsBlB;IAED;;OAEG;IACH,yBAEC;;CACJ"}

package/src/engine/graphics/render/frame_graph/RenderPass.d.ts

@@ -1,50 +0,0 @@
-/**
- * @deprecated new syntax does not require a separate data structure, use lambda functions instead
- * @template [DATA=Object<number>]
- * @class
- */
-export class RenderPass<DATA = any> {
-    /**
-     *
-     * @param [inputs]
-     */
-    constructor(inputs?: any);
-    /**
-     * Used for debug and visualisation
-     * @type {string}
-     */
-    name: string;
-    /**
-     *
-     * @type {number|RenderPassFlags}
-     */
-    flags: number | RenderPassFlags;
-    /**
-     * Arbitrary dictionary of data
-     * @deprecated
-     * @type {Object<number>}
-     */
-    inputs: any;
-    /**
-     *
-     * @param {RenderGraphBuilder} builder
-     * @returns {DATA} resources/handles that are used by the pass, includes both inputs and outputs
-     */
-    setup(builder: RenderGraphBuilder): DATA;
-    /**
-     * @param {DATA} data
-     * @param {RenderPassResources} resources
-     * @param {IRenderContext} render_context
-     * @returns {void}
-     */
-    execute(data: DATA, resources: RenderPassResources, render_context: IRenderContext): void;
-    /**
-     * Validate render pass internal structure
-     * This is an optional method, mainly useful for debugging purposes
-     * Default behaviour is to report pass as "valid" (true)
-     * @param {function(problem:string)} problem_consumer when returning false, reasons are supplied here
-     * @return {boolean} true for valid, false for invalid
-     */
-    validate(problem_consumer: any): boolean;
-}
-//# sourceMappingURL=RenderPass.d.ts.map

package/src/engine/graphics/render/frame_graph/RenderPass.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RenderPass.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderPass.js"],"names":[],"mappings":"AAEA;;;;GAIG;AACH;IAsBI;;;OAGG;IACH,0BAQC;IAhCD;;;OAGG;IACH,MAFU,MAAM,CAEK;IAErB;;;OAGG;IACH,OAFU,MAAM,kBAAgB,CAEV;IAGtB;;;;OAIG;IACH,YAAY;IAiBZ;;;;OAIG;IACH,oCAFa,IAAI,CAIhB;IAED;;;;;OAKG;IACH,cALW,IAAI,mEAGF,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iCAFY,OAAO,CAIlB;CACJ"}

package/src/engine/graphics/render/frame_graph/RenderPass.js

@@ -1,74 +0,0 @@
-const DEFAULT_FLAGS = 0;
-
-/**
- * @deprecated new syntax does not require a separate data structure, use lambda functions instead
- * @template [DATA=Object<number>]
- * @class
- */
-export class RenderPass {
-
-    /**
-     * Used for debug and visualisation
-     * @type {string}
-     */
-    name = "Render Pass";
-
-    /**
-     *
-     * @type {number|RenderPassFlags}
-     */
-    flags = DEFAULT_FLAGS;
-
-
-    /**
-     * Arbitrary dictionary of data
-     * @deprecated
-     * @type {Object<number>}
-     */
-    inputs = {};
-
-    /**
-     *
-     * @param [inputs]
-     */
-    constructor(inputs ) {
-
-        if(inputs !== undefined){
-            console.warn("Default inputs are deprecated, please use class fields instead");
-
-            this.inputs = inputs;
-        }
-
-    }
-
-
-    /**
-     *
-     * @param {RenderGraphBuilder} builder
-     * @returns {DATA} resources/handles that are used by the pass, includes both inputs and outputs
-     */
-    setup(builder) {
-        throw new Error('Not Implemented');
-    }
-
-    /**
-     * @param {DATA} data
-     * @param {RenderPassResources} resources
-     * @param {IRenderContext} render_context
-     * @returns {void}
-     */
-    execute(data, resources, render_context) {
-        throw new Error('Not Implemented');
-    }
-
-    /**
-     * Validate render pass internal structure
-     * This is an optional method, mainly useful for debugging purposes
-     * Default behaviour is to report pass as "valid" (true)
-     * @param {function(problem:string)} problem_consumer when returning false, reasons are supplied here
-     * @return {boolean} true for valid, false for invalid
-     */
-    validate(problem_consumer) {
-        return true;
-    }
-}