@babylonjs/core 7.31.2 → 7.32.1

package/FrameGraph/frameGraphRenderContext.js

@@ -0,0 +1,237 @@
+
+import { EffectRenderer } from "../Materials/effectRenderer.js";
+import { CopyTextureToTexture } from "../Misc/copyTextureToTexture.js";
+import { FrameGraphContext } from "./frameGraphContext.js";
+import { backbufferColorTextureHandle, backbufferDepthStencilTextureHandle } from "./frameGraphTypes.js";
+/**
+ * Frame graph context used render passes.
+ * @experimental
+ */
+export class FrameGraphRenderContext extends FrameGraphContext {
+    /** @internal */
+    constructor(_engine, _textureManager) {
+        super();
+        this._engine = _engine;
+        this._textureManager = _textureManager;
+        this._debugMessageHasBeenPushed = false;
+        this._renderTargetIsBound = true;
+        this._effectRenderer = new EffectRenderer(this._engine);
+        this._copyTexture = new CopyTextureToTexture(this._engine);
+        this._currentRenderTargetHandle = backbufferColorTextureHandle;
+    }
+    /**
+     * 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) {
+        return this._textureManager.isBackbuffer(handle);
+    }
+    /**
+     * 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) {
+        return this._textureManager.isBackbufferColor(handle);
+    }
+    /**
+     * 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) {
+        return this._textureManager.isBackbufferDepthStencil(handle);
+    }
+    /**
+     * 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, backBuffer, depth, stencil) {
+        this._applyRenderTarget();
+        this._engine.clear(color, backBuffer, depth, stencil);
+    }
+    /**
+     * Clears the color attachments of the current render target
+     * @param color Defines the color to use
+     * @param attachments The attachments to clear
+     */
+    clearColorAttachments(color, attachments) {
+        this._applyRenderTarget();
+        this._engine.bindAttachments(attachments);
+        this._engine.clear(color, true, false, false);
+    }
+    /**
+     * Binds the attachments to the current render target
+     * @param attachments The attachments to bind
+     */
+    bindAttachments(attachments) {
+        this._applyRenderTarget();
+        this._engine.bindAttachments(attachments);
+    }
+    /**
+     * Generates mipmaps for the current render target
+     */
+    generateMipMaps() {
+        const texture = this._textureManager.getTextureFromHandle(this._currentRenderTargetHandle);
+        if (!texture) {
+            // Texture is backbuffer, no need to generate mipmaps
+            return;
+        }
+        if (this._renderTargetIsBound) {
+            // we can't generate the mipmaps if the texture is bound as a render target
+            this._flushDebugMessages();
+            this._engine.unBindFramebuffer(texture);
+            this._renderTargetIsBound = false;
+        }
+        this._engine.generateMipmaps(texture.texture);
+    }
+    /**
+     * 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, samplingMode) {
+        const internalTexture = this._textureManager.getTextureFromHandle(handle)?.texture;
+        if (internalTexture && internalTexture.samplingMode !== samplingMode) {
+            this._engine.updateTextureSamplingMode(samplingMode, internalTexture);
+        }
+    }
+    /**
+     * 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, name, handle) {
+        const texture = this._textureManager.getTextureFromHandle(handle);
+        if (texture) {
+            effect._bindTexture(name, texture.texture);
+        }
+    }
+    /**
+     * 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, depthWrite) {
+        this._engine.setDepthBuffer(depthTest);
+        this._engine.setDepthWrite(depthWrite);
+    }
+    /**
+     * 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, customBindings) {
+        if (!drawWrapper.effect?.isReady()) {
+            return false;
+        }
+        this._applyRenderTarget();
+        const engineDepthMask = this._engine.getDepthWrite(); // for some reasons, depthWrite is not restored by EffectRenderer.restoreStates
+        this._effectRenderer.saveStates();
+        this._effectRenderer.setViewport();
+        this._engine.enableEffect(drawWrapper);
+        this._engine.setState(false);
+        this._engine.setDepthBuffer(false);
+        this._engine.setDepthWrite(false);
+        this._effectRenderer.bindBuffers(drawWrapper.effect);
+        customBindings?.();
+        this._effectRenderer.draw();
+        this._effectRenderer.restoreStates();
+        this._engine.setDepthWrite(engineDepthMask);
+        this._engine.setAlphaMode(0);
+        return true;
+    }
+    /**
+     * 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, forceCopyToBackbuffer = false) {
+        if (forceCopyToBackbuffer) {
+            this._bindRenderTarget();
+        }
+        this._applyRenderTarget();
+        this._copyTexture.copy(this._textureManager.getTextureFromHandle(sourceTexture).texture);
+    }
+    /**
+     * Renders a RenderTargetTexture or a layer
+     * @param object The RenderTargetTexture/Layer to render
+     */
+    render(object) {
+        this._applyRenderTarget();
+        object.render();
+    }
+    /**
+     * 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 = backbufferColorTextureHandle, debugMessage) {
+        if (renderTargetHandle === this._currentRenderTargetHandle) {
+            this._flushDebugMessages();
+            if (debugMessage !== undefined) {
+                this._engine._debugPushGroup?.(debugMessage, 2);
+                this._debugMessageWhenTargetBound = undefined;
+                this._debugMessageHasBeenPushed = true;
+            }
+            return;
+        }
+        this._currentRenderTargetHandle = renderTargetHandle;
+        this._debugMessageWhenTargetBound = debugMessage;
+        this._renderTargetIsBound = false;
+    }
+    /** @internal */
+    _flushDebugMessages() {
+        if (this._debugMessageHasBeenPushed) {
+            this._engine._debugPopGroup?.(2);
+            this._debugMessageHasBeenPushed = false;
+        }
+    }
+    /** @internal */
+    _shareDepth(srcRenderTargetHandle, dstRenderTargetHandle) {
+        const srcTexture = this._textureManager.getTextureFromHandle(srcRenderTargetHandle);
+        const dstTexture = this._textureManager.getTextureFromHandle(dstRenderTargetHandle);
+        if (srcTexture && dstTexture) {
+            srcTexture.shareDepth(dstTexture);
+        }
+    }
+    _applyRenderTarget() {
+        if (this._renderTargetIsBound) {
+            return;
+        }
+        const handle = this._currentRenderTargetHandle;
+        const textureSlot = this._textureManager._textures.get(handle);
+        const renderTarget = textureSlot.texture;
+        this._flushDebugMessages();
+        if (!renderTarget) {
+            if (handle === backbufferColorTextureHandle || textureSlot.refHandle === backbufferColorTextureHandle) {
+                this._engine.restoreDefaultFramebuffer();
+            }
+            else if (handle === backbufferDepthStencilTextureHandle || textureSlot.refHandle === backbufferDepthStencilTextureHandle) {
+                this._engine.restoreDefaultFramebuffer();
+            }
+        }
+        else {
+            this._engine.bindFramebuffer(renderTarget);
+        }
+        if (this._debugMessageWhenTargetBound !== undefined) {
+            this._engine._debugPushGroup?.(this._debugMessageWhenTargetBound, 2);
+            this._debugMessageWhenTargetBound = undefined;
+            this._debugMessageHasBeenPushed = true;
+        }
+        this._renderTargetIsBound = true;
+    }
+    /** @internal */
+    _dispose() {
+        this._effectRenderer.dispose();
+        this._copyTexture.dispose();
+    }
+}
+//# sourceMappingURL=frameGraphRenderContext.js.map

