@babylonjs/core 7.31.2 → 7.32.1

package/FrameGraph/frameGraph.js

@@ -0,0 +1,275 @@
+import { FrameGraphPass } from "./Passes/pass.js";
+import { FrameGraphRenderPass } from "./Passes/renderPass.js";
+import { FrameGraphCullPass } from "./Passes/cullPass.js";
+import { FrameGraphRenderContext } from "./frameGraphRenderContext.js";
+import { FrameGraphContext } from "./frameGraphContext.js";
+import { FrameGraphTextureManager } from "./frameGraphTextureManager.js";
+import { Observable } from "../Misc/observable.js";
+import { getDimensionsFromTextureSize, textureSizeIsObject } from "../Materials/Textures/textureCreationOptions.js";
+var FrameGraphPassType;
+(function (FrameGraphPassType) {
+    FrameGraphPassType[FrameGraphPassType["Render"] = 0] = "Render";
+    FrameGraphPassType[FrameGraphPassType["Cull"] = 1] = "Cull";
+    FrameGraphPassType[FrameGraphPassType["Compute"] = 2] = "Compute";
+})(FrameGraphPassType || (FrameGraphPassType = {}));
+/**
+ * Class used to implement a frame graph
+ * @experimental
+ */
+export class FrameGraph {
+    /**
+     * Gets the engine used by the frame graph
+     */
+    get engine() {
+        return this._engine;
+    }
+    /**
+     * Constructs the frame graph
+     * @param engine defines the hosting engine
+     * @param debugTextures defines a boolean indicating that textures created by the frame graph should be visible in the inspector
+     * @param scene defines the scene in which debugging textures are to be created
+     */
+    constructor(engine, debugTextures = false, scene) {
+        this._tasks = [];
+        this._currentProcessedTask = null;
+        /**
+         * Observable raised when the node render graph is built
+         */
+        this.onBuildObservable = new Observable();
+        this._engine = engine;
+        this._textureManager = new FrameGraphTextureManager(this._engine, debugTextures, scene);
+        this._passContext = new FrameGraphContext();
+        this._renderContext = new FrameGraphRenderContext(this._engine, this._textureManager);
+    }
+    /**
+     * Gets a task by name
+     * @param name Name of the task to get
+     * @returns The task or undefined if not found
+     */
+    getTaskByName(name) {
+        return this._tasks.find((t) => t.name === name);
+    }
+    /**
+     * Adds a task to the frame graph
+     * @param task Task to add
+     */
+    addTask(task) {
+        if (this._currentProcessedTask !== null) {
+            throw new Error(`FrameGraph.addTask: Can't add the task "${task.name}" while another task is currently building (task: ${this._currentProcessedTask.name}).`);
+        }
+        this._tasks.push(task);
+    }
+    /**
+     * Adds a render pass to a task. This method can only be called during a Task.record execution.
+     * @param name The name of the pass
+     * @param whenTaskDisabled If true, the pass will be added to the list of passes to execute when the task is disabled (default is false)
+     * @returns The render pass created
+     */
+    addRenderPass(name, whenTaskDisabled = false) {
+        return this._addPass(name, FrameGraphPassType.Render, whenTaskDisabled);
+    }
+    /**
+     * Adds a cull pass to a task. This method can only be called during a Task.record execution.
+     * @param name The name of the pass
+     * @param whenTaskDisabled If true, the pass will be added to the list of passes to execute when the task is disabled (default is false)
+     * @returns The cull pass created
+     */
+    addCullPass(name, whenTaskDisabled = false) {
+        return this._addPass(name, FrameGraphPassType.Cull, whenTaskDisabled);
+    }
+    _addPass(name, passType, whenTaskDisabled = false) {
+        if (!this._currentProcessedTask) {
+            throw new Error("FrameGraph: A pass must be created during a Task.record execution only.");
+        }
+        let pass;
+        switch (passType) {
+            case FrameGraphPassType.Render:
+                pass = new FrameGraphRenderPass(name, this._currentProcessedTask, this._renderContext, this._engine);
+                break;
+            case FrameGraphPassType.Cull:
+                pass = new FrameGraphCullPass(name, this._currentProcessedTask, this._passContext, this._engine);
+                break;
+            default:
+                pass = new FrameGraphPass(name, this._currentProcessedTask, this._passContext);
+                break;
+        }
+        this._currentProcessedTask._addPass(pass, whenTaskDisabled);
+        return pass;
+    }
+    /**
+     * Builds the frame graph.
+     * This method should be called after all tasks have been added to the frame graph (FrameGraph.addTask) and before the graph is executed (FrameGraph.execute).
+     */
+    build() {
+        this._textureManager.releaseTextures(false);
+        for (const task of this._tasks) {
+            task._reset();
+            this._currentProcessedTask = task;
+            task.record();
+            this._currentProcessedTask = null;
+        }
+        this._textureManager.allocateTextures();
+        for (const task of this._tasks) {
+            task._checkTask();
+        }
+        this.onBuildObservable.notifyObservers(this);
+    }
+    /**
+     * Returns a promise that resolves when the frame graph is ready to be executed
+     * This method must be called after the graph has been built (FrameGraph.build called)!
+     * @param timeout Timeout in ms between retries (default is 16)
+     * @returns The promise that resolves when the graph is ready
+     */
+    whenReadyAsync(timeout = 16) {
+        return new Promise((resolve) => {
+            const checkReady = () => {
+                let ready = true;
+                for (const task of this._tasks) {
+                    ready && (ready = task.isReady());
+                }
+                if (ready) {
+                    resolve();
+                }
+                else {
+                    setTimeout(checkReady, timeout);
+                }
+            };
+            checkReady();
+        });
+    }
+    /**
+     * Executes the frame graph.
+     */
+    execute() {
+        this._renderContext._bindRenderTarget();
+        for (const task of this._tasks) {
+            const passes = task._getPasses();
+            for (const pass of passes) {
+                pass._execute();
+            }
+        }
+    }
+    /**
+     * Imports a texture into the frame graph
+     * @param name Name of the texture
+     * @param texture Texture to import
+     * @param handle Existing handle to use for the texture. If not provided (default), a new handle will be created.
+     * @returns The handle to the texture
+     */
+    importTexture(name, texture, handle) {
+        return this._textureManager.importTexture(name, texture, handle);
+    }
+    /**
+     * Gets the creation options of a texture
+     * @param handle Handle of the texture
+     * @param cloneOptions If true, the options will be cloned before being returned (default is false)
+     * @returns The creation options of the texture
+     */
+    getTextureCreationOptions(handle, cloneOptions = false) {
+        const creationOptions = this._textureManager.getTextureCreationOptions(handle);
+        return cloneOptions
+            ? {
+                size: getDimensionsFromTextureSize(creationOptions.size),
+                options: { ...creationOptions.options },
+                sizeIsPercentage: creationOptions.sizeIsPercentage,
+            }
+            : creationOptions;
+    }
+    /**
+     * Gets the description of a texture
+     * @param handle Handle of the texture
+     * @returns The description of the texture
+     */
+    getTextureDescription(handle) {
+        const creationOptions = this.getTextureCreationOptions(handle);
+        const size = !creationOptions.sizeIsPercentage
+            ? textureSizeIsObject(creationOptions.size)
+                ? { width: creationOptions.size.width, height: creationOptions.size.height }
+                : { width: creationOptions.size, height: creationOptions.size }
+            : this._textureManager.getAbsoluteDimensions(creationOptions.size);
+        return {
+            size,
+            options: { ...creationOptions.options },
+        };
+    }
+    /**
+     * Gets a texture handle or creates a new texture if the handle is not provided.
+     * @param handle If provided, will simply return the handle
+     * @param newTextureName Name of the new texture to create
+     * @param creationOptions Options to use when creating the new texture
+     * @returns The handle to the texture. If handle is not provided, newTextureName and creationOptions must be provided.
+     */
+    getTextureHandleOrCreateTexture(handle, newTextureName, creationOptions) {
+        if (handle === undefined) {
+            if (newTextureName === undefined || creationOptions === undefined) {
+                throw new Error("getTextureHandleOrCreateTexture: Either handle or newTextureName and creationOptions must be provided.");
+            }
+            return this.createRenderTargetTexture(newTextureName, creationOptions);
+        }
+        return handle;
+    }
+    /**
+     * Gets a texture from a handle
+     * @param handle The handle of the texture
+     * @returns The texture or null if not found
+     */
+    getTexture(handle) {
+        return this._textureManager.getTextureFromHandle(handle);
+    }
+    /**
+     * Creates a new render target texture
+     * @param name Name of the texture
+     * @param creationOptions Options to use when creating the texture
+     * @param multiTargetMode If true, the texture will be created in multi target mode (default is false). In this mode, a handle is created for each target separately, in addition to the handle created for the main render target texture itself.
+     * @returns The handle to the texture
+     */
+    createRenderTargetTexture(name, creationOptions, multiTargetMode = false) {
+        return this._textureManager.createRenderTargetTexture(name, !!this._currentProcessedTask, creationOptions, multiTargetMode);
+    }
+    /**
+     * Creates a handle which is not associated with any texture.
+     * Call resolveDanglingHandle to associate the handle with a valid texture handle.
+     * @returns The dangling handle
+     */
+    createDanglingHandle() {
+        return this._textureManager.createDanglingHandle();
+    }
+    /**
+     * Associates a texture with a dangling handle
+     * @param danglingHandle The dangling handle
+     * @param handle The handle to associate with the dangling handle (if not provided, a new texture handle will be created)
+     * @param newTextureName The name of the new texture to create (if handle is not provided)
+     * @param creationOptions The options to use when creating the new texture (if handle is not provided)
+     */
+    resolveDanglingHandle(danglingHandle, handle, newTextureName, creationOptions) {
+        if (handle === undefined) {
+            if (newTextureName === undefined || creationOptions === undefined) {
+                throw new Error("resolveDanglingHandle: Either handle or newTextureName and creationOptions must be provided.");
+            }
+            this._textureManager.createRenderTargetTexture(newTextureName, !!this._currentProcessedTask, creationOptions, false, danglingHandle);
+            return;
+        }
+        this._textureManager.resolveDanglingHandle(danglingHandle, handle);
+    }
+    /**
+     * Clears the frame graph (remove the tasks and release the textures).
+     * The frame graph can be built again after this method is called.
+     */
+    clear() {
+        for (const task of this._tasks) {
+            task._reset();
+        }
+        this._tasks.length = 0;
+        this._textureManager.releaseTextures();
+        this._currentProcessedTask = null;
+    }
+    /**
+     * Disposes the frame graph
+     */
+    dispose() {
+        this.clear();
+        this._textureManager.dispose();
+        this._renderContext._dispose();
+    }
+}
+//# sourceMappingURL=frameGraph.js.map

