@onerjs/core 8.27.3 → 8.27.4

package/FrameGraph/frameGraphTextureManager.js

@@ -37,10 +37,9 @@ export class FrameGraphTextureManager {
          * Gets or sets a boolean indicating if debug logs should be shown when applying texture allocation optimization (default: false)
          */
         this.showDebugLogsForTextureAllcationOptimization = false;
-        /** If provided (greater than 0), forces the output screen width for percentage-based textures. If not provided (0), engine.getRenderWidth() will be used */
-        this.forcedOutputScreenWidth = 0;
-        /** If provided (greater than 0), forces the output screen height for percentage-based textures. If not provided (0), engine.getRenderHeight() will be used */
-        this.forcedOutputScreenHeight = 0;
+        this._backBufferTextureEntry = null;
+        this._backBufferDepthStencilTextureEntry = null;
+        this._backBufferTextureOverriden = false;
         this._addSystemTextures();
     }
     /**
@@ -49,6 +48,13 @@ export class FrameGraphTextureManager {
      * @returns True if the handle is a backbuffer handle
      */
     isBackbuffer(handle) {
+        if (this._backBufferTextureOverriden) {
+            return false;
+        }
+        return this._isBackbuffer(handle);
+    }
+    /** @internal */
+    _isBackbuffer(handle) {
         if (handle === backbufferColorTextureHandle || handle === backbufferDepthStencilTextureHandle) {
             return true;
         }
@@ -64,6 +70,9 @@ export class FrameGraphTextureManager {
      * @returns True if the handle is a backbuffer color handle
      */
     isBackbufferColor(handle) {
+        if (this._backBufferTextureOverriden) {
+            return false;
+        }
         if (handle === backbufferColorTextureHandle) {
             return true;
         }
@@ -79,6 +88,9 @@ export class FrameGraphTextureManager {
      * @returns True if the handle is a backbuffer depth/stencil handle
      */
     isBackbufferDepthStencil(handle) {
+        if (this._backBufferTextureOverriden) {
+            return false;
+        }
         if (handle === backbufferDepthStencilTextureHandle) {
             return true;
         }
@@ -107,6 +119,7 @@ export class FrameGraphTextureManager {
      * @returns The creation options of the texture
      */
     getTextureCreationOptions(handle) {
+        handle = this._textures.get(handle)?.refHandle ?? handle;
         const entry = this._textures.get(handle);
         const creationOptions = entry.creationOptions;
         return {
@@ -152,16 +165,21 @@ export class FrameGraphTextureManager {
     }
     /**
      * Gets a texture from a handle.
-     * Note that if the texture is a history texture, the read texture for the current frame will be returned.
+     * Note that if the texture is a history texture, the read texture for the current frame will be returned, except if historyGetWriteTexture is true.
      * @param handle The handle of the texture
+     * @param historyGetWriteTexture If true and the texture is a history texture, the write texture for the current frame will be returned (default: false)
      * @returns The texture or null if not found
      */
-    getTextureFromHandle(handle) {
-        const historyEntry = this._historyTextures.get(handle);
+    getTextureFromHandle(handle, historyGetWriteTexture) {
+        const entry = this._textures.get(handle);
+        const refHandle = entry?.refHandle;
+        const finalEntry = refHandle !== undefined ? this._textures.get(refHandle) : entry;
+        const finalHandle = refHandle !== undefined ? refHandle : handle;
+        const historyEntry = this._historyTextures.get(finalHandle);
         if (historyEntry) {
-            return historyEntry.textures[historyEntry.index ^ 1]; // gets the read texture
+            return historyEntry.textures[historyGetWriteTexture ? historyEntry.index : historyEntry.index ^ 1];
         }
-        return this._textures.get(handle).texture;
+        return finalEntry.texture;
     }
     /**
      * Imports a texture into the texture manager
@@ -264,6 +282,7 @@ export class FrameGraphTextureManager {
         if (textureEntry === undefined) {
             throw new Error(`resolveDanglingHandle: Handle ${handle} does not exist!`);
         }
+        handle = textureEntry.refHandle ?? handle; // gets the refHandle if handle is a (resolved) dangling handle itself
         this._textures.set(danglingHandle, {
             texture: textureEntry.texture,
             refHandle: handle,
@@ -286,8 +305,9 @@ export class FrameGraphTextureManager {
      * @returns The absolute dimensions of the texture
      */
     getAbsoluteDimensions(size, screenWidth, screenHeight) {
-        screenWidth = this.forcedOutputScreenWidth || this.engine.getRenderWidth(true);
-        screenHeight = this.forcedOutputScreenHeight || this.engine.getRenderHeight(true);
+        const backbufferColorTextureSize = this._textures.get(backbufferColorTextureHandle).creationOptions.size;
+        screenWidth = backbufferColorTextureSize.width;
+        screenHeight = backbufferColorTextureSize.height;
         const { width, height } = getDimensionsFromTextureSize(size);
         return {
             width: Math.floor((width * screenWidth) / 100),
@@ -304,7 +324,8 @@ export class FrameGraphTextureManager {
     computeTotalTextureSize(optimizedSize, outputWidth, outputHeight) {
         let totalSize = 0;
         this._textures.forEach((entry, handle) => {
-            if (handle === backbufferColorTextureHandle || handle === backbufferDepthStencilTextureHandle || entry.refHandle !== undefined) {
+            if ((!this._backBufferTextureOverriden && (handle === backbufferColorTextureHandle || handle === backbufferDepthStencilTextureHandle)) ||
+                entry.refHandle !== undefined) {
                 return;
             }
             if (optimizedSize && entry.aliasHandle !== undefined) {
@@ -327,6 +348,105 @@ export class FrameGraphTextureManager {
         });
         return totalSize;
     }
+    /**
+     * True if the back buffer texture has been overriden by a call to setBackBufferTexture
+     */
+    get backBufferTextureOverriden() {
+        return this._backBufferTextureOverriden;
+    }
+    /**
+     * Overrides the default back buffer color/depth-stencil textures used by the frame graph.
+     * Note that if both textureCreationOptions and depthStencilTextureCreationOptions are provided,
+     * the engine will use them to create the back buffer color and depth/stencil textures respectively.
+     * In that case, width and height are ignored.
+     * @param width The width of the back buffer color/depth-stencil texture (if 0, the engine's current back buffer color/depth-stencil texture width will be used)
+     * @param height The height of the back buffer color/depth-stencil texture (if 0, the engine's current back buffer color/depth-stencil texture height will be used)
+     * @param textureCreationOptions The color texture creation options (optional)
+     * @param depthStencilTextureCreationOptions The depth/stencil texture creation options (optional)
+     */
+    setBackBufferTextures(width, height, textureCreationOptions, depthStencilTextureCreationOptions) {
+        if ((width === 0 || height === 0) && (!textureCreationOptions || !depthStencilTextureCreationOptions)) {
+            if (this._backBufferTextureOverriden) {
+                let entry = this._textures.get(backbufferColorTextureHandle);
+                entry.texture?.dispose();
+                entry.texture = null;
+                entry.debug?.dispose();
+                entry.debug = undefined;
+                entry = this._textures.get(backbufferDepthStencilTextureHandle);
+                entry.texture?.dispose();
+                entry.texture = null;
+                entry.debug?.dispose();
+                entry.debug = undefined;
+            }
+            this._backBufferTextureEntry = null;
+            this._backBufferDepthStencilTextureEntry = null;
+            this._backBufferTextureOverriden = false;
+            this._addSystemTextures();
+            return;
+        }
+        this._backBufferTextureOverriden = true;
+        const size = { width, height };
+        this._backBufferTextureEntry = {
+            name: "backbuffer color",
+            texture: null,
+            creationOptions: textureCreationOptions ?? {
+                size,
+                options: {
+                    createMipMaps: false,
+                    samples: this.engine.getCreationOptions().antialias ? 4 : 1,
+                    types: [0],
+                    formats: [5],
+                    useSRGBBuffers: [false],
+                    creationFlags: [0],
+                    labels: ["backbuffer color"],
+                },
+                sizeIsPercentage: false,
+            },
+            namespace: FrameGraphTextureNamespace.Graph,
+            lifespan: {
+                firstTask: Number.MAX_VALUE,
+                lastTask: 0,
+            },
+        };
+        this._backBufferTextureEntry.textureDescriptionHash = this._createTextureDescriptionHash(this._backBufferTextureEntry.creationOptions);
+        this._backBufferDepthStencilTextureEntry = {
+            name: "backbuffer depth/stencil",
+            texture: null,
+            creationOptions: depthStencilTextureCreationOptions ?? {
+                size,
+                options: {
+                    createMipMaps: false,
+                    samples: this.engine.getCreationOptions().antialias ? 4 : 1,
+                    types: [0],
+                    formats: [this.engine.isStencilEnable ? 13 : 14],
+                    useSRGBBuffers: [false],
+                    creationFlags: [0],
+                    labels: ["backbuffer depth/stencil"],
+                },
+                sizeIsPercentage: false,
+            },
+            namespace: FrameGraphTextureNamespace.Graph,
+            lifespan: {
+                firstTask: Number.MAX_VALUE,
+                lastTask: 0,
+            },
+        };
+        this._backBufferDepthStencilTextureEntry.textureDescriptionHash = this._createTextureDescriptionHash(this._backBufferDepthStencilTextureEntry.creationOptions);
+        this._addSystemTextures();
+    }
+    /**
+     * Resets the back buffer color/depth-stencil textures to the default (the engine's current back buffer textures)
+     * It has no effect if setBackBufferTextures has not been called before.
+     */
+    resetBackBufferTextures() {
+        this.setBackBufferTextures(0, 0);
+    }
+    /**
+     * Returns true if the texture manager has at least one history texture
+     */
+    get hasHistoryTextures() {
+        return this._historyTextures.size > 0;
+    }
     /** @internal */
     _dispose() {
         this._releaseTextures();
@@ -420,6 +540,7 @@ export class FrameGraphTextureManager {
             entry.texture = null;
             if (releaseAll || entry.namespace === FrameGraphTextureNamespace.Task) {
                 this._textures.delete(handle);
+                this._historyTextures.delete(handle);
             }
         });
         this._historyTextures.forEach((entry) => {
@@ -447,7 +568,7 @@ export class FrameGraphTextureManager {
     }
     _addSystemTextures() {
         const size = { width: this.engine.getRenderWidth(true), height: this.engine.getRenderHeight(true) };
-        this._textures.set(backbufferColorTextureHandle, {
+        this._textures.set(backbufferColorTextureHandle, this._backBufferTextureEntry ?? {
             name: "backbuffer color",
             texture: null,
             creationOptions: {
@@ -465,7 +586,7 @@ export class FrameGraphTextureManager {
             },
             namespace: FrameGraphTextureNamespace.External,
         });
-        this._textures.set(backbufferDepthStencilTextureHandle, {
+        this._textures.set(backbufferDepthStencilTextureHandle, this._backBufferDepthStencilTextureEntry ?? {
             name: "backbuffer depth/stencil",
             texture: null,
             creationOptions: {
@@ -665,6 +786,9 @@ export class FrameGraphTextureManager {
         const iterator = dependencies.keys();
         for (let key = iterator.next(); key.done !== true; key = iterator.next()) {
             const textureHandle = key.value;
+            if (this.isBackbuffer(textureHandle)) {
+                continue;
+            }
             let textureEntry = this._textures.get(textureHandle);
             if (!textureEntry) {
                 throw new Error(`FrameGraph._computeTextureLifespan: Texture handle "${textureHandle}" not found in the texture manager.`);