package/FrameGraph/frameGraphRenderContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameGraphRenderContext.js","sourceRoot":"","sources":["../../../../dev/core/src/FrameGraph/frameGraphRenderContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,mCAAmC,EAAE,MAAM,mBAAmB,CAAC;AAEtG;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAQ1D,gBAAgB;IAChB,YACqB,OAAuB,EACvB,eAAyC;QAE1D,KAAK,EAAE,CAAC;QAHS,YAAO,GAAP,OAAO,CAAgB;QACvB,oBAAe,GAAf,eAAe,CAA0B;QAPtD,+BAA0B,GAAG,KAAK,CAAC;QACnC,yBAAoB,GAAG,IAAI,CAAC;QAShC,IAAI,CAAC,eAAe,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,0BAA0B,GAAG,4BAA4B,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,MAA+B;QAC/C,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,MAA+B;QACpD,OAAO,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,wBAAwB,CAAC,MAA+B;QAC3D,OAAO,IAAI,CAAC,eAAe,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAA4B,EAAE,UAAmB,EAAE,KAAc,EAAE,OAAiB;QAC7F,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,KAA4B,EAAE,WAAqB;QAC5E,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,WAAqB;QACxC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,eAAe;QAClB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC3F,IAAI,CAAC,OAAO,EAAE;YACV,qDAAqD;YACrD,OAAO;SACV;QACD,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC3B,2EAA2E;YAC3E,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;SACrC;QACD,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,OAAQ,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,MAA+B,EAAE,YAAoB;QAC/E,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,OAAQ,CAAC;QACpF,IAAI,eAAe,IAAI,eAAe,CAAC,YAAY,KAAK,YAAY,EAAE;YAClE,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;SACzE;IACL,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,MAAc,EAAE,IAAY,EAAE,MAA+B;QAClF,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAClE,IAAI,OAAO,EAAE;YACT,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,OAAQ,CAAC,CAAC;SAC/C;IACL,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,SAAkB,EAAE,UAAmB;QACzD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,WAAwB,EAAE,cAA2B;QAC9E,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YAChC,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,+EAA+E;QAErI,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;QAClC,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC;QAEnC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACrD,cAAc,EAAE,EAAE,CAAC;QACnB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAEnD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,aAAsC,EAAE,qBAAqB,GAAG,KAAK;QACpF,IAAI,qBAAqB,EAAE;YACvB,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC5B;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,aAAa,CAAE,CAAC,OAAQ,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAmC;QAC7C,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,MAAM,CAAC,MAAM,EAAE,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,qBAA8C,4BAA4B,EAAE,YAAqB;QACtH,IAAI,kBAAkB,KAAK,IAAI,CAAC,0BAA0B,EAAE;YACxD,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC5B,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;gBAChD,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;gBAC9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC;aAC1C;YACD,OAAO;SACV;QACD,IAAI,CAAC,0BAA0B,GAAG,kBAAkB,CAAC;QACrD,IAAI,CAAC,4BAA4B,GAAG,YAAY,CAAC;QACjD,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACtC,CAAC;IAED,gBAAgB;IACT,mBAAmB;QACtB,IAAI,IAAI,CAAC,0BAA0B,EAAE;YACjC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC;SAC3C;IACL,CAAC;IAED,gBAAgB;IACT,WAAW,CAAC,qBAA8C,EAAE,qBAA8C;QAC7G,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;QACpF,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;QAEpF,IAAI,UAAU,IAAI,UAAU,EAAE;YAC1B,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;SACrC;IACL,CAAC;IAEO,kBAAkB;QACtB,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC3B,OAAO;SACV;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,0BAA0B,CAAC;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;QAEhE,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC;QAEzC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAE3B,IAAI,CAAC,YAAY,EAAE;YACf,IAAI,MAAM,KAAK,4BAA4B,IAAI,WAAW,CAAC,SAAS,KAAK,4BAA4B,EAAE;gBACnG,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,CAAC;aAC5C;iBAAM,IAAI,MAAM,KAAK,mCAAmC,IAAI,WAAW,CAAC,SAAS,KAAK,mCAAmC,EAAE;gBACxH,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,CAAC;aAC5C;SACJ;aAAM;YACH,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;SAC9C;QAED,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS,EAAE;YACjD,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;YAC9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC;SAC1C;QAED,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;IACrC,CAAC;IAED,gBAAgB;IACT,QAAQ;QACX,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;CACJ","sourcesContent":["// eslint-disable-next-line import/no-internal-modules\r\nimport type { Nullable, AbstractEngine, DrawWrapper, IColor4Like, Layer, FrameGraphTextureHandle, Effect, FrameGraphTextureManager, RenderTargetTexture } from \"core/index\";\r\nimport { Constants } from \"../Engines/constants\";\r\nimport { EffectRenderer } from \"../Materials/effectRenderer\";\r\nimport { CopyTextureToTexture } from \"../Misc/copyTextureToTexture\";\r\nimport { FrameGraphContext } from \"./frameGraphContext\";\r\nimport { backbufferColorTextureHandle, backbufferDepthStencilTextureHandle } from \"./frameGraphTypes\";\r\n\r\n/**\r\n * Frame graph context used render passes.\r\n * @experimental\r\n */\r\nexport class FrameGraphRenderContext extends FrameGraphContext {\r\n    private readonly _effectRenderer: EffectRenderer;\r\n    private _currentRenderTargetHandle: FrameGraphTextureHandle;\r\n    private _debugMessageWhenTargetBound: string | undefined;\r\n    private _debugMessageHasBeenPushed = false;\r\n    private _renderTargetIsBound = true;\r\n    private readonly _copyTexture: CopyTextureToTexture;\r\n\r\n    /** @internal */\r\n    constructor(\r\n        private readonly _engine: AbstractEngine,\r\n        private readonly _textureManager: FrameGraphTextureManager\r\n    ) {\r\n        super();\r\n        this._effectRenderer = new EffectRenderer(this._engine);\r\n        this._copyTexture = new CopyTextureToTexture(this._engine);\r\n        this._currentRenderTargetHandle = backbufferColorTextureHandle;\r\n    }\r\n\r\n    /**\r\n     * Checks whether a texture handle points to the backbuffer's color or depth texture\r\n     * @param handle The handle to check\r\n     * @returns True if the handle points to the backbuffer's color or depth texture, otherwise false\r\n     */\r\n    public isBackbuffer(handle: FrameGraphTextureHandle): boolean {\r\n        return this._textureManager.isBackbuffer(handle);\r\n    }\r\n\r\n    /**\r\n     * Checks whether a texture handle points to the backbuffer's color texture\r\n     * @param handle The handle to check\r\n     * @returns True if the handle points to the backbuffer's color texture, otherwise false\r\n     */\r\n    public isBackbufferColor(handle: FrameGraphTextureHandle): boolean {\r\n        return this._textureManager.isBackbufferColor(handle);\r\n    }\r\n\r\n    /**\r\n     * Checks whether a texture handle points to the backbuffer's depth texture\r\n     * @param handle The handle to check\r\n     * @returns True if the handle points to the backbuffer's depth texture, otherwise false\r\n     */\r\n    public isBackbufferDepthStencil(handle: FrameGraphTextureHandle): boolean {\r\n        return this._textureManager.isBackbufferDepthStencil(handle);\r\n    }\r\n\r\n    /**\r\n     * Clears the current render buffer or the current render target (if any is set up)\r\n     * @param color Defines the color to use\r\n     * @param backBuffer Defines if the back buffer must be cleared\r\n     * @param depth Defines if the depth buffer must be cleared\r\n     * @param stencil Defines if the stencil buffer must be cleared\r\n     */\r\n    public clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void {\r\n        this._applyRenderTarget();\r\n        this._engine.clear(color, backBuffer, depth, stencil);\r\n    }\r\n\r\n    /**\r\n     * Clears the color attachments of the current render target\r\n     * @param color Defines the color to use\r\n     * @param attachments The attachments to clear\r\n     */\r\n    public clearColorAttachments(color: Nullable<IColor4Like>, attachments: number[]): void {\r\n        this._applyRenderTarget();\r\n        this._engine.bindAttachments(attachments);\r\n        this._engine.clear(color, true, false, false);\r\n    }\r\n\r\n    /**\r\n     * Binds the attachments to the current render target\r\n     * @param attachments The attachments to bind\r\n     */\r\n    public bindAttachments(attachments: number[]): void {\r\n        this._applyRenderTarget();\r\n        this._engine.bindAttachments(attachments);\r\n    }\r\n\r\n    /**\r\n     * Generates mipmaps for the current render target\r\n     */\r\n    public generateMipMaps(): void {\r\n        const texture = this._textureManager.getTextureFromHandle(this._currentRenderTargetHandle);\r\n        if (!texture) {\r\n            // Texture is backbuffer, no need to generate mipmaps\r\n            return;\r\n        }\r\n        if (this._renderTargetIsBound) {\r\n            // we can't generate the mipmaps if the texture is bound as a render target\r\n            this._flushDebugMessages();\r\n            this._engine.unBindFramebuffer(texture);\r\n            this._renderTargetIsBound = false;\r\n        }\r\n        this._engine.generateMipmaps(texture.texture!);\r\n    }\r\n\r\n    /**\r\n     * Sets the texture sampling mode for a given texture handle\r\n     * @param handle Handle of the texture to set the sampling mode for\r\n     * @param samplingMode Sampling mode to set\r\n     */\r\n    public setTextureSamplingMode(handle: FrameGraphTextureHandle, samplingMode: number): void {\r\n        const internalTexture = this._textureManager.getTextureFromHandle(handle)?.texture!;\r\n        if (internalTexture && internalTexture.samplingMode !== samplingMode) {\r\n            this._engine.updateTextureSamplingMode(samplingMode, internalTexture);\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Binds a texture handle to a given effect (resolves the handle to a texture and binds it to the effect)\r\n     * @param effect The effect to bind the texture to\r\n     * @param name The name of the texture in the effect\r\n     * @param handle The handle of the texture to bind\r\n     */\r\n    public bindTextureHandle(effect: Effect, name: string, handle: FrameGraphTextureHandle): void {\r\n        const texture = this._textureManager.getTextureFromHandle(handle);\r\n        if (texture) {\r\n            effect._bindTexture(name, texture.texture!);\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Sets the depth states for the current render target\r\n     * @param depthTest If true, depth testing is enabled\r\n     * @param depthWrite If true, depth writing is enabled\r\n     */\r\n    public setDepthStates(depthTest: boolean, depthWrite: boolean): void {\r\n        this._engine.setDepthBuffer(depthTest);\r\n        this._engine.setDepthWrite(depthWrite);\r\n    }\r\n\r\n    /**\r\n     * Applies a full-screen effect to the current render target\r\n     * @param drawWrapper The draw wrapper containing the effect to apply\r\n     * @param customBindings The custom bindings to use when applying the effect (optional)\r\n     * @returns True if the effect was applied, otherwise false (effect not ready)\r\n     */\r\n    public applyFullScreenEffect(drawWrapper: DrawWrapper, customBindings?: () => void): boolean {\r\n        if (!drawWrapper.effect?.isReady()) {\r\n            return false;\r\n        }\r\n\r\n        this._applyRenderTarget();\r\n\r\n        const engineDepthMask = this._engine.getDepthWrite(); // for some reasons, depthWrite is not restored by EffectRenderer.restoreStates\r\n\r\n        this._effectRenderer.saveStates();\r\n        this._effectRenderer.setViewport();\r\n\r\n        this._engine.enableEffect(drawWrapper);\r\n        this._engine.setState(false);\r\n        this._engine.setDepthBuffer(false);\r\n        this._engine.setDepthWrite(false);\r\n\r\n        this._effectRenderer.bindBuffers(drawWrapper.effect);\r\n        customBindings?.();\r\n        this._effectRenderer.draw();\r\n        this._effectRenderer.restoreStates();\r\n        this._engine.setDepthWrite(engineDepthMask);\r\n        this._engine.setAlphaMode(Constants.ALPHA_DISABLE);\r\n\r\n        return true;\r\n    }\r\n\r\n    /**\r\n     * Copies a texture to the current render target\r\n     * @param sourceTexture The source texture to copy from\r\n     * @param forceCopyToBackbuffer If true, the copy will be done to the back buffer regardless of the current render target\r\n     */\r\n    public copyTexture(sourceTexture: FrameGraphTextureHandle, forceCopyToBackbuffer = false): void {\r\n        if (forceCopyToBackbuffer) {\r\n            this._bindRenderTarget();\r\n        }\r\n        this._applyRenderTarget();\r\n        this._copyTexture.copy(this._textureManager.getTextureFromHandle(sourceTexture)!.texture!);\r\n    }\r\n\r\n    /**\r\n     * Renders a RenderTargetTexture or a layer\r\n     * @param object The RenderTargetTexture/Layer to render\r\n     */\r\n    public render(object: Layer | RenderTargetTexture): void {\r\n        this._applyRenderTarget();\r\n        object.render();\r\n    }\r\n\r\n    /**\r\n     * Binds a render target texture so that upcoming draw calls will render to it\r\n     * Note: it is a lazy operation, so the render target will only be bound when needed. This way, it is possible to call\r\n     *   this method several times with different render targets without incurring the cost of binding if no draw calls are made\r\n     * @internal\r\n     */\r\n    public _bindRenderTarget(renderTargetHandle: FrameGraphTextureHandle = backbufferColorTextureHandle, debugMessage?: string) {\r\n        if (renderTargetHandle === this._currentRenderTargetHandle) {\r\n            this._flushDebugMessages();\r\n            if (debugMessage !== undefined) {\r\n                this._engine._debugPushGroup?.(debugMessage, 2);\r\n                this._debugMessageWhenTargetBound = undefined;\r\n                this._debugMessageHasBeenPushed = true;\r\n            }\r\n            return;\r\n        }\r\n        this._currentRenderTargetHandle = renderTargetHandle;\r\n        this._debugMessageWhenTargetBound = debugMessage;\r\n        this._renderTargetIsBound = false;\r\n    }\r\n\r\n    /** @internal */\r\n    public _flushDebugMessages() {\r\n        if (this._debugMessageHasBeenPushed) {\r\n            this._engine._debugPopGroup?.(2);\r\n            this._debugMessageHasBeenPushed = false;\r\n        }\r\n    }\r\n\r\n    /** @internal */\r\n    public _shareDepth(srcRenderTargetHandle: FrameGraphTextureHandle, dstRenderTargetHandle: FrameGraphTextureHandle) {\r\n        const srcTexture = this._textureManager.getTextureFromHandle(srcRenderTargetHandle);\r\n        const dstTexture = this._textureManager.getTextureFromHandle(dstRenderTargetHandle);\r\n\r\n        if (srcTexture && dstTexture) {\r\n            srcTexture.shareDepth(dstTexture);\r\n        }\r\n    }\r\n\r\n    private _applyRenderTarget() {\r\n        if (this._renderTargetIsBound) {\r\n            return;\r\n        }\r\n\r\n        const handle = this._currentRenderTargetHandle;\r\n        const textureSlot = this._textureManager._textures.get(handle)!;\r\n\r\n        const renderTarget = textureSlot.texture;\r\n\r\n        this._flushDebugMessages();\r\n\r\n        if (!renderTarget) {\r\n            if (handle === backbufferColorTextureHandle || textureSlot.refHandle === backbufferColorTextureHandle) {\r\n                this._engine.restoreDefaultFramebuffer();\r\n            } else if (handle === backbufferDepthStencilTextureHandle || textureSlot.refHandle === backbufferDepthStencilTextureHandle) {\r\n                this._engine.restoreDefaultFramebuffer();\r\n            }\r\n        } else {\r\n            this._engine.bindFramebuffer(renderTarget);\r\n        }\r\n\r\n        if (this._debugMessageWhenTargetBound !== undefined) {\r\n            this._engine._debugPushGroup?.(this._debugMessageWhenTargetBound, 2);\r\n            this._debugMessageWhenTargetBound = undefined;\r\n            this._debugMessageHasBeenPushed = true;\r\n        }\r\n\r\n        this._renderTargetIsBound = true;\r\n    }\r\n\r\n    /** @internal */\r\n    public _dispose() {\r\n        this._effectRenderer.dispose();\r\n        this._copyTexture.dispose();\r\n    }\r\n}\r\n"]}

