galacean / engine

A typescript interactive engine, support 2D, 3D, animation, physics, built on WebGL and glTF.
https://www.galacean.com/engine
MIT License
4.29k stars 307 forks source link

Fix clear flag of internal render target #2444

Open zhuxudong opened 3 days ago

zhuxudong commented 3 days ago

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago

Walkthrough

The changes in this pull request involve modifications to the BasicRenderPipeline, _PostProcessManager, and BasicResources classes. In BasicRenderPipeline.ts, the rendering logic is updated to include checks for internalColorTarget, affecting how the render target is cleared. The _PostProcessManager class sees the introduction of new blending properties and adjustments to the rendering logic based on the camera's clear flags. Additionally, BasicResources.ts enhances the blending functionality of the blitMaterial. These changes collectively refine the rendering and post-processing capabilities of the system.

Changes

File Path Change Summary
packages/core/src/RenderPipeline/BasicRenderPipeline.ts Updated render and _drawRenderPass methods to include conditional checks for internalColorTarget, altering render target clearing behavior.
packages/core/src/postProcess/PostProcessManager.ts Added imports for CameraClearFlags and expanded Shader imports. Introduced new blending properties in the uberMaterial and modified _render logic.
packages/core/src/BasicResources.ts Added imports for BlendFactor and BlendOperation. Configured blending properties in the blitMaterial constructor.
packages/core/src/RenderPipeline/PipelineUtils.ts Added import for CameraClearFlags and modified blitTexture method to adjust blend state based on camera's clear flags.

Possibly related PRs

Suggested labels

Rendering, post processing

Suggested reviewers

Poem

In the realm of render, colors gleam,
With blending magic, we weave a dream.
Clear flags dancing, targets in sight,
A pipeline of wonders, oh what a delight!
Hops of joy as pixels play,
In this vibrant world, we’ll forever stay! 🐇✨


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between e252e1b7e7643dd87d60925d407d3879d1873c0e and 26b906064c56320a6d3f079b9a2819aa28b60e55.
📒 Files selected for processing (2) * `packages/core/src/BasicResources.ts` (2 hunks) * `packages/core/src/RenderPipeline/PipelineUtils.ts` (2 hunks)
🔇 Additional comments (4)
packages/core/src/BasicResources.ts (2) `11-11`: **LGTM: Import additions are necessary for blend state configuration.** The new imports are correctly added and properly used in the blend state configuration below. --- `50-57`: **Verify the impact of always-enabled alpha blending.** The blend state configuration implements standard alpha blending, which is appropriate for handling transparent overlays and post-processing effects. However, consider the following: 1. The blend state is always enabled, which might impact performance in cases where blending isn't needed 2. The configuration is hardcoded, making it inflexible for different use cases Let's verify the usage context: Consider making the blend state configurable: ```diff const blendState = blitMaterial.renderState.blendState.targetBlendState; +// Allow blend state to be configured through material properties +const blendEnabled = material.getProperty("blendEnabled") ?? true; +blendState.enabled = blendEnabled; -blendState.enabled = true; blendState.sourceColorBlendFactor = BlendFactor.SourceAlpha; blendState.destinationColorBlendFactor = BlendFactor.OneMinusSourceAlpha; ```
packages/core/src/RenderPipeline/PipelineUtils.ts (2) `3-3`: **LGTM!** The import statement for `CameraClearFlags` is correctly placed and necessary for the new functionality. --- `198-202`: **Verify impact on existing render pipelines.** The blend state modification logic is sound - disabling blending when the camera has color clear flags ensures proper clearing behavior. However, this change might affect existing render pipelines. Let's verify the usage of this utility across the codebase:
✅ Verification successful **No impact on existing render pipelines** After analyzing the codebase usage of `blitTexture`, the blend state modification is safe because: 1. All direct pipeline usages (BasicRenderPipeline, OpaqueTexturePass) don't rely on the default blend state as they provide their own materials. 2. Post-processing calls (PostProcessManager, BloomEffect) explicitly pass materials, bypassing the new blend state logic. 3. The only case where no material is provided is in BasicRenderPipeline's final blit, where the blend state modification actually helps ensure proper color clearing behavior. The change is well-contained and improves the default behavior without affecting existing implementations.
🏁 Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Find all usages of blitTexture to assess impact # Look for calls where material parameter is not provided # Search for blitTexture calls rg -A 3 'blitTexture\(' # Search for potential render pipeline implementations that might be affected ast-grep --pattern 'class $_ extends BasicRenderPipeline { $$$ }' ``` Length of output: 2890 --- Script: ```shell #!/bin/bash # Let's analyze the actual usage patterns of blitTexture without material parameter # Search for blitTexture calls with context to see material parameter rg -B 2 -A 2 'blitTexture\([^)]*\)' --multiline # Find any custom render pipeline implementations ast-grep --pattern 'class $_ implements IRenderPipeline { $$$ }' ``` Length of output: 4814

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 3 days ago

Codecov Report

Attention: Patch coverage is 70.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 70.77%. Comparing base (f9fc2c6) to head (26b9060).

Files with missing lines Patch % Lines
...ges/core/src/RenderPipeline/BasicRenderPipeline.ts 0.00% 1 Missing and 2 partials :warning:
packages/core/src/RenderPipeline/PipelineUtils.ts 0.00% 2 Missing :warning:
...ackages/core/src/postProcess/PostProcessManager.ts 87.50% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2444 +/- ## ========================================== - Coverage 70.78% 70.77% -0.02% ========================================== Files 524 524 Lines 27487 27506 +19 Branches 4111 4113 +2 ========================================== + Hits 19457 19467 +10 - Misses 6477 6483 +6 - Partials 1553 1556 +3 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2444/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/galacean/engine/pull/2444/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `70.77% <70.00%> (-0.02%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.


🚨 Try these New Features: