@woosh/meep-engine 2.111.11 → 2.111.12

package/package.json

@@ -5,7 +5,7 @@
   "description": "Fully featured ECS game engine written in JavaScript",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.111.11",
+  "version": "2.111.12",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

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

@@ -3,18 +3,6 @@
  */
 export class IRenderContext {
     resource_manager: RenderResourceManager;
-    /**
-     *
-     * @param {TextureDescriptor} descriptor
-     * @returns {RenderTarget}
-     */
-    createRenderTarget(descriptor: TextureDescriptor): RenderTarget;
-    /**
-     *
-     * @param {RenderTarget} target
-     * @returns {boolean}
-     */
-    destroyRenderTarget(target: RenderTarget): boolean;
     /**
      * @template T
      * @param {ResourceDescriptor<T>} descriptor

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

@@ -1 +1 @@
-{"version":3,"file":"IRenderContext.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/IRenderContext.js"],"names":[],"mappings":"AAIA;;GAEG;AACH;IAEI,wCAA+C;IAO/C;;;;OAIG;IACH,gEAEC;IAED;;;;OAIG;IACH,2CAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,wDAEC;IAED;;;;;OAKG;IACH,+EAEC;IAED,gBAEC;CACJ;sCAtDqC,qCAAqC"}
+{"version":3,"file":"IRenderContext.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/IRenderContext.js"],"names":[],"mappings":"AAIA;;GAEG;AACH;IAEI,wCAA+C;IAM/C;;;;OAIG;IACH,wDAEC;IAED;;;;;OAKG;IACH,+EAEC;IAED,gBAEC;CACJ;sCAnCqC,qCAAqC"}

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

@@ -13,25 +13,6 @@ export class IRenderContext {
         this.resource_manager.attach(this);
     }
 
-
-    /**
-     *
-     * @param {TextureDescriptor} descriptor
-     * @returns {RenderTarget}
-     */
-    createRenderTarget(descriptor) {
-        throw new Error('Not Implemented')
-    }
-
-    /**
-     *
-     * @param {RenderTarget} target
-     * @returns {boolean}
-     */
-    destroyRenderTarget(target) {
-        throw new Error('Not Implemented')
-    }
-
     /**
      * @template T
      * @param {ResourceDescriptor<T>} descriptor

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

@@ -75,11 +75,11 @@ export class RenderGraph {
     /**
      * @template T
      * @param {string} name
-     * @param {TextureDescriptor} description
+     * @param {ResourceDescriptor<T>} description
      * @param {T} resource
      * @returns {number}
      */
-    import_resource<T_2>(name: string, description: TextureDescriptor, resource: T_2): number;
+    import_resource<T_2>(name: string, description: ResourceDescriptor<T_2>, resource: T_2): number;
     /**
      * @returns {boolean}
      * @param id
@@ -91,6 +91,14 @@ export class RenderGraph {
      * @returns {T} resources/handles returned by {@link RenderPass#setup}
      */
     add<T_3>(pass: RenderPass): T_3;
+    /**
+     * Perform validation, useful for debugging
+     * Typically done before compilation
+     * @param {function(problem:string):*} problem_consumer
+     * @param {*} [problem_consumer_context] thisArg for `problem_consumer`
+     * @returns {boolean}
+     */
+    validate(problem_consumer: any, problem_consumer_context?: any): boolean;
     compile(): void;
     /**
      *

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;IACI;;;;OAIG;IACH,iBAAc;IAEd;;;;OAIG;IACH,qBAAkB;IAElB;;;;OAIG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAyB;IAEzB;;;;OAIG;IACH,qBAHW,MAAM,sBAahB;IAED;;;;OAIG;IACH,oBAHW,MAAM,qBAgBhB;IAED;;;;OAIG;IACH,qBAHW,MAAM,KAKhB;IAED;;;;OAIG;IACH,2BAHW,MAAM,2BAOhB;IAED;;;;;OAKG;IACH,6BAUC;IAED;;;;;;OAMG;IACH,4BAcC;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACJ,MAAM,CAkBlB;IAED;;;;;;OAMG;IACH,2BALW,MAAM,kDAGJ,MAAM,CAUlB;IAED;;;OAGG;IACH,4BAHa,OAAO,CAQnB;IAED;;;;OAIG;IACH,gCAsBC;IAED,gBA0FC;IAED;;;OAGG;IACH,uCA6BC;IAED;;;OAGG;IACH,eAFY,MAAM,CAiEjB;CACJ;8BAzZ6B,oBAAoB;6BACrB,mBAAmB"}
+{"version":3,"file":"RenderGraph.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderGraph.js"],"names":[],"mappings":"AAQA;;;GAGG;AACH;IACI;;;;OAIG;IACH,iBAAc;IAEd;;;;OAIG;IACH,qBAAkB;IAElB;;;;OAIG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAyB;IAEzB;;;;OAIG;IACH,qBAHW,MAAM,sBAahB;IAED;;;;OAIG;IACH,oBAHW,MAAM,qBAgBhB;IAED;;;;OAIG;IACH,qBAHW,MAAM,KAKhB;IAED;;;;OAIG;IACH,2BAHW,MAAM,2BAOhB;IAED;;;;;OAKG;IACH,6BAUC;IAED;;;;;;OAMG;IACH,4BAcC;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACJ,MAAM,CAkBlB;IAED;;;;;;OAMG;IACH,2BALW,MAAM,wDAGJ,MAAM,CAUlB;IAED;;;OAGG;IACH,4BAHa,OAAO,CAQnB;IAED;;;;OAIG;IACH,gCA0BC;IAED;;;;;;OAMG;IACH,iEAFa,OAAO,CAOnB;IAED,gBA0FC;IAED;;;OAGG;IACH,uCAqCC;IAED;;;OAGG;IACH,eAFY,MAAM,CAiEjB;CACJ;8BAnb6B,oBAAoB;6BACrB,mBAAmB"}

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

@@ -163,7 +163,7 @@ export class RenderGraph {
     /**
      * @template T
      * @param {string} name
-     * @param {TextureDescriptor} description
+     * @param {ResourceDescriptor<T>} description
      * @param {T} resource
      * @returns {number}
      */
@@ -210,6 +210,10 @@ export class RenderGraph {
 
         const result = pass.setup(builder, pass.inputs);
 
+        assert.defined(result, 'result');
+        assert.notNull(result, 'result');
+        assert.isObject(result, 'result');
+
         this.__passes.push(pass);
 
         node.data = result;
@@ -217,6 +221,20 @@ export class RenderGraph {
         return result;
     }
 
+    /**
+     * Perform validation, useful for debugging
+     * Typically done before compilation
+     * @param {function(problem:string):*} problem_consumer
+     * @param {*} [problem_consumer_context] thisArg for `problem_consumer`
+     * @returns {boolean}
+     */
+    validate(problem_consumer, problem_consumer_context) {
+
+        // TODO implement
+
+        return true;
+    }
+
     compile() {
         const pass_nodes = this.__pass_nodes;
 
@@ -314,8 +332,13 @@ export class RenderGraph {
      * @param {IRenderContext} context
      */
     execute(context) {
+        assert.defined(context, 'context');
+        assert.notNull(context, 'context');
+        assert.isObject(context, 'context');
+
         const pass_nodes = this.__pass_nodes;
         const pass_node_count = pass_nodes.length;
+
         for (let i = 0; i < pass_node_count; i++) {
             const node = pass_nodes[i];
 
@@ -323,7 +346,10 @@ export class RenderGraph {
                 continue;
             }
 
-            for (const id of node.resource_creates) {
+            const node_created_resources = node.resource_creates;
+
+            for (const id of node_created_resources) {
+
                 // allocate resource
                 this.getResourceEntry(id).create(context.resource_manager);
             }

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

@@ -22,14 +22,23 @@ export class RenderPass<DATA> {
      *
      * @param {RenderGraphBuilder} builder
      * @param {Object<number>} inputs
-     * @returns {Object<number>}
+     * @returns {Object<number>} resources/handles that are used by the pass, includes both inputs and outputs
      */
     setup(builder: RenderGraphBuilder, inputs: any): any;
     /**
      * @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 +1 @@
-{"version":3,"file":"RenderPass.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderPass.js"],"names":[],"mappings":"AAEA;;GAEG;AACH;IAqBI,yBAEC;IArBD;;;OAGG;IACH,MAFU,MAAM,CAEK;IAErB;;;OAGG;IACH,OAFU,MAAM,kBAAgB,CAEV;IAGtB;;;OAGG;IACH,YAAY;IAOZ;;;;;OAKG;IACH,qDAEC;IAED;;;;OAIG;IACH,cAJW,IAAI,wEAMd;CACJ"}
+{"version":3,"file":"RenderPass.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderPass.js"],"names":[],"mappings":"AAEA;;GAEG;AACH;IAqBI,yBAEC;IArBD;;;OAGG;IACH,MAFU,MAAM,CAEK;IAErB;;;OAGG;IACH,OAFU,MAAM,kBAAgB,CAEV;IAGtB;;;OAGG;IACH,YAAY;IAOZ;;;;;OAKG;IACH,qDAEC;IAED;;;;;OAKG;IACH,cALW,IAAI,mEAGF,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iCAFY,OAAO,CAIlB;CACJ"}

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

@@ -33,7 +33,7 @@ export class RenderPass {
      *
      * @param {RenderGraphBuilder} builder
      * @param {Object<number>} inputs
-     * @returns {Object<number>}
+     * @returns {Object<number>} resources/handles that are used by the pass, includes both inputs and outputs
      */
     setup(builder, inputs) {
         throw new Error('Not Implemented');
@@ -43,8 +43,20 @@ export class RenderPass {
      * @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;
+    }
 }

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

@@ -11,9 +11,9 @@ export class RenderPassNode extends GraphNode {
     has_side_effects: boolean;
     /**
      *
-     * @type {null}
+     * @type {Object}
      */
-    data: null;
+    data: any;
     /**
      * IDs of created resources
      * @type {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":"AAGA;IACI;;;OAGG;IACH,MAFU,aAAW,IAAI,CAEb;IAGZ;;;OAGG;IACH,kBAFU,OAAO,CAEQ;IAEzB;;;OAGG;IACH,MAFU,IAAI,CAEF;IAEZ;;;OAGG;IACH,kBAFU,MAAM,EAAE,CAEI;IACtB;;;OAGG;IACH,gBAFU,MAAM,EAAE,CAEE;IACpB;;;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;0BArGyB,gBAAgB"}
+{"version":3,"file":"RenderPassNode.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/render/frame_graph/RenderPassNode.js"],"names":[],"mappings":"AAGA;IACI;;;OAGG;IACH,MAFU,aAAW,IAAI,CAEb;IAGZ;;;OAGG;IACH,kBAFU,OAAO,CAEQ;IAEzB;;;OAGG;IACH,UAAU;IAEV;;;OAGG;IACH,kBAFU,MAAM,EAAE,CAEI;IACtB;;;OAGG;IACH,gBAFU,MAAM,EAAE,CAEE;IACpB;;;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;0BArGyB,gBAAgB"}

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

@@ -17,9 +17,9 @@ export class RenderPassNode extends GraphNode {
 
     /**
      *
-     * @type {null}
+     * @type {Object}
      */
-    data = null;
+    data = {};
 
     /**
      * IDs of created resources

package/src/engine/graphics/render/frame_graph/backend/void/VoidRenderContext.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Doesn't actually do anything, but works as a valid rendering context
+ * Mainly used for testing
+ */
+export class VoidRenderContext extends IRenderContext {
+    static INSTANCE: VoidRenderContext;
+    createResource(descriptor: any): any;
+    destroyResource(resource: any, descriptor: any): void;
+}
+import { IRenderContext } from "../../IRenderContext.js";
+//# sourceMappingURL=VoidRenderContext.d.ts.map

package/src/engine/graphics/render/frame_graph/backend/void/VoidRenderContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VoidRenderContext.d.ts","sourceRoot":"","sources":["../../../../../../../../src/engine/graphics/render/frame_graph/backend/void/VoidRenderContext.js"],"names":[],"mappings":"AAEA;;;GAGG;AACH;IAQI,mCAA0C;IAP1C,qCAEC;IAED,sDACC;CAGJ;+BAf8B,yBAAyB"}

package/src/engine/graphics/render/frame_graph/backend/void/VoidRenderContext.js

@@ -0,0 +1,16 @@
+import { IRenderContext } from "../../IRenderContext.js";
+
+/**
+ * Doesn't actually do anything, but works as a valid rendering context
+ * Mainly used for testing
+ */
+export class VoidRenderContext extends IRenderContext {
+    createResource(descriptor) {
+        return null;
+    }
+
+    destroyResource(resource, descriptor) {
+    }
+
+    static INSTANCE = new VoidRenderContext();
+}

package/src/engine/graphics/render/frame_graph/resource/ResourceDescriptor.d.ts

@@ -13,5 +13,12 @@ export class ResourceDescriptor {
      * @return {boolean}
      */
     get isResourceDescriptor(): boolean;
+    hash(): number;
+    /**
+     * @template T {ResourceDescriptor}
+     * @param {T} other
+     * @returns {boolean}
+     */
+    equals<T>(other: T): boolean;
 }
 //# sourceMappingURL=ResourceDescriptor.d.ts.map

package/src/engine/graphics/render/frame_graph/resource/ResourceDescriptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ResourceDescriptor.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/render/frame_graph/resource/ResourceDescriptor.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;IAEI;;;;OAIG;IACH,mBAEC;IAED;;;OAGG;IACH,oCAEC;CACJ"}
+{"version":3,"file":"ResourceDescriptor.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/render/frame_graph/resource/ResourceDescriptor.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;IAEI;;;;OAIG;IACH,mBAEC;IAED;;;OAGG;IACH,oCAEC;IAGD,eAEC;IAED;;;;OAIG;IACH,qBAFa,OAAO,CAInB;CAEJ"}

package/src/engine/graphics/render/frame_graph/resource/ResourceDescriptor.js

@@ -19,4 +19,19 @@ export class ResourceDescriptor {
     get isResourceDescriptor() {
         return true;
     }
+
+
+    hash() {
+        return 0;
+    }
+
+    /**
+     * @template T {ResourceDescriptor}
+     * @param {T} other
+     * @returns {boolean}
+     */
+    equals(other) {
+        return this.type === other.type;
+    }
+
 }

package/src/engine/graphics/render/frame_graph/resource/TextureDescriptor.d.ts

@@ -31,7 +31,6 @@ export class TextureDescriptor extends ResourceDescriptor {
      * @type {number}
      */
     initial_state: number;
-    hash(): number;
     /**
      *
      * @param {TextureDescriptor} other

package/src/engine/graphics/render/frame_graph/resource/TextureDescriptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextureDescriptor.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/render/frame_graph/resource/TextureDescriptor.js"],"names":[],"mappings":"AAMA;IA2DI;;;;;;0BAiBC;IA1ED;;;OAGG;IACH,QAFU,MAAM,CAEL;IACX;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,QAFU,cAAc,CAEM;IAE9B;;;OAGG;IACH,eAFU,MAAM,CAEE;IAElB;;;OAGG;IACH,eAFU,MAAM,CAE0B;IAM1C,eAOC;IAED;;;;OAIG;IACH,cAHW,iBAAiB,GACf,OAAO,CASnB;CAqBJ;mCAhFkC,yBAAyB;+BAH7B,mDAAmD"}
+{"version":3,"file":"TextureDescriptor.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/render/frame_graph/resource/TextureDescriptor.js"],"names":[],"mappings":"AAMA;IAoEI;;;;;;0BAiBC;IAnFD;;;OAGG;IACH,QAFU,MAAM,CAEL;IACX;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,QAFU,cAAc,CAEM;IAE9B;;;OAGG;IACH,eAFU,MAAM,CAEE;IAElB;;;OAGG;IACH,eAFU,MAAM,CAE0B;IAe1C;;;;OAIG;IACH,cAHW,iBAAiB,GACf,OAAO,CAkBnB;CAqBJ;mCAzFkC,yBAAyB;+BAH7B,mDAAmD"}

package/src/engine/graphics/render/frame_graph/resource/TextureDescriptor.js

@@ -54,6 +54,15 @@ export class TextureDescriptor extends ResourceDescriptor {
      * @returns {boolean}
      */
     equals(other) {
+        if (this === other) {
+            // shortcut
+            return true;
+        }
+
+        if (!super.equals(other)) {
+            return false;
+        }
+
         return this.width === other.width
             && this.height === other.height
             && this.format === other.format

package/src/engine/graphics/render/frame_graph/webgl/WebGLRenderContext.d.ts

@@ -4,6 +4,8 @@ export class WebGLRenderContext extends IRenderContext {
      * @param {WebGL2RenderingContext} ctx
      */
     constructor(ctx: WebGL2RenderingContext);
+    createResource(descriptor: any): RenderTarget;
+    destroyResource(resource: any, descriptor: any): boolean;
     /**
      *
      * @param {TextureDescriptor} descriptor

package/src/engine/graphics/render/frame_graph/webgl/WebGLRenderContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebGLRenderContext.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/render/frame_graph/webgl/WebGLRenderContext.js"],"names":[],"mappings":"AAGA;IAOI;;;OAGG;IACH,iBAFW,sBAAsB,EAMhC;IAED;;;OAGG;IACH,gEASC;IAED,0CAEC;;CACJ;+BAtC8B,sBAAsB;6BACxB,6BAA6B"}
+{"version":3,"file":"WebGLRenderContext.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/render/frame_graph/webgl/WebGLRenderContext.js"],"names":[],"mappings":"AAGA;IAOI;;;OAGG;IACH,iBAFW,sBAAsB,EAMhC;IAED,8CAQC;IAED,yDAWC;IAED;;;OAGG;IACH,gEASC;IAED,0CAEC;;CACJ;+BA7D8B,sBAAsB;6BACxB,6BAA6B"}

package/src/engine/graphics/render/frame_graph/webgl/WebGLRenderContext.js

@@ -18,6 +18,29 @@ export class WebGLRenderContext extends IRenderContext {
         this.#gl = ctx;
     }
 
+    createResource(descriptor) {
+        const resource_type = descriptor.type;
+
+        if(resource_type === "texture"){
+            return this.createRenderTarget(descriptor);
+        }
+
+        throw new Error(`Unsupported resource type ${resource_type}`);
+    }
+
+    destroyResource(resource, descriptor) {
+
+
+        const resource_type = descriptor.type;
+
+        if(resource_type === "texture"){
+            return this.destroyRenderTarget(resource);
+        }
+
+        throw new Error(`Unsupported resource type ${resource_type}`);
+
+    }
+
     /**
      *
      * @param {TextureDescriptor} descriptor