package/FrameGraph/frameGraphTask.d.ts

@@ -0,0 +1,49 @@
+import type { FrameGraph, IFrameGraphPass } from "../index.js";
+/**
+ * Represents a task in a frame graph.
+ * @experimental
+ */
+export declare abstract class FrameGraphTask {
+    protected _frameGraph: FrameGraph;
+    private _passes;
+    private _passesDisabled;
+    protected _name: string;
+    /**
+     * The name of the task.
+     */
+    get name(): string;
+    set name(value: string);
+    protected _disabled: boolean;
+    /**
+     * Whether the task is disabled.
+     */
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    /**
+     * Records the task in the frame graph. Use this function to add content (render passes, ...) to the task.
+     */
+    abstract record(): void;
+    /**
+     * Checks if the task is ready to be executed.
+     * @returns True if the task is ready to be executed, else false.
+     */
+    isReady(): boolean;
+    /**
+     * Disposes of the task.
+     */
+    dispose(): void;
+    /**
+     * Constructs a new frame graph task.
+     * @param name The name of the task.
+     * @param frameGraph The frame graph this task is associated with.
+     */
+    constructor(name: string, frameGraph: FrameGraph);
+    /** @internal */
+    _reset(): void;
+    /** @internal */
+    _addPass(pass: IFrameGraphPass, disabled: boolean): void;
+    /** @internal */
+    _checkTask(): void;
+    /** @internal */
+    _getPasses(): IFrameGraphPass[];
+}

