@galacean/engine-core 1.5.0-alpha.0 → 1.5.0-alpha.1

package/dist/main.js

@@ -4269,75 +4269,6 @@ function dependentComponents(componentOrComponents, dependentMode) {
     return Layer;
 }({});
 
-/**
- * @internal
- */ var PipelineUtils = /*#__PURE__*/ function() {
-    function PipelineUtils() {}
-    /**
-   * Recreate texture if needed.
-   * @param engine - Engine
-   * @param currentTexture - Current texture
-   * @param width - Need texture width
-   * @param height - Need texture height
-   * @param format - Need texture format
-   * @param mipmap - Need texture mipmap
-   * @param isSRGBColorSpace - Whether to use sRGB color space
-   * @param textureWrapMode - Texture wrap mode
-   * @param textureFilterMode - Texture filter mode
-   * @returns Texture
-   */ PipelineUtils.recreateTextureIfNeeded = function recreateTextureIfNeeded(engine, currentTexture, width, height, format, mipmap, isSRGBColorSpace, textureWrapMode, textureFilterMode) {
-        if (currentTexture) {
-            if (currentTexture.width !== width || currentTexture.height !== height || currentTexture.format !== format || currentTexture.isSRGBColorSpace !== isSRGBColorSpace || currentTexture.mipmapCount > 1 !== mipmap) {
-                currentTexture.destroy(true);
-                currentTexture = new Texture2D(engine, width, height, format, mipmap, isSRGBColorSpace);
-                currentTexture.isGCIgnored = true;
-            }
-        } else {
-            currentTexture = new Texture2D(engine, width, height, format, mipmap, isSRGBColorSpace);
-            currentTexture.isGCIgnored = true;
-        }
-        currentTexture.wrapModeU = currentTexture.wrapModeV = textureWrapMode;
-        currentTexture.filterMode = textureFilterMode;
-        return currentTexture;
-    };
-    /**
-   * Recreate render target if needed.
-   * @param engine - Engine
-   * @param currentRenderTarget - Current render target
-   * @param width - Need render target width
-   * @param height - Need render target height
-   * @param colorFormat - Need render target color format
-   * @param depthFormat - Need render target depth format
-   * @param mipmap - Need render target mipmap
-   * @param isSRGBColorSpace - Whether to use sRGB color space
-   * @param antiAliasing - Need render target anti aliasing
-   * @param textureWrapMode - Texture wrap mode
-   * @param textureFilterMode - Texture filter mode
-   * @returns Render target
-   */ PipelineUtils.recreateRenderTargetIfNeeded = function recreateRenderTargetIfNeeded(engine, currentRenderTarget, width, height, colorFormat, depthFormat, needDepthTexture, mipmap, isSRGBColorSpace, antiAliasing, textureWrapMode, textureFilterMode) {
-        var currentColorTexture = currentRenderTarget == null ? void 0 : currentRenderTarget.getColorTexture(0);
-        var colorTexture = colorFormat ? PipelineUtils.recreateTextureIfNeeded(engine, currentColorTexture, width, height, colorFormat, mipmap, isSRGBColorSpace, textureWrapMode, textureFilterMode) : null;
-        if (needDepthTexture) {
-            var currentDepthTexture = currentRenderTarget == null ? void 0 : currentRenderTarget.depthTexture;
-            var _$needDepthTexture = depthFormat ? PipelineUtils.recreateTextureIfNeeded(engine, currentDepthTexture, width, height, depthFormat, mipmap, isSRGBColorSpace, textureWrapMode, textureFilterMode) : null;
-            if (currentColorTexture !== colorTexture || currentDepthTexture !== _$needDepthTexture) {
-                currentRenderTarget == null ? void 0 : currentRenderTarget.destroy(true);
-                currentRenderTarget = new RenderTarget(engine, width, height, colorTexture, _$needDepthTexture, antiAliasing);
-                currentRenderTarget.isGCIgnored = true;
-            }
-        } else {
-            if (currentColorTexture !== colorTexture || (currentRenderTarget == null ? void 0 : currentRenderTarget._depthFormat) !== depthFormat || currentRenderTarget.antiAliasing !== antiAliasing) {
-                currentRenderTarget == null ? void 0 : currentRenderTarget.destroy(true);
-                currentRenderTarget = new RenderTarget(engine, width, height, colorTexture, depthFormat, antiAliasing);
-                currentRenderTarget.isGCIgnored = true;
-            }
-        }
-        return currentRenderTarget;
-    };
-    return PipelineUtils;
-}();
-PipelineUtils.defaultViewport = new engineMath.Vector4(0, 0, 1, 1);
-
 /**
  * Used to update tags.
  */ var UpdateFlag = /*#__PURE__*/ function() {
@@ -5231,7 +5162,7 @@ __decorate([
  * The anti-aliasing mode.
  */ var AntiAliasing = /*#__PURE__*/ function(AntiAliasing) {
     /* Disable anti-aliasing. */ AntiAliasing[AntiAliasing["None"] = 0] = "None";
-    /* Fast approximate anti-aliasing. */ AntiAliasing[AntiAliasing["FXAA"] = 1] = "FXAA";
+    /* Fast approximate anti-aliasing, it detects and smooths jagged edges based on luminance contrast in the final rendered image. */ AntiAliasing[AntiAliasing["FXAA"] = 1] = "FXAA";
     return AntiAliasing;
 }({});
 
@@ -5850,11 +5781,14 @@ exports.Camera = /*#__PURE__*/ function(Component) {
    *
    * @defaultValue `Downsampling.TwoX`
    */ _this.opaqueTextureDownsampling = Downsampling.TwoX, /**
-   * Multi-sample anti-aliasing samples when use independent canvas mode.
+   * The number of samples used for hardware multisample anti-aliasing (MSAA) to smooth geometry edges during rasterization.
+   * Higher sample counts (e.g., 2x, 4x, 8x) produce smoother edges.
+   *
+   * @defaultValue `MSAASamples.FourX`
+   */ _this.msaaSamples = MSAASamples.FourX, /**
+   * The screen-space anti-aliasing mode applied after the camera renders the final image.
+   * Unlike MSAA, it can smooth all pixels, including by shader-generated specular, alpha-cutoff edge, low resolution texture.
    *
-   * @remarks It will take effect when `independentCanvasEnabled` property is `true`, otherwise it will be invalid.
-   */ _this.msaaSamples = MSAASamples.None, /**
-   * Anti-aliasing mode.
    * @defaultValue `AntiAliasing.None`
    */ _this.antiAliasing = AntiAliasing.None, /** @internal */ _this._cameraType = CameraType.Normal, /** @internal */ _this._globalShaderMacro = new ShaderMacroCollection(), /** @internal */ _this._frustum = new engineMath.BoundingFrustum(), /** @internal */ _this._virtualCamera = new VirtualCamera(), /** @internal */ _this._replacementShader = null, /** @internal */ _this._replacementSubShaderTag = null, /** @internal */ _this._replacementFailureStrategy = null, /** @internal */ _this._cameraIndex = -1, _this._priority = 0, _this._shaderData = new ShaderData(ShaderDataGroup.Camera), _this._isCustomViewMatrix = false, _this._isCustomProjectionMatrix = false, _this._fieldOfView = 45, _this._orthographicSize = 10, _this._isProjectionDirty = true, _this._isInvProjMatDirty = true, _this._customAspectRatio = undefined, _this._renderTarget = null, _this._depthBufferParams = new engineMath.Vector4(), _this._opaqueTextureEnabled = false, _this._enableHDR = false, _this._enablePostProcess = false, _this._viewport = new engineMath.Vector4(0, 0, 1, 1), _this._pixelViewport = new engineMath.Rect(0, 0, 0, 0), _this._inverseProjectionMatrix = new engineMath.Matrix(), _this._invViewProjMat = new engineMath.Matrix();
         _this._isViewMatrixDirty = entity.registerWorldChangeFlag();
@@ -6031,7 +5965,7 @@ exports.Camera = /*#__PURE__*/ function(Component) {
             Logger.error("mipLevel only take effect in WebGL2.0");
         }
         var ignoreClearFlags;
-        if (this._cameraType !== CameraType.Normal && !this._renderTarget && !this.independentCanvasEnabled) {
+        if (this._cameraType !== CameraType.Normal && !this._renderTarget && !this._isIndependentCanvasEnabled()) {
             ignoreClearFlags = engine.xrManager._getCameraIgnoreClearFlags(this._cameraType);
         }
         this._renderPipeline.render(context, cubeFace, mipLevel, ignoreClearFlags);
@@ -6065,6 +5999,31 @@ exports.Camera = /*#__PURE__*/ function(Component) {
     };
     /**
    * @internal
+   * Whether independent canvas is enabled.
+   */ _proto._isIndependentCanvasEnabled = function _isIndependentCanvasEnabled() {
+        // Uber pass need internal RT
+        if (this.enablePostProcess && this.scene.postProcessManager._isValid()) {
+            return true;
+        }
+        // Final pass should sRGB conversion and FXAA
+        if (this._needFinalPass()) {
+            return true;
+        }
+        var renderTarget = this._renderTarget;
+        // Need HDR and opaque texture
+        if (this.enableHDR || this.opaqueTextureEnabled) {
+            if (renderTarget) {
+                // If camera is HDR and format is same with renderTarget can reuse renderTarget if renderTarget is same HDR format
+                // If camera is LDR and opaqueTextureEnabled is true, can reuse renderTarget if renderTarget is LDR format(Only R8G8B8A8)
+                return this._getInternalColorTextureFormat() !== renderTarget.getColorTexture(0).format;
+            } else {
+                return true;
+            }
+        }
+        return false;
+    };
+    /**
+   * @internal
    */ _proto._getInternalColorTextureFormat = function _getInternalColorTextureFormat() {
         return this._enableHDR ? this.engine._hardwareRenderer.isWebGL2 ? TextureFormat.R11G11B10_UFloat : TextureFormat.R16G16B16A16 : TextureFormat.R8G8B8A8;
     };
@@ -6190,12 +6149,6 @@ exports.Camera = /*#__PURE__*/ function(Component) {
         this._updatePixelViewport();
         var _this__customAspectRatio;
         (_this__customAspectRatio = this._customAspectRatio) != null ? _this__customAspectRatio : this._projectionMatrixChange();
-        this._checkMainCanvasAntialiasWaste();
-    };
-    _proto._checkMainCanvasAntialiasWaste = function _checkMainCanvasAntialiasWaste() {
-        if (this._phasedActiveInScene && this.independentCanvasEnabled && engineMath.Vector4.equals(this._viewport, PipelineUtils.defaultViewport)) {
-            Logger.warn("Camera use independent canvas and viewport cover the whole screen, it is recommended to disable antialias, depth and stencil to save memory when create engine.");
-        }
     };
     _proto._dispatchModify = function _dispatchModify(flag) {
         var _this__updateFlagManager;
@@ -6209,43 +6162,11 @@ exports.Camera = /*#__PURE__*/ function(Component) {
    * If enabled, the opaque texture can be accessed in the shader using `camera_OpaqueTexture`.
    *
    * @defaultValue `false`
-   * @remarks If enabled, the `independentCanvasEnabled` property will be forced to be true.
    */ function get() {
                 return this._opaqueTextureEnabled;
             },
             set: function set(value) {
-                if (this._opaqueTextureEnabled !== value) {
-                    this._opaqueTextureEnabled = value;
-                    this._checkMainCanvasAntialiasWaste();
-                }
-            }
-        },
-        {
-            key: "independentCanvasEnabled",
-            get: /**
-   * Whether independent canvas is enabled.
-   * @remarks If true, the msaa in viewport can turn or off independently by `msaaSamples` property.
-   */ function get() {
-                // Uber pass need internal RT
-                if (this.enablePostProcess && this.scene.postProcessManager._isValid()) {
-                    return true;
-                }
-                // Final pass should sRGB conversion and FXAA
-                if (this._needFinalPass()) {
-                    return true;
-                }
-                var renderTarget = this._renderTarget;
-                // Need HDR and opaque texture
-                if (this.enableHDR || this.opaqueTextureEnabled) {
-                    if (renderTarget) {
-                        // If camera is HDR and format is same with renderTarget can reuse renderTarget if renderTarget is same HDR format
-                        // If camera is LDR and opaqueTextureEnabled is true, can reuse renderTarget if renderTarget is LDR format(Only R8G8B8A8)
-                        return this._getInternalColorTextureFormat() !== renderTarget.getColorTexture(0).format;
-                    } else {
-                        return true;
-                    }
-                }
-                return false;
+                this._opaqueTextureEnabled = value;
             }
         },
         {
@@ -6442,7 +6363,6 @@ exports.Camera = /*#__PURE__*/ function(Component) {
             get: /**
    * Whether to enable HDR.
    * @defaultValue `false`
-   * @remarks If enabled, the `independentCanvasEnabled` property will be forced to be true.
    */ function get() {
                 return this._enableHDR;
             },
@@ -6455,7 +6375,6 @@ exports.Camera = /*#__PURE__*/ function(Component) {
                         return;
                     }
                     this._enableHDR = value;
-                    this._checkMainCanvasAntialiasWaste();
                 }
             }
         },
@@ -6464,14 +6383,12 @@ exports.Camera = /*#__PURE__*/ function(Component) {
             get: /**
    * Whether to enable post process.
    * @defaultValue `false`
-   * @remarks If enabled, the `independentCanvasEnabled` property will be forced to be true.
    */ function get() {
                 return this._enablePostProcess;
             },
             set: function set(value) {
                 if (this._enablePostProcess !== value) {
                     this._enablePostProcess = value;
-                    this._checkMainCanvasAntialiasWaste();
                 }
             }
         },
@@ -9255,6 +9172,75 @@ __decorate([
     deepClone
 ], PostProcess.prototype, "_effects", void 0);
 
+/**
+ * @internal
+ */ var PipelineUtils = /*#__PURE__*/ function() {
+    function PipelineUtils() {}
+    /**
+   * Recreate texture if needed.
+   * @param engine - Engine
+   * @param currentTexture - Current texture
+   * @param width - Need texture width
+   * @param height - Need texture height
+   * @param format - Need texture format
+   * @param mipmap - Need texture mipmap
+   * @param isSRGBColorSpace - Whether to use sRGB color space
+   * @param textureWrapMode - Texture wrap mode
+   * @param textureFilterMode - Texture filter mode
+   * @returns Texture
+   */ PipelineUtils.recreateTextureIfNeeded = function recreateTextureIfNeeded(engine, currentTexture, width, height, format, mipmap, isSRGBColorSpace, textureWrapMode, textureFilterMode) {
+        if (currentTexture) {
+            if (currentTexture.width !== width || currentTexture.height !== height || currentTexture.format !== format || currentTexture.isSRGBColorSpace !== isSRGBColorSpace || currentTexture.mipmapCount > 1 !== mipmap) {
+                currentTexture.destroy(true);
+                currentTexture = new Texture2D(engine, width, height, format, mipmap, isSRGBColorSpace);
+                currentTexture.isGCIgnored = true;
+            }
+        } else {
+            currentTexture = new Texture2D(engine, width, height, format, mipmap, isSRGBColorSpace);
+            currentTexture.isGCIgnored = true;
+        }
+        currentTexture.wrapModeU = currentTexture.wrapModeV = textureWrapMode;
+        currentTexture.filterMode = textureFilterMode;
+        return currentTexture;
+    };
+    /**
+   * Recreate render target if needed.
+   * @param engine - Engine
+   * @param currentRenderTarget - Current render target
+   * @param width - Need render target width
+   * @param height - Need render target height
+   * @param colorFormat - Need render target color format
+   * @param depthFormat - Need render target depth format
+   * @param mipmap - Need render target mipmap
+   * @param isSRGBColorSpace - Whether to use sRGB color space
+   * @param antiAliasing - Need render target anti aliasing
+   * @param textureWrapMode - Texture wrap mode
+   * @param textureFilterMode - Texture filter mode
+   * @returns Render target
+   */ PipelineUtils.recreateRenderTargetIfNeeded = function recreateRenderTargetIfNeeded(engine, currentRenderTarget, width, height, colorFormat, depthFormat, needDepthTexture, mipmap, isSRGBColorSpace, antiAliasing, textureWrapMode, textureFilterMode) {
+        var currentColorTexture = currentRenderTarget == null ? void 0 : currentRenderTarget.getColorTexture(0);
+        var colorTexture = colorFormat ? PipelineUtils.recreateTextureIfNeeded(engine, currentColorTexture, width, height, colorFormat, mipmap, isSRGBColorSpace, textureWrapMode, textureFilterMode) : null;
+        if (needDepthTexture) {
+            var currentDepthTexture = currentRenderTarget == null ? void 0 : currentRenderTarget.depthTexture;
+            var _$needDepthTexture = depthFormat ? PipelineUtils.recreateTextureIfNeeded(engine, currentDepthTexture, width, height, depthFormat, mipmap, isSRGBColorSpace, textureWrapMode, textureFilterMode) : null;
+            if (currentColorTexture !== colorTexture || currentDepthTexture !== _$needDepthTexture) {
+                currentRenderTarget == null ? void 0 : currentRenderTarget.destroy(true);
+                currentRenderTarget = new RenderTarget(engine, width, height, colorTexture, _$needDepthTexture, antiAliasing);
+                currentRenderTarget.isGCIgnored = true;
+            }
+        } else {
+            if (currentColorTexture !== colorTexture || (currentRenderTarget == null ? void 0 : currentRenderTarget._depthFormat) !== depthFormat || currentRenderTarget.antiAliasing !== antiAliasing) {
+                currentRenderTarget == null ? void 0 : currentRenderTarget.destroy(true);
+                currentRenderTarget = new RenderTarget(engine, width, height, colorTexture, depthFormat, antiAliasing);
+                currentRenderTarget.isGCIgnored = true;
+            }
+        }
+        return currentRenderTarget;
+    };
+    return PipelineUtils;
+}();
+PipelineUtils.defaultViewport = new engineMath.Vector4(0, 0, 1, 1);
+
 exports.Collider = /*#__PURE__*/ function(Component) {
     _inherits(Collider, Component);
     function Collider(entity) {
@@ -14889,7 +14875,8 @@ CascadedShadowCasterPass._tempMatrix0 = new engineMath.Matrix();
    */ _proto.render = function render(context, cubeFace, mipLevel, ignoreClear) {
         context.rendererUpdateFlag = ContextRendererUpdateFlag.All;
         var camera = this._camera;
-        var scene = camera.scene, engine = camera.engine, renderTarget = camera.renderTarget, independentCanvasEnabled = camera.independentCanvasEnabled;
+        var scene = camera.scene, engine = camera.engine, renderTarget = camera.renderTarget;
+        var independentCanvasEnabled = camera._isIndependentCanvasEnabled();
         var rhi = engine._hardwareRenderer;
         var cullingResults = this._cullingResults;
         var sunlight = scene._lightManager._sunlight;
@@ -14897,10 +14884,12 @@ CascadedShadowCasterPass._tempMatrix0 = new engineMath.Matrix();
         var depthPassEnabled = camera.depthTextureMode === DepthTextureMode.PrePass && depthOnlyPass._supportDepthTexture;
         var finalClearFlags = camera.clearFlags & ~(ignoreClear != null ? ignoreClear : CameraClearFlags.None);
         var msaaSamples = renderTarget ? renderTarget.antiAliasing : camera.msaaSamples;
+        // Check whether can use `blitFramebuffer` to blit internal render target, source maybe screen canvas or camera's render target
+        // Our screen canvas's anti-aliasing is always disable, so blit source and dest is always same by below rules:
         // 1. Only support blitFramebuffer in webgl2 context
         // 2. Can't blit normal FBO to MSAA FBO
         // 3. Can't blit screen MSAA FBO to normal FBO in mac safari platform and mobile, but mac chrome and firfox is OK
-        this._canUseBlitFrameBuffer = rhi.isWebGL2 && msaaSamples === 1 && (!!renderTarget || !rhi.context.antialias);
+        this._canUseBlitFrameBuffer = rhi.isWebGL2 && msaaSamples === 1;
         // Because internal render target is linear color space, so we should convert srgb background color to linear color space
         var isSRGBBackground = !renderTarget || renderTarget.getColorTexture(0).isSRGBColorSpace;
         this._shouldCopyBackgroundColor = independentCanvasEnabled && !(finalClearFlags & CameraClearFlags.Color) && (!this._canUseBlitFrameBuffer || isSRGBBackground);
@@ -14928,11 +14917,11 @@ CascadedShadowCasterPass._tempMatrix0 = new engineMath.Matrix();
             var depthFormat;
             if (camera.renderTarget) {
                 depthFormat = camera.renderTarget._depthFormat;
-            } else if (rhi.context.depth && rhi.context.stencil) {
+            } else if (rhi._options.depth && rhi._options.stencil) {
                 depthFormat = TextureFormat.Depth24Stencil8;
-            } else if (rhi.context.depth) {
+            } else if (rhi._options.depth) {
                 depthFormat = TextureFormat.Depth24;
-            } else if (rhi.context.stencil) {
+            } else if (rhi._options.stencil) {
                 depthFormat = TextureFormat.Stencil;
             } else {
                 depthFormat = null;
@@ -14982,23 +14971,24 @@ CascadedShadowCasterPass._tempMatrix0 = new engineMath.Matrix();
         // If color target is null, hardware will not convert linear color space to sRGB
         var color = colorTarget ? background._linearSolidColor : background.solidColor;
         finalClearFlags !== CameraClearFlags.None && rhi.clearRenderTarget(engine, finalClearFlags, color);
-        if (internalColorTarget && finalClearFlags !== CameraClearFlags.All) {
-            // Can use `blitFramebuffer` API to copy color/depth/stencil buffer from back buffer to internal RT
-            if (this._canUseBlitFrameBuffer) {
-                var blitIgnoreFlags = finalClearFlags | (this._shouldCopyBackgroundColor ? CameraClearFlags.Color : CameraClearFlags.None);
-                rhi.blitInternalRTByBlitFrameBuffer(camera.renderTarget, internalColorTarget, blitIgnoreFlags, camera.viewport);
-            } else {
-                if (!(finalClearFlags & CameraClearFlags.DepthStencil)) {
-                    Logger.warn("We clear all depth/stencil state cause of the internalRT can't copy depth/stencil buffer from back buffer when use copy plan");
+        if (internalColorTarget) {
+            // Force clear internal color target depth and stencil buffer, because it already missed due to post process, HDR, sRGB covert, etc.
+            var keepDSFlags = ~finalClearFlags & CameraClearFlags.DepthStencil;
+            if (keepDSFlags) {
+                rhi.clearRenderTarget(engine, keepDSFlags);
+            }
+            var keepColorFlag = ~finalClearFlags & CameraClearFlags.Color;
+            if (keepColorFlag) {
+                if (this._shouldCopyBackgroundColor) {
+                    // Copy RT's color buffer to grab texture
+                    rhi.copyRenderTargetToSubTexture(camera.renderTarget, this._copyBackgroundTexture, camera.viewport);
+                    // Then blit grab texture to internal RT's color buffer
+                    Blitter.blitTexture(engine, this._copyBackgroundTexture, internalColorTarget, 0, undefined, camera.renderTarget ? undefined : engine._basicResources.blitScreenMaterial);
+                } else {
+                    // Only blit color buffer from back buffer
+                    var ignoreFlags = CameraClearFlags.DepthStencil;
+                    rhi.blitInternalRTByBlitFrameBuffer(camera.renderTarget, internalColorTarget, ignoreFlags, camera.viewport);
                 }
-                // We must clear depth/stencil buffer manually if current context don't support `blitFramebuffer` API
-                rhi.clearRenderTarget(engine, CameraClearFlags.DepthStencil);
-            }
-            if (this._shouldCopyBackgroundColor) {
-                // Copy RT's color buffer to grab texture
-                rhi.copyRenderTargetToSubTexture(camera.renderTarget, this._copyBackgroundTexture, camera.viewport);
-                // Then blit grab texture to internal RT's color buffer
-                Blitter.blitTexture(engine, this._copyBackgroundTexture, internalColorTarget, 0, undefined, camera.renderTarget ? undefined : engine._basicResources.blitScreenMaterial);
             }
             context.setRenderTarget(colorTarget, colorViewport, mipLevel, cubeFace);
         }