@needle-tools/engine 4.6.0-next.ffc175e → 4.6.1

package/src/engine-components/postprocessing/PostProcessingHandler.ts

@@ -1,5 +1,5 @@
 import type { Effect, EffectComposer, Pass, ToneMappingEffect as _TonemappingEffect } from "postprocessing";
-import { HalfFloatType, NoToneMapping } from "three";
+import { HalfFloatType, NoToneMapping, Camera as Camera3 } from "three";
 
 import { showBalloonWarning } from "../../engine/debug/index.js";
 // import { internal_SetSharpeningEffectModule } from "./Effects/Sharpening.js";
@@ -44,7 +44,7 @@ export class PostProcessingHandler {
         this.context = context;
     }
 
-    apply(components: PostProcessingEffect[]) : Promise<void> {
+    apply(components: PostProcessingEffect[]): Promise<void> {
         if ("env" in import.meta && import.meta.env.VITE_NEEDLE_USE_POSTPROCESSING === "false") {
             if (debug) console.warn("Postprocessing is disabled via vite env setting");
             else console.debug("Postprocessing is disabled via vite env setting");
@@ -169,9 +169,7 @@ export class PostProcessingHandler {
     private applyEffects(context: Context) {
 
         const effectsOrPasses = this._effects;
-        
         if (effectsOrPasses.length <= 0) return;
-
         const camera = context.mainCameraComponent as Camera;
         const renderer = context.renderer;
         const scene = context.scene;
@@ -199,6 +197,7 @@ export class PostProcessingHandler {
         composer.setMainCamera(cam);
         composer.setRenderer(renderer);
         composer.setMainScene(scene);
+        composer.autoRenderToScreen = true; // Must be enabled because it might be disabled during addPass by the composer itself (depending on the effect's settings or order)
 
         for (const prev of composer.passes)
             prev.dispose();
@@ -218,9 +217,11 @@ export class PostProcessingHandler {
                 const effects: Array<Effect> = [];
 
                 for (const ef of effectsOrPasses) {
-                    if (ef instanceof MODULES.POSTPROCESSING.MODULE.Effect)
+                    if (ef instanceof MODULES.POSTPROCESSING.MODULE.Effect) {
                         effects.push(ef as Effect);
+                    }
                     else if (ef instanceof MODULES.POSTPROCESSING.MODULE.Pass) {
+                        ef.renderToScreen = false;
                         composer.addPass(ef as Pass);
                     }
                     else {
@@ -233,9 +234,10 @@ export class PostProcessingHandler {
                 // create and apply uber pass
                 if (effects.length > 0) {
                     const pass = new MODULES.POSTPROCESSING.MODULE.EffectPass(cam, ...effects);
-                    pass.name = effects.map(e => e.name).join(" ");
+                    pass.name = effects.map(e => e.name).join(", ");
                     pass.mainScene = scene;
                     pass.enabled = true;
+                    pass.renderToScreen = false;
                     composer.addPass(pass);
                 }
             }
@@ -255,8 +257,10 @@ export class PostProcessingHandler {
                     pass.name = ef.name;
                     composer.addPass(pass);
                 }
-                else if (ef instanceof MODULES.POSTPROCESSING.MODULE.Pass)
+                else if (ef instanceof MODULES.POSTPROCESSING.MODULE.Pass) {
+                    ef.renderToScreen = false;
                     composer.addPass(ef as Pass);
+                }
                 else
                     // seems some effects are not correctly typed, but three can deal with them,
                     // so we just pass them through
@@ -264,10 +268,83 @@ export class PostProcessingHandler {
             }
         }
 
-        if (debug) {
 
-            console.log("[PostProcessing] Passes →", composer.passes);
+        // The last pass is the one that renders to the screen, so we need to set the gamma correction for it (and enable it for all others)
+        for (let i = 0; i < composer.passes.length; i++) {
+            const pass = composer.passes[i] as any;
+            const isLast = i === composer.passes.length - 1;
+            if (pass?.configuration !== undefined) {
+                pass.configuration.gammaCorrection = isLast;
+            }
+            else if ("autosetGamma" in pass) {
+                // Some effects have a autosetGamma property that we can use to set the gamma correction
+                pass.autosetGamma = isLast;
+            }
+        }
+
+        // DEBUG LAND BELOW
+        if (debug) console.log("[PostProcessing] Passes →", [...composer.passes], "\n---------------------------------\n• " + composer.passes.map(i => i.name).join("\n• ") + "\n");
+        if (debug) this._onCreateEffectsDebug(this._composer!, cam);
+    }
+
+    private orderEffects() {
+        if (debug === "verbose") console.debug("Before ordering effects", [...this._effects]);
+
+        // Order of effects for correct results.
+        // Aligned with https://github.com/pmndrs/postprocessing/wiki/Effect-Merging#effect-execution-order
+        // We can not put this into global scope because then the module might not yet be initialized
+        effectsOrder ??= [
+            MODULES.POSTPROCESSING.MODULE.NormalPass,
+            MODULES.POSTPROCESSING.MODULE.DepthDownsamplingPass,
+            MODULES.POSTPROCESSING.MODULE.SMAAEffect,
+            MODULES.POSTPROCESSING.MODULE.SSAOEffect,
+            MODULES.POSTPROCESSING_AO.MODULE.N8AOPostPass,
+            MODULES.POSTPROCESSING.MODULE.TiltShiftEffect,
+            MODULES.POSTPROCESSING.MODULE.DepthOfFieldEffect,
+            MODULES.POSTPROCESSING.MODULE.ChromaticAberrationEffect,
+            MODULES.POSTPROCESSING.MODULE.BloomEffect,
+            MODULES.POSTPROCESSING.MODULE.SelectiveBloomEffect,
+            MODULES.POSTPROCESSING.MODULE.VignetteEffect,
+            MODULES.POSTPROCESSING.MODULE.PixelationEffect,
+            MODULES.POSTPROCESSING.MODULE.ToneMappingEffect,
+            MODULES.POSTPROCESSING.MODULE.HueSaturationEffect,
+            MODULES.POSTPROCESSING.MODULE.BrightnessContrastEffect,
+            // __SHARPENING_MODULE._SharpeningEffect,
+        ];
+
+
+        // TODO: enforce correct order of effects (e.g. DOF before Bloom)
+        const effects = this._effects;
+        effects.sort((a, b) => {
+            // we use find index here because sometimes constructor names are prefixed with `_`
+            // TODO: find a more robust solution that isnt name based (not sure if that exists tho... maybe we must give effect TYPES some priority/index)
+            const aidx = effectsOrder!.findIndex(e => a.constructor.name.endsWith(e.name));
+            const bidx = effectsOrder!.findIndex(e => b.constructor.name.endsWith(e.name));
+            // Unknown effects should be rendered first
+            if (aidx < 0) {
+                if (debug) console.warn("Unknown effect found: ", a.constructor.name);
+                return -1;
+            }
+            else if (bidx < 0) {
+                if (debug) console.warn("Unknown effect found: ", b.constructor.name);
+                return 1;
+            }
+            // if (aidx < 0) return 1;
+            // if (bidx < 0) return -1;
+            return aidx - bidx;
+        });
+
+        if (debug === "verbose") console.debug("After ordering effects", [...this._effects]);
+    }
+
+
+
 
+    private _menuEntry: HTMLSelectElement | null = null;
+    private _passIndices: number[] | null = null;
+
+    private _onCreateEffectsDebug(composer: EffectComposer, cam: Camera3) {
+        if (debug === "passes") {
             // DepthEffect for debugging purposes, disabled by default, can be selected in the debug pass select
             const depthEffect = new MODULES.POSTPROCESSING.MODULE.DepthEffect({
                 blendFunction: MODULES.POSTPROCESSING.MODULE.BlendFunction.NORMAL,
@@ -303,7 +380,7 @@ export class PostProcessingHandler {
             if (menu && this._passIndices === null) {
                 if (this._menuEntry)
                     this._menuEntry.remove();
-                
+
                 const select = document.createElement("select");
                 select.multiple = true;
                 const defaultOpt = document.createElement("option");
@@ -327,73 +404,12 @@ export class PostProcessingHandler {
                     else {
                         this._passIndices = indices;
                     }
-
-                    this.applyEffects(context);
+                    this.applyEffects(this.context);
                 });
             }
         }
     }
 
-    private _menuEntry: HTMLSelectElement | null = null;
-    private _passIndices: number[] | null = null;
-
-    private orderEffects() {
-        if (debug) console.log("Before ordering effects", [...this._effects]);
-
-
-
-        // Order of effects for correct results.
-        // Aligned with https://github.com/pmndrs/postprocessing/wiki/Effect-Merging#effect-execution-order
-        // We can not put this into global scope because then the module might not yet be initialized
-        effectsOrder ??= [
-            MODULES.POSTPROCESSING.MODULE.NormalPass,
-            MODULES.POSTPROCESSING.MODULE.DepthDownsamplingPass,
-            MODULES.POSTPROCESSING.MODULE.SMAAEffect,
-            MODULES.POSTPROCESSING.MODULE.SSAOEffect,
-            MODULES.POSTPROCESSING_AO.MODULE.N8AOPostPass,
-            MODULES.POSTPROCESSING.MODULE.TiltShiftEffect,
-            MODULES.POSTPROCESSING.MODULE.DepthOfFieldEffect,
-            MODULES.POSTPROCESSING.MODULE.ChromaticAberrationEffect,
-            MODULES.POSTPROCESSING.MODULE.BloomEffect,
-            MODULES.POSTPROCESSING.MODULE.SelectiveBloomEffect,
-            MODULES.POSTPROCESSING.MODULE.VignetteEffect,
-            MODULES.POSTPROCESSING.MODULE.PixelationEffect,
-            MODULES.POSTPROCESSING.MODULE.ToneMappingEffect,
-            MODULES.POSTPROCESSING.MODULE.HueSaturationEffect,
-            MODULES.POSTPROCESSING.MODULE.BrightnessContrastEffect,
-            // __SHARPENING_MODULE._SharpeningEffect,
-        ];
-
-
-        // TODO: enforce correct order of effects (e.g. DOF before Bloom)
-        const effects = this._effects;
-        effects.sort((a, b) => {
-            // we use find index here because sometimes constructor names are prefixed with `_`
-            // TODO: find a more robust solution that isnt name based (not sure if that exists tho... maybe we must give effect TYPES some priority/index)
-            const aidx = effectsOrder!.findIndex(e => a.constructor.name.endsWith(e.name));
-            const bidx = effectsOrder!.findIndex(e => b.constructor.name.endsWith(e.name));
-            // Unknown effects should be rendered first
-            if (aidx < 0) {
-                if (debug) console.warn("Unknown effect found: ", a.constructor.name);
-                return -1;
-            }
-            else if (bidx < 0) {
-                if (debug) console.warn("Unknown effect found: ", b.constructor.name);
-                return 1;
-            }
-            if (aidx < 0) return 1;
-            if (bidx < 0) return -1;
-            return aidx - bidx;
-        });
-        if (debug) console.log("After ordering effects", [...this._effects]);
-        for (let i = 0; i < effects.length; i++) {
-            const effect = effects[i] as any;
-            if (effect?.configuration?.gammaCorrection !== undefined) {
-                const isLast = i === effects.length - 1;
-                effect.configuration.gammaCorrection = isLast;
-            }
-        }
-    }
 }
 
 let effectsOrder: Array<Constructor<Effect | Pass>> | null = null;