package/FrameGraph/frameGraphTask.js

@@ -0,0 +1,117 @@
+import { FrameGraphCullPass } from "./Passes/cullPass.js";
+import { FrameGraphRenderPass } from "./Passes/renderPass.js";
+/**
+ * Represents a task in a frame graph.
+ * @experimental
+ */
+export class FrameGraphTask {
+    /**
+     * The name of the task.
+     */
+    get name() {
+        return this._name;
+    }
+    set name(value) {
+        this._name = value;
+    }
+    /**
+     * Whether the task is disabled.
+     */
+    get disabled() {
+        return this._disabled;
+    }
+    set disabled(value) {
+        this._disabled = value;
+    }
+    /**
+     * Checks if the task is ready to be executed.
+     * @returns True if the task is ready to be executed, else false.
+     */
+    isReady() {
+        return true;
+    }
+    /**
+     * Disposes of the task.
+     */
+    dispose() {
+        this._reset();
+    }
+    /**
+     * Constructs a new frame graph task.
+     * @param name The name of the task.
+     * @param frameGraph The frame graph this task is associated with.
+     */
+    constructor(name, frameGraph) {
+        this._passes = [];
+        this._passesDisabled = [];
+        this._disabled = false;
+        this.name = name;
+        this._frameGraph = frameGraph;
+        this._reset();
+    }
+    /** @internal */
+    _reset() {
+        this._passes.length = 0;
+        this._passesDisabled.length = 0;
+    }
+    /** @internal */
+    _addPass(pass, disabled) {
+        if (disabled) {
+            this._passesDisabled.push(pass);
+        }
+        else {
+            this._passes.push(pass);
+        }
+    }
+    /** @internal */
+    _checkTask() {
+        let outputTexture = null;
+        let outputDepthTexture = null;
+        let outputObjectList;
+        for (const pass of this._passes) {
+            const errMsg = pass._isValid();
+            if (errMsg) {
+                throw new Error(`Pass "${pass.name}" is not valid. ${errMsg}`);
+            }
+            if (FrameGraphRenderPass.IsRenderPass(pass)) {
+                outputTexture = this._frameGraph.getTexture(pass.renderTarget);
+                outputDepthTexture = pass.renderTargetDepth !== undefined ? this._frameGraph.getTexture(pass.renderTargetDepth) : null;
+            }
+            else if (FrameGraphCullPass.IsCullPass(pass)) {
+                outputObjectList = pass.objectList;
+            }
+        }
+        let disabledOutputTexture = null;
+        let disabledOutputDepthTexture = null;
+        let disabledOutputObjectList;
+        for (const pass of this._passesDisabled) {
+            const errMsg = pass._isValid();
+            if (errMsg) {
+                throw new Error(`Pass "${pass.name}" is not valid. ${errMsg}`);
+            }
+            if (FrameGraphRenderPass.IsRenderPass(pass)) {
+                disabledOutputTexture = this._frameGraph.getTexture(pass.renderTarget);
+                disabledOutputDepthTexture = pass.renderTargetDepth !== undefined ? this._frameGraph.getTexture(pass.renderTargetDepth) : null;
+            }
+            else if (FrameGraphCullPass.IsCullPass(pass)) {
+                disabledOutputObjectList = pass.objectList;
+            }
+        }
+        if (this._passesDisabled.length > 0) {
+            if (outputTexture !== disabledOutputTexture) {
+                throw new Error(`The output texture of the task "${this.name}" is different when it is enabled or disabled.`);
+            }
+            if (outputDepthTexture !== disabledOutputDepthTexture) {
+                throw new Error(`The output depth texture of the task "${this.name}" is different when it is enabled or disabled.`);
+            }
+            if (outputObjectList !== disabledOutputObjectList) {
+                throw new Error(`The output object list of the task "${this.name}" is different when it is enabled or disabled.`);
+            }
+        }
+    }
+    /** @internal */
+    _getPasses() {
+        return this.disabled && this._passesDisabled.length > 0 ? this._passesDisabled : this._passes;
+    }
+}
+//# sourceMappingURL=frameGraphTask.js.map

