Fix shader pass can't use SubShader content cause by scope loss when `ShaderLab` parse `Pass`

Sway007 commented 1 month ago

Please check if the PR fulfills these requirements

[x] The commit message follows our guidelines
[x] Tests for the changes have been added (for bug fixes / features)
[ ] Docs have been added / updated (for bug fixes / features)

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

Fix scope loss bug when parse Pass scope. A new symbol table should be created for Pass scope.

Summary by CodeRabbit

New Features
- Introduced a new BlendState configuration for enhanced color blending in the "Triangle" shader.
- Improved encapsulation of symbol tables in shader parsing to prevent variable interference across different shader passes.
Bug Fixes
- Enhanced parsing logic to correctly manage shader pass definitions and maintain structure.
Style
- Standardized string delimiters and formatting across the shader example for consistency.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 69.49%. Comparing base (f3400c8) to head (a69da3e). Report is 45 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2393 +/- ## ========================================== - Coverage 69.50% 69.49% -0.02% ========================================== Files 524 522 -2 Lines 27405 27356 -49 Branches 4100 4096 -4 ========================================== - Hits 19049 19010 -39 + Misses 6852 6845 -7 + Partials 1504 1501 -3 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2393/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/2393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `69.49% <100.00%> (?)` | | 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.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve modifications to the ShaderContentParser class in ShaderContentParser.ts to improve the encapsulation of symbol tables during shader pass parsing. A new scope is created at the beginning of the _parsePass method. Additionally, a new BlendState configuration named transparentBlendState is introduced in the shader code for the "Triangle" shader, which is applied to two passes, enhancing color blending control. Minor formatting updates have also been made in examples/shader-lab-multi-pass.ts.

Changes

File Path	Change Summary
`packages/shader-lab/src/contentParser/ShaderContentParser.ts`	Updated `_parsePass` method to create a new scope for encapsulation; modified method signature.
`tests/src/shader-lab/shaders/multi-pass.shader`	Introduced `transparentBlendState` and applied it to passes "0" and "1" in the "Triangle" shader.
`examples/shader-lab-multi-pass.ts`	Standardized string delimiters to double quotes; made minor logic adjustments without altering functionality.

Possibly related PRs

2378: The changes in Shader.ts regarding the handling of RenderState are related to the overall functionality of shader passes, which is also a focus of the main PR's modifications to the ShaderContentParser class.

Suggested labels

enhancement

Suggested reviewers

zhuxudong
GuoLei1990
cptbtptpbcptdtptp

Poem

In a world of shaders, bright and grand,
A rabbit hops with a brush in hand.
New scopes to guard, blending so fine,
With transparentBlendState, colors align.
Hooray for the passes, let rendering play,
In the land of pixels, we dance and sway! 🐇✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between 24cb887578415314fec4dfd17820cf2982b5d333 and a69da3ee68b765fca41debab6b263349be7e16f4.

📒 Files selected for processing (1)

* examples/shader-lab-multi-pass.ts (8 hunks)

🧰 Additional context used

🪛 Biome

examples/shader-lab-multi-pass.ts
[error] 179-179: The assignment should not be in an expression. The use of assignments in expressions is confusing. Expressions are often considered as side-effect free. (lint/suspicious/noAssignInExpressions)

--- 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://coderabbit.ai/docs) 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.

galacean / engine