package/FrameGraph/frameGraph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameGraph.js","sourceRoot":"","sources":["../../../../dev/core/src/FrameGraph/frameGraph.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,8BAA6B;AAClD,OAAO,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AAEjH,IAAK,kBAIJ;AAJD,WAAK,kBAAkB;IACnB,+DAAU,CAAA;IACV,2DAAQ,CAAA;IACR,iEAAW,CAAA;AACf,CAAC,EAJI,kBAAkB,KAAlB,kBAAkB,QAItB;AAED;;;GAGG;AACH,MAAM,OAAO,UAAU;IAgBnB;;OAEG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,YAAY,MAAsB,EAAE,aAAa,GAAG,KAAK,EAAE,KAAa;QArBhE,WAAM,GAAqB,EAAE,CAAC;QAC9B,0BAAqB,GAA0B,IAAI,CAAC;QAE5D;;WAEG;QACI,sBAAiB,GAAG,IAAI,UAAU,EAAc,CAAC;QAgBpD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,IAAI,wBAAwB,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QACxF,IAAI,CAAC,YAAY,GAAG,IAAI,iBAAiB,EAAE,CAAC;QAC5C,IAAI,CAAC,cAAc,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACI,aAAa,CAA2B,IAAY;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAM,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,IAAoB;QAC/B,IAAI,IAAI,CAAC,qBAAqB,KAAK,IAAI,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,2CAA2C,IAAI,CAAC,IAAI,qDAAqD,IAAI,CAAC,qBAAqB,CAAC,IAAI,IAAI,CAAC,CAAC;SACjK;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,IAAY,EAAE,gBAAgB,GAAG,KAAK;QACvD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,CAAyB,CAAC;IACpG,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,IAAY,EAAE,gBAAgB,GAAG,KAAK;QACrD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,EAAE,gBAAgB,CAAuB,CAAC;IAChG,CAAC;IAEO,QAAQ,CAAC,IAAY,EAAE,QAA4B,EAAE,gBAAgB,GAAG,KAAK;QACjF,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;SAC9F;QAED,IAAI,IAA8D,CAAC;QAEnE,QAAQ,QAAQ,EAAE;YACd,KAAK,kBAAkB,CAAC,MAAM;gBAC1B,IAAI,GAAG,IAAI,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrG,MAAM;YACV,KAAK,kBAAkB,CAAC,IAAI;gBACxB,IAAI,GAAG,IAAI,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBACjG,MAAM;YACV;gBACI,IAAI,GAAG,IAAI,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC/E,MAAM;SACb;QAED,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAE5D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,KAAK;QACR,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAE5C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC5B,IAAI,CAAC,MAAM,EAAE,CAAC;YAEd,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;YAElC,IAAI,CAAC,MAAM,EAAE,CAAC;YAEd,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;SACrC;QAED,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE,CAAC;QAExC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC5B,IAAI,CAAC,UAAU,EAAE,CAAC;SACrB;QAED,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,OAAO,GAAG,EAAE;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,KAAK,GAAG,IAAI,CAAC;gBACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;oBAC5B,KAAK,KAAL,KAAK,GAAK,IAAI,CAAC,OAAO,EAAE,EAAC;iBAC5B;gBACD,IAAI,KAAK,EAAE;oBACP,OAAO,EAAE,CAAC;iBACb;qBAAM;oBACH,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;iBACnC;YACL,CAAC,CAAC;YAEF,UAAU,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC;QAExC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAEjC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE;gBACvB,IAAI,CAAC,QAAQ,EAAE,CAAC;aACnB;SACJ;IACL,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,IAAY,EAAE,OAA4B,EAAE,MAAgC;QAC7F,OAAO,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,yBAAyB,CAAC,MAA+B,EAAE,YAAY,GAAG,KAAK;QAClF,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAE/E,OAAO,YAAY;YACf,CAAC,CAAC;gBACI,IAAI,EAAE,4BAA4B,CAAC,eAAe,CAAC,IAAI,CAAC;gBACxD,OAAO,EAAE,EAAE,GAAG,eAAe,CAAC,OAAO,EAAE;gBACvC,gBAAgB,EAAE,eAAe,CAAC,gBAAgB;aACrD;YACH,CAAC,CAAC,eAAe,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,MAA+B;QACxD,MAAM,eAAe,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAE/D,MAAM,IAAI,GAAG,CAAC,eAAe,CAAC,gBAAgB;YAC1C,CAAC,CAAC,mBAAmB,CAAC,eAAe,CAAC,IAAI,CAAC;gBACvC,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE;gBAC5E,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,CAAC,IAAI,EAAE;YACnE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,qBAAqB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEvE,OAAO;YACH,IAAI;YACJ,OAAO,EAAE,EAAE,GAAG,eAAe,CAAC,OAAO,EAAE;SAC1C,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,+BAA+B,CAAC,MAAgC,EAAE,cAAuB,EAAE,eAAkD;QAChJ,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,cAAc,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,EAAE;gBAC/D,MAAM,IAAI,KAAK,CAAC,wGAAwG,CAAC,CAAC;aAC7H;YACD,OAAO,IAAI,CAAC,yBAAyB,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;SAC1E;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAA+B;QAC7C,OAAO,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,yBAAyB,CAAC,IAAY,EAAE,eAAiD,EAAE,eAAe,GAAG,KAAK;QACrH,OAAO,IAAI,CAAC,eAAe,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,qBAAqB,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;IAChI,CAAC;IAED;;;;OAIG;IACI,oBAAoB;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC,oBAAoB,EAAE,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CACxB,cAAuC,EACvC,MAAgC,EAChC,cAAuB,EACvB,eAAkD;QAElD,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,cAAc,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,EAAE;gBAC/D,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;aACnH;YACD,IAAI,CAAC,eAAe,CAAC,yBAAyB,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,qBAAqB,EAAE,eAAe,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YACrI,OAAO;SACV;QAED,IAAI,CAAC,eAAe,CAAC,qBAAqB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,KAAK;QACR,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC5B,IAAI,CAAC,MAAM,EAAE,CAAC;SACjB;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC;QACvC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;IACnC,CAAC;CACJ","sourcesContent":["/* eslint-disable import/no-internal-modules */\r\nimport type {\r\n    Scene,\r\n    AbstractEngine,\r\n    RenderTargetWrapper,\r\n    FrameGraphTextureCreationOptions,\r\n    FrameGraphTextureHandle,\r\n    FrameGraphTextureDescription,\r\n    Nullable,\r\n    FrameGraphTask,\r\n} from \"core/index\";\r\nimport { FrameGraphPass } from \"./Passes/pass\";\r\nimport { FrameGraphRenderPass } from \"./Passes/renderPass\";\r\nimport { FrameGraphCullPass } from \"./Passes/cullPass\";\r\nimport { FrameGraphRenderContext } from \"./frameGraphRenderContext\";\r\nimport { FrameGraphContext } from \"./frameGraphContext\";\r\nimport { FrameGraphTextureManager } from \"./frameGraphTextureManager\";\r\nimport { Observable } from \"core/Misc/observable\";\r\nimport { getDimensionsFromTextureSize, textureSizeIsObject } from \"../Materials/Textures/textureCreationOptions\";\r\n\r\nenum FrameGraphPassType {\r\n    Render = 0,\r\n    Cull = 1,\r\n    Compute = 2,\r\n}\r\n\r\n/**\r\n * Class used to implement a frame graph\r\n * @experimental\r\n */\r\nexport class FrameGraph {\r\n    /** @internal */\r\n    public readonly _passContext: FrameGraphContext;\r\n    /** @internal */\r\n    public readonly _renderContext: FrameGraphRenderContext;\r\n\r\n    private readonly _engine: AbstractEngine;\r\n    private readonly _textureManager: FrameGraphTextureManager;\r\n    private _tasks: FrameGraphTask[] = [];\r\n    private _currentProcessedTask: FrameGraphTask | null = null;\r\n\r\n    /**\r\n     * Observable raised when the node render graph is built\r\n     */\r\n    public onBuildObservable = new Observable<FrameGraph>();\r\n\r\n    /**\r\n     * Gets the engine used by the frame graph\r\n     */\r\n    public get engine() {\r\n        return this._engine;\r\n    }\r\n\r\n    /**\r\n     * Constructs the frame graph\r\n     * @param engine defines the hosting engine\r\n     * @param debugTextures defines a boolean indicating that textures created by the frame graph should be visible in the inspector\r\n     * @param scene defines the scene in which debugging textures are to be created\r\n     */\r\n    constructor(engine: AbstractEngine, debugTextures = false, scene?: Scene) {\r\n        this._engine = engine;\r\n        this._textureManager = new FrameGraphTextureManager(this._engine, debugTextures, scene);\r\n        this._passContext = new FrameGraphContext();\r\n        this._renderContext = new FrameGraphRenderContext(this._engine, this._textureManager);\r\n    }\r\n\r\n    /**\r\n     * Gets a task by name\r\n     * @param name Name of the task to get\r\n     * @returns The task or undefined if not found\r\n     */\r\n    public getTaskByName<T extends FrameGraphTask>(name: string): T | undefined {\r\n        return this._tasks.find((t) => t.name === name) as T;\r\n    }\r\n\r\n    /**\r\n     * Adds a task to the frame graph\r\n     * @param task Task to add\r\n     */\r\n    public addTask(task: FrameGraphTask): void {\r\n        if (this._currentProcessedTask !== null) {\r\n            throw new Error(`FrameGraph.addTask: Can't add the task \"${task.name}\" while another task is currently building (task: ${this._currentProcessedTask.name}).`);\r\n        }\r\n\r\n        this._tasks.push(task);\r\n    }\r\n\r\n    /**\r\n     * Adds a render pass to a task. This method can only be called during a Task.record execution.\r\n     * @param name The name of the pass\r\n     * @param whenTaskDisabled If true, the pass will be added to the list of passes to execute when the task is disabled (default is false)\r\n     * @returns The render pass created\r\n     */\r\n    public addRenderPass(name: string, whenTaskDisabled = false): FrameGraphRenderPass {\r\n        return this._addPass(name, FrameGraphPassType.Render, whenTaskDisabled) as FrameGraphRenderPass;\r\n    }\r\n\r\n    /**\r\n     * Adds a cull pass to a task. This method can only be called during a Task.record execution.\r\n     * @param name The name of the pass\r\n     * @param whenTaskDisabled If true, the pass will be added to the list of passes to execute when the task is disabled (default is false)\r\n     * @returns The cull pass created\r\n     */\r\n    public addCullPass(name: string, whenTaskDisabled = false): FrameGraphCullPass {\r\n        return this._addPass(name, FrameGraphPassType.Cull, whenTaskDisabled) as FrameGraphCullPass;\r\n    }\r\n\r\n    private _addPass(name: string, passType: FrameGraphPassType, whenTaskDisabled = false): FrameGraphPass<FrameGraphContext> | FrameGraphRenderPass {\r\n        if (!this._currentProcessedTask) {\r\n            throw new Error(\"FrameGraph: A pass must be created during a Task.record execution only.\");\r\n        }\r\n\r\n        let pass: FrameGraphPass<FrameGraphContext> | FrameGraphRenderPass;\r\n\r\n        switch (passType) {\r\n            case FrameGraphPassType.Render:\r\n                pass = new FrameGraphRenderPass(name, this._currentProcessedTask, this._renderContext, this._engine);\r\n                break;\r\n            case FrameGraphPassType.Cull:\r\n                pass = new FrameGraphCullPass(name, this._currentProcessedTask, this._passContext, this._engine);\r\n                break;\r\n            default:\r\n                pass = new FrameGraphPass(name, this._currentProcessedTask, this._passContext);\r\n                break;\r\n        }\r\n\r\n        this._currentProcessedTask._addPass(pass, whenTaskDisabled);\r\n\r\n        return pass;\r\n    }\r\n\r\n    /**\r\n     * Builds the frame graph.\r\n     * This method should be called after all tasks have been added to the frame graph (FrameGraph.addTask) and before the graph is executed (FrameGraph.execute).\r\n     */\r\n    public build(): void {\r\n        this._textureManager.releaseTextures(false);\r\n\r\n        for (const task of this._tasks) {\r\n            task._reset();\r\n\r\n            this._currentProcessedTask = task;\r\n\r\n            task.record();\r\n\r\n            this._currentProcessedTask = null;\r\n        }\r\n\r\n        this._textureManager.allocateTextures();\r\n\r\n        for (const task of this._tasks) {\r\n            task._checkTask();\r\n        }\r\n\r\n        this.onBuildObservable.notifyObservers(this);\r\n    }\r\n\r\n    /**\r\n     * Returns a promise that resolves when the frame graph is ready to be executed\r\n     * This method must be called after the graph has been built (FrameGraph.build called)!\r\n     * @param timeout Timeout in ms between retries (default is 16)\r\n     * @returns The promise that resolves when the graph is ready\r\n     */\r\n    public whenReadyAsync(timeout = 16): Promise<void> {\r\n        return new Promise((resolve) => {\r\n            const checkReady = () => {\r\n                let ready = true;\r\n                for (const task of this._tasks) {\r\n                    ready &&= task.isReady();\r\n                }\r\n                if (ready) {\r\n                    resolve();\r\n                } else {\r\n                    setTimeout(checkReady, timeout);\r\n                }\r\n            };\r\n\r\n            checkReady();\r\n        });\r\n    }\r\n\r\n    /**\r\n     * Executes the frame graph.\r\n     */\r\n    public execute(): void {\r\n        this._renderContext._bindRenderTarget();\r\n\r\n        for (const task of this._tasks) {\r\n            const passes = task._getPasses();\r\n\r\n            for (const pass of passes) {\r\n                pass._execute();\r\n            }\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Imports a texture into the frame graph\r\n     * @param name Name of the texture\r\n     * @param texture Texture to import\r\n     * @param handle Existing handle to use for the texture. If not provided (default), a new handle will be created.\r\n     * @returns The handle to the texture\r\n     */\r\n    public importTexture(name: string, texture: RenderTargetWrapper, handle?: FrameGraphTextureHandle): FrameGraphTextureHandle {\r\n        return this._textureManager.importTexture(name, texture, handle);\r\n    }\r\n\r\n    /**\r\n     * Gets the creation options of a texture\r\n     * @param handle Handle of the texture\r\n     * @param cloneOptions If true, the options will be cloned before being returned (default is false)\r\n     * @returns The creation options of the texture\r\n     */\r\n    public getTextureCreationOptions(handle: FrameGraphTextureHandle, cloneOptions = false): FrameGraphTextureCreationOptions {\r\n        const creationOptions = this._textureManager.getTextureCreationOptions(handle);\r\n\r\n        return cloneOptions\r\n            ? {\r\n                  size: getDimensionsFromTextureSize(creationOptions.size),\r\n                  options: { ...creationOptions.options },\r\n                  sizeIsPercentage: creationOptions.sizeIsPercentage,\r\n              }\r\n            : creationOptions;\r\n    }\r\n\r\n    /**\r\n     * Gets the description of a texture\r\n     * @param handle Handle of the texture\r\n     * @returns The description of the texture\r\n     */\r\n    public getTextureDescription(handle: FrameGraphTextureHandle): FrameGraphTextureDescription {\r\n        const creationOptions = this.getTextureCreationOptions(handle);\r\n\r\n        const size = !creationOptions.sizeIsPercentage\r\n            ? textureSizeIsObject(creationOptions.size)\r\n                ? { width: creationOptions.size.width, height: creationOptions.size.height }\r\n                : { width: creationOptions.size, height: creationOptions.size }\r\n            : this._textureManager.getAbsoluteDimensions(creationOptions.size);\r\n\r\n        return {\r\n            size,\r\n            options: { ...creationOptions.options },\r\n        };\r\n    }\r\n\r\n    /**\r\n     * Gets a texture handle or creates a new texture if the handle is not provided.\r\n     * @param handle If provided, will simply return the handle\r\n     * @param newTextureName Name of the new texture to create\r\n     * @param creationOptions Options to use when creating the new texture\r\n     * @returns The handle to the texture. If handle is not provided, newTextureName and creationOptions must be provided.\r\n     */\r\n    public getTextureHandleOrCreateTexture(handle?: FrameGraphTextureHandle, newTextureName?: string, creationOptions?: FrameGraphTextureCreationOptions): FrameGraphTextureHandle {\r\n        if (handle === undefined) {\r\n            if (newTextureName === undefined || creationOptions === undefined) {\r\n                throw new Error(\"getTextureHandleOrCreateTexture: Either handle or newTextureName and creationOptions must be provided.\");\r\n            }\r\n            return this.createRenderTargetTexture(newTextureName, creationOptions);\r\n        }\r\n        return handle;\r\n    }\r\n\r\n    /**\r\n     * Gets a texture from a handle\r\n     * @param handle The handle of the texture\r\n     * @returns The texture or null if not found\r\n     */\r\n    public getTexture(handle: FrameGraphTextureHandle): Nullable<RenderTargetWrapper> {\r\n        return this._textureManager.getTextureFromHandle(handle);\r\n    }\r\n\r\n    /**\r\n     * Creates a new render target texture\r\n     * @param name Name of the texture\r\n     * @param creationOptions Options to use when creating the texture\r\n     * @param multiTargetMode If true, the texture will be created in multi target mode (default is false). In this mode, a handle is created for each target separately, in addition to the handle created for the main render target texture itself.\r\n     * @returns The handle to the texture\r\n     */\r\n    public createRenderTargetTexture(name: string, creationOptions: FrameGraphTextureCreationOptions, multiTargetMode = false): FrameGraphTextureHandle {\r\n        return this._textureManager.createRenderTargetTexture(name, !!this._currentProcessedTask, creationOptions, multiTargetMode);\r\n    }\r\n\r\n    /**\r\n     * Creates a handle which is not associated with any texture.\r\n     * Call resolveDanglingHandle to associate the handle with a valid texture handle.\r\n     * @returns The dangling handle\r\n     */\r\n    public createDanglingHandle(): FrameGraphTextureHandle {\r\n        return this._textureManager.createDanglingHandle();\r\n    }\r\n\r\n    /**\r\n     * Associates a texture with a dangling handle\r\n     * @param danglingHandle The dangling handle\r\n     * @param handle The handle to associate with the dangling handle (if not provided, a new texture handle will be created)\r\n     * @param newTextureName The name of the new texture to create (if handle is not provided)\r\n     * @param creationOptions The options to use when creating the new texture (if handle is not provided)\r\n     */\r\n    public resolveDanglingHandle(\r\n        danglingHandle: FrameGraphTextureHandle,\r\n        handle?: FrameGraphTextureHandle,\r\n        newTextureName?: string,\r\n        creationOptions?: FrameGraphTextureCreationOptions\r\n    ) {\r\n        if (handle === undefined) {\r\n            if (newTextureName === undefined || creationOptions === undefined) {\r\n                throw new Error(\"resolveDanglingHandle: Either handle or newTextureName and creationOptions must be provided.\");\r\n            }\r\n            this._textureManager.createRenderTargetTexture(newTextureName, !!this._currentProcessedTask, creationOptions, false, danglingHandle);\r\n            return;\r\n        }\r\n\r\n        this._textureManager.resolveDanglingHandle(danglingHandle, handle);\r\n    }\r\n\r\n    /**\r\n     * Clears the frame graph (remove the tasks and release the textures).\r\n     * The frame graph can be built again after this method is called.\r\n     */\r\n    public clear(): void {\r\n        for (const task of this._tasks) {\r\n            task._reset();\r\n        }\r\n\r\n        this._tasks.length = 0;\r\n        this._textureManager.releaseTextures();\r\n        this._currentProcessedTask = null;\r\n    }\r\n\r\n    /**\r\n     * Disposes the frame graph\r\n     */\r\n    public dispose(): void {\r\n        this.clear();\r\n        this._textureManager.dispose();\r\n        this._renderContext._dispose();\r\n    }\r\n}\r\n"]}

package/FrameGraph/frameGraphContext.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Base class for frame graph context.
+ */
+export declare class FrameGraphContext {
+}

package/FrameGraph/frameGraphContext.js

@@ -0,0 +1,6 @@
+/**
+ * Base class for frame graph context.
+ */
+export class FrameGraphContext {
+}
+//# sourceMappingURL=frameGraphContext.js.map

package/FrameGraph/frameGraphContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameGraphContext.js","sourceRoot":"","sources":["../../../../dev/core/src/FrameGraph/frameGraphContext.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,iBAAiB;CAAG","sourcesContent":["/**\r\n * Base class for frame graph context.\r\n */\r\nexport class FrameGraphContext {}\r\n"]}

package/FrameGraph/frameGraphObjectList.d.ts

@@ -0,0 +1,15 @@
+import type { Nullable, AbstractMesh, IParticleSystem } from "../index.js";
+/**
+ * Structure used by the frame graph to reference objects.
+ * @experimental
+ */
+export declare class FrameGraphObjectList {
+    /**
+     * The meshes in the object list.
+     */
+    meshes: Nullable<AbstractMesh[]>;
+    /**
+     * The particle systems in the object list.
+     */
+    particleSystems: Nullable<IParticleSystem[]>;
+}

package/FrameGraph/frameGraphObjectList.js