package/FrameGraph/frameGraphTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameGraphTask.js","sourceRoot":"","sources":["../../../../dev/core/src/FrameGraph/frameGraphTask.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;;GAGG;AACH,MAAM,OAAgB,cAAc;IAUhC;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,IAAW,IAAI,CAAC,KAAa;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAID;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAW,QAAQ,CAAC,KAAc;QAC9B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IAC3B,CAAC;IAOD;;;OAGG;IACI,OAAO;QACV,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,YAAY,IAAY,EAAE,UAAsB;QAxDxC,YAAO,GAAsB,EAAE,CAAC;QAChC,oBAAe,GAAsB,EAAE,CAAC;QAiBtC,cAAS,GAAG,KAAK,CAAC;QAuCxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IAED,gBAAgB;IACT,MAAM;QACT,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,QAAQ,CAAC,IAAqB,EAAE,QAAiB;QACpD,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACnC;aAAM;YACH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC3B;IACL,CAAC;IAED,gBAAgB;IACT,UAAU;QACb,IAAI,aAAa,GAAkC,IAAI,CAAC;QACxD,IAAI,kBAAkB,GAAkC,IAAI,CAAC;QAC7D,IAAI,gBAAkD,CAAC;QAEvD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAQ,EAAE;YAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,MAAM,EAAE;gBACR,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,mBAAmB,MAAM,EAAE,CAAC,CAAC;aAClE;YACD,IAAI,oBAAoB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;gBACzC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC/D,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;aAC1H;iBAAM,IAAI,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBAC5C,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC;aACtC;SACJ;QAED,IAAI,qBAAqB,GAAkC,IAAI,CAAC;QAChE,IAAI,0BAA0B,GAAkC,IAAI,CAAC;QACrE,IAAI,wBAA0D,CAAC;QAE/D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,eAAgB,EAAE;YACtC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,MAAM,EAAE;gBACR,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,mBAAmB,MAAM,EAAE,CAAC,CAAC;aAClE;YACD,IAAI,oBAAoB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;gBACzC,qBAAqB,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACvE,0BAA0B,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;aAClI;iBAAM,IAAI,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBAC5C,wBAAwB,GAAG,IAAI,CAAC,UAAU,CAAC;aAC9C;SACJ;QAED,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,IAAI,aAAa,KAAK,qBAAqB,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,mCAAmC,IAAI,CAAC,IAAI,gDAAgD,CAAC,CAAC;aACjH;YACD,IAAI,kBAAkB,KAAK,0BAA0B,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,IAAI,gDAAgD,CAAC,CAAC;aACvH;YACD,IAAI,gBAAgB,KAAK,wBAAwB,EAAE;gBAC/C,MAAM,IAAI,KAAK,CAAC,uCAAuC,IAAI,CAAC,IAAI,gDAAgD,CAAC,CAAC;aACrH;SACJ;IACL,CAAC;IAED,gBAAgB;IACT,UAAU;QACb,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IAClG,CAAC;CACJ","sourcesContent":["// eslint-disable-next-line import/no-internal-modules\r\nimport type { RenderTargetWrapper, FrameGraph, FrameGraphObjectList, IFrameGraphPass, Nullable } from \"core/index\";\r\nimport { FrameGraphCullPass } from \"./Passes/cullPass\";\r\nimport { FrameGraphRenderPass } from \"./Passes/renderPass\";\r\n\r\n/**\r\n * Represents a task in a frame graph.\r\n * @experimental\r\n */\r\nexport abstract class FrameGraphTask {\r\n    protected _frameGraph: FrameGraph;\r\n\r\n    private _passes: IFrameGraphPass[] = [];\r\n    private _passesDisabled: IFrameGraphPass[] = [];\r\n\r\n    // Note: must be a getter/setter even if there's no specific processing, otherwise inherited classes can't make it a getter/setter!\r\n    // Same thing for the disabled property\r\n    protected _name: string;\r\n\r\n    /**\r\n     * The name of the task.\r\n     */\r\n    public get name() {\r\n        return this._name;\r\n    }\r\n\r\n    public set name(value: string) {\r\n        this._name = value;\r\n    }\r\n\r\n    protected _disabled = false;\r\n\r\n    /**\r\n     * Whether the task is disabled.\r\n     */\r\n    public get disabled() {\r\n        return this._disabled;\r\n    }\r\n\r\n    public set disabled(value: boolean) {\r\n        this._disabled = value;\r\n    }\r\n\r\n    /**\r\n     * Records the task in the frame graph. Use this function to add content (render passes, ...) to the task.\r\n     */\r\n    public abstract record(): void;\r\n\r\n    /**\r\n     * Checks if the task is ready to be executed.\r\n     * @returns True if the task is ready to be executed, else false.\r\n     */\r\n    public isReady(): boolean {\r\n        return true;\r\n    }\r\n\r\n    /**\r\n     * Disposes of the task.\r\n     */\r\n    public dispose() {\r\n        this._reset();\r\n    }\r\n\r\n    /**\r\n     * Constructs a new frame graph task.\r\n     * @param name The name of the task.\r\n     * @param frameGraph The frame graph this task is associated with.\r\n     */\r\n    constructor(name: string, frameGraph: FrameGraph) {\r\n        this.name = name;\r\n        this._frameGraph = frameGraph;\r\n        this._reset();\r\n    }\r\n\r\n    /** @internal */\r\n    public _reset() {\r\n        this._passes.length = 0;\r\n        this._passesDisabled.length = 0;\r\n    }\r\n\r\n    /** @internal */\r\n    public _addPass(pass: IFrameGraphPass, disabled: boolean) {\r\n        if (disabled) {\r\n            this._passesDisabled.push(pass);\r\n        } else {\r\n            this._passes.push(pass);\r\n        }\r\n    }\r\n\r\n    /** @internal */\r\n    public _checkTask() {\r\n        let outputTexture: Nullable<RenderTargetWrapper> = null;\r\n        let outputDepthTexture: Nullable<RenderTargetWrapper> = null;\r\n        let outputObjectList: FrameGraphObjectList | undefined;\r\n\r\n        for (const pass of this._passes!) {\r\n            const errMsg = pass._isValid();\r\n            if (errMsg) {\r\n                throw new Error(`Pass \"${pass.name}\" is not valid. ${errMsg}`);\r\n            }\r\n            if (FrameGraphRenderPass.IsRenderPass(pass)) {\r\n                outputTexture = this._frameGraph.getTexture(pass.renderTarget);\r\n                outputDepthTexture = pass.renderTargetDepth !== undefined ? this._frameGraph.getTexture(pass.renderTargetDepth) : null;\r\n            } else if (FrameGraphCullPass.IsCullPass(pass)) {\r\n                outputObjectList = pass.objectList;\r\n            }\r\n        }\r\n\r\n        let disabledOutputTexture: Nullable<RenderTargetWrapper> = null;\r\n        let disabledOutputDepthTexture: Nullable<RenderTargetWrapper> = null;\r\n        let disabledOutputObjectList: FrameGraphObjectList | undefined;\r\n\r\n        for (const pass of this._passesDisabled!) {\r\n            const errMsg = pass._isValid();\r\n            if (errMsg) {\r\n                throw new Error(`Pass \"${pass.name}\" is not valid. ${errMsg}`);\r\n            }\r\n            if (FrameGraphRenderPass.IsRenderPass(pass)) {\r\n                disabledOutputTexture = this._frameGraph.getTexture(pass.renderTarget);\r\n                disabledOutputDepthTexture = pass.renderTargetDepth !== undefined ? this._frameGraph.getTexture(pass.renderTargetDepth) : null;\r\n            } else if (FrameGraphCullPass.IsCullPass(pass)) {\r\n                disabledOutputObjectList = pass.objectList;\r\n            }\r\n        }\r\n\r\n        if (this._passesDisabled.length > 0) {\r\n            if (outputTexture !== disabledOutputTexture) {\r\n                throw new Error(`The output texture of the task \"${this.name}\" is different when it is enabled or disabled.`);\r\n            }\r\n            if (outputDepthTexture !== disabledOutputDepthTexture) {\r\n                throw new Error(`The output depth texture of the task \"${this.name}\" is different when it is enabled or disabled.`);\r\n            }\r\n            if (outputObjectList !== disabledOutputObjectList) {\r\n                throw new Error(`The output object list of the task \"${this.name}\" is different when it is enabled or disabled.`);\r\n            }\r\n        }\r\n    }\r\n\r\n    /** @internal */\r\n    public _getPasses(): IFrameGraphPass[] {\r\n        return this.disabled && this._passesDisabled.length > 0 ? this._passesDisabled : this._passes;\r\n    }\r\n}\r\n"]}

