Fix shader destroy memory residual

[GuoLei1990]

Please check if the PR fulfills these requirements

• The commit message follows our guidelines
• 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, ...)

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?)

Summary by CodeRabbit

• New Features

  • Enhanced resource management in shader program pools for improved cleanup and unregistration processes.
  • Introduced a constructor for the ShaderProgramPool class requiring an Engine instance, allowing for better integration with the engine's context.

• Bug Fixes

  • Improved the _destroy method in the ShaderPass class to ensure thorough cleanup of shader program pools.

• Refactor

  • Updated instantiation process for the ShaderProgramPool to accept the Engine instance, enhancing clarity and structure.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve modifications to the Engine, ShaderPass, and ShaderProgramPool classes. The Engine class now instantiates ShaderProgramPool with a reference to itself, enhancing its interaction with shader program pools. The ShaderPass class has improved its _destroy method for better cleanup of shader program pools, ensuring proper unregistration and clearing of references. Additionally, the ShaderProgramPool class has a new constructor that requires an Engine instance, establishing a dependency for its operations.

Changes

File Path	Change Summary
packages/core/src/Engine.ts	Updated _getShaderProgramPool to instantiate ShaderProgramPool with this as an argument.
packages/core/src/shader/ShaderPass.ts	Enhanced _destroy method for better cleanup of shader program pools, including unregistration and reference clearing.
packages/core/src/shader/ShaderProgramPool.ts	Added constructor that accepts an Engine instance, initializing the engine property.

Possibly related PRs

• Improve ShaderLab's compatiblity with the RenderState of Material #2378: The changes in this PR improve how ShaderLab handles RenderState settings, which is relevant to the modifications in the ShaderProgramPool constructor that now requires an Engine instance, potentially affecting how render states are managed.
• Fix shader pass can't use SubShader content cause by scope loss when ShaderLab parse Pass #2393: This PR addresses scope management during the parsing of shader passes, which is related to the changes in the Engine class's _getShaderProgramPool method, as both involve shader processing and management within the rendering pipeline.

Suggested labels

enhancement, high priority

Suggested reviewers

• zhuxudong

Poem

In the engine's heart, a change so bright,
Shader pools now dance in the light.
With a hop and a skip, they clean up right,
Unregistering passes, oh what a sight!
A constructor’s embrace, dependencies tight,
In the world of shaders, all feels just right! 🐇✨

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Sway007]

+1