@@ -0,0 +1,7 @@
+/**
+ * Structure used by the frame graph to reference objects.
+ * @experimental
+ */
+export class FrameGraphObjectList {
+}
+//# sourceMappingURL=frameGraphObjectList.js.map

package/FrameGraph/frameGraphObjectList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameGraphObjectList.js","sourceRoot":"","sources":["../../../../dev/core/src/FrameGraph/frameGraphObjectList.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,OAAO,oBAAoB;CAUhC","sourcesContent":["// eslint-disable-next-line import/no-internal-modules\r\nimport type { Nullable, AbstractMesh, IParticleSystem } from \"core/index\";\r\n\r\n/**\r\n * Structure used by the frame graph to reference objects.\r\n * @experimental\r\n */\r\nexport class FrameGraphObjectList {\r\n    /**\r\n     * The meshes in the object list.\r\n     */\r\n    meshes: Nullable<AbstractMesh[]>;\r\n    /**\r\n     * The particle systems in the object list.\r\n     */\r\n    particleSystems: Nullable<IParticleSystem[]>;\r\n    // todo: sprites?\r\n}\r\n"]}

package/FrameGraph/frameGraphRenderContext.d.ts

@@ -0,0 +1,110 @@
+import type { Nullable, AbstractEngine, DrawWrapper, IColor4Like, Layer, FrameGraphTextureHandle, Effect, FrameGraphTextureManager, RenderTargetTexture } from "../index.js";
+import { FrameGraphContext } from "./frameGraphContext";
+/**
+ * Frame graph context used render passes.
+ * @experimental
+ */
+export declare class FrameGraphRenderContext extends FrameGraphContext {
+    private readonly _engine;
+    private readonly _textureManager;
+    private readonly _effectRenderer;
+    private _currentRenderTargetHandle;
+    private _debugMessageWhenTargetBound;
+    private _debugMessageHasBeenPushed;
+    private _renderTargetIsBound;
+    private readonly _copyTexture;
+    /** @internal */
+    constructor(_engine: AbstractEngine, _textureManager: FrameGraphTextureManager);
+    /**
+     * Checks whether a texture handle points to the backbuffer's color or depth texture
+     * @param handle The handle to check
+     * @returns True if the handle points to the backbuffer's color or depth texture, otherwise false
+     */
+    isBackbuffer(handle: FrameGraphTextureHandle): boolean;
+    /**
+     * Checks whether a texture handle points to the backbuffer's color texture
+     * @param handle The handle to check
+     * @returns True if the handle points to the backbuffer's color texture, otherwise false
+     */
+    isBackbufferColor(handle: FrameGraphTextureHandle): boolean;
+    /**
+     * Checks whether a texture handle points to the backbuffer's depth texture
+     * @param handle The handle to check
+     * @returns True if the handle points to the backbuffer's depth texture, otherwise false
+     */
+    isBackbufferDepthStencil(handle: FrameGraphTextureHandle): boolean;
+    /**
+     * Clears the current render buffer or the current render target (if any is set up)
+     * @param color Defines the color to use
+     * @param backBuffer Defines if the back buffer must be cleared
+     * @param depth Defines if the depth buffer must be cleared
+     * @param stencil Defines if the stencil buffer must be cleared
+     */
+    clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
+    /**
+     * Clears the color attachments of the current render target
+     * @param color Defines the color to use
+     * @param attachments The attachments to clear
+     */
+    clearColorAttachments(color: Nullable<IColor4Like>, attachments: number[]): void;
+    /**
+     * Binds the attachments to the current render target
+     * @param attachments The attachments to bind
+     */
+    bindAttachments(attachments: number[]): void;
+    /**
+     * Generates mipmaps for the current render target
+     */
+    generateMipMaps(): void;
+    /**
+     * Sets the texture sampling mode for a given texture handle
+     * @param handle Handle of the texture to set the sampling mode for
+     * @param samplingMode Sampling mode to set
+     */
+    setTextureSamplingMode(handle: FrameGraphTextureHandle, samplingMode: number): void;
+    /**
+     * Binds a texture handle to a given effect (resolves the handle to a texture and binds it to the effect)
+     * @param effect The effect to bind the texture to
+     * @param name The name of the texture in the effect
+     * @param handle The handle of the texture to bind
+     */
+    bindTextureHandle(effect: Effect, name: string, handle: FrameGraphTextureHandle): void;
+    /**
+     * Sets the depth states for the current render target
+     * @param depthTest If true, depth testing is enabled
+     * @param depthWrite If true, depth writing is enabled
+     */
+    setDepthStates(depthTest: boolean, depthWrite: boolean): void;
+    /**
+     * Applies a full-screen effect to the current render target
+     * @param drawWrapper The draw wrapper containing the effect to apply
+     * @param customBindings The custom bindings to use when applying the effect (optional)
+     * @returns True if the effect was applied, otherwise false (effect not ready)
+     */
+    applyFullScreenEffect(drawWrapper: DrawWrapper, customBindings?: () => void): boolean;
+    /**
+     * Copies a texture to the current render target
+     * @param sourceTexture The source texture to copy from
+     * @param forceCopyToBackbuffer If true, the copy will be done to the back buffer regardless of the current render target
+     */
+    copyTexture(sourceTexture: FrameGraphTextureHandle, forceCopyToBackbuffer?: boolean): void;
+    /**
+     * Renders a RenderTargetTexture or a layer
+     * @param object The RenderTargetTexture/Layer to render
+     */
+    render(object: Layer | RenderTargetTexture): void;
+    /**
+     * Binds a render target texture so that upcoming draw calls will render to it
+     * Note: it is a lazy operation, so the render target will only be bound when needed. This way, it is possible to call
+     *   this method several times with different render targets without incurring the cost of binding if no draw calls are made
+     * @internal
+     */
+    _bindRenderTarget(renderTargetHandle?: FrameGraphTextureHandle, debugMessage?: string): void;
+    /** @internal */
+    _flushDebugMessages(): void;
+    /** @internal */
+    _shareDepth(srcRenderTargetHandle: FrameGraphTextureHandle, dstRenderTargetHandle: FrameGraphTextureHandle): void;
+    private _applyRenderTarget;
+    /** @internal */
+    _dispose(): void;
+}