package/FrameGraph/frameGraphTextureManager.d.ts

@@ -0,0 +1,50 @@
+import type { Scene, AbstractEngine, RenderTargetWrapper, TextureSize, Nullable, FrameGraphTextureCreationOptions, FrameGraphTextureHandle } from "../index.js";
+import { Texture } from "../Materials/Textures/texture";
+type TextureEntry = {
+    texture: Nullable<RenderTargetWrapper>;
+    name: string;
+    creationOptions: FrameGraphTextureCreationOptions;
+    namespace: FrameGraphTextureNamespace;
+    debug?: Texture;
+    parentHandle?: FrameGraphTextureHandle;
+    parentTextureIndex?: number;
+    refHandle?: FrameGraphTextureHandle;
+};
+declare enum FrameGraphTextureNamespace {
+    Task = 0,
+    Graph = 1,
+    External = 2
+}
+/**
+ * @experimental
+ * @internal
+ */
+export declare class FrameGraphTextureManager {
+    private _engine;
+    private _debugTextures;
+    private _scene?;
+    private static _Counter;
+    _textures: Map<FrameGraphTextureHandle, TextureEntry>;
+    constructor(_engine: AbstractEngine, _debugTextures?: boolean, _scene?: Scene | undefined);
+    isBackbuffer(handle: FrameGraphTextureHandle): boolean;
+    isBackbufferColor(handle: FrameGraphTextureHandle): boolean;
+    isBackbufferDepthStencil(handle: FrameGraphTextureHandle): boolean;
+    getTextureCreationOptions(handle: FrameGraphTextureHandle): FrameGraphTextureCreationOptions;
+    getTextureFromHandle(handle: FrameGraphTextureHandle): Nullable<RenderTargetWrapper>;
+    importTexture(name: string, texture: RenderTargetWrapper, handle?: FrameGraphTextureHandle): FrameGraphTextureHandle;
+    createRenderTargetTexture(name: string, taskNamespace: boolean, creationOptions: FrameGraphTextureCreationOptions, multiTargetMode?: boolean, handle?: FrameGraphTextureHandle): FrameGraphTextureHandle;
+    getAbsoluteDimensions(size: TextureSize, screenWidth?: number, screenHeight?: number): {
+        width: number;
+        height: number;
+    };
+    dispose(): void;
+    allocateTextures(): void;
+    createDanglingHandle(): number;
+    resolveDanglingHandle(danglingHandle: FrameGraphTextureHandle, handle: FrameGraphTextureHandle): void;
+    releaseTextures(releaseAll?: boolean): void;
+    private _addSystemTextures;
+    private _createDebugTexture;
+    private _freeEntry;
+    private _createHandleForTexture;
+}
+export {};