Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete msaa in bloom and RenderBufferStoreAction #2170

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

zhuxudong
Copy link
Member

@zhuxudong zhuxudong commented Jul 12, 2024

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

Other information:

Summary by CodeRabbit

  • New Features

    • Optimized Bloom effect to streamline texture blitting operations and simplify texture creation.
  • Refactor

    • Updated internal render pipeline utilities for better performance and code maintainability.

@zhuxudong zhuxudong added the bug Something isn't working label Jul 12, 2024
@zhuxudong zhuxudong requested a review from GuoLei1990 July 12, 2024 06:15
@zhuxudong zhuxudong self-assigned this Jul 12, 2024
Copy link

coderabbitai bot commented Jul 12, 2024

Walkthrough

The recent update focuses on simplifying the PipelineUtils, BloomEffect, and module exports within the rendering pipeline. Key changes involve the removal of the renderBufferStoreAction parameter from the blitTexture method, the exclusion of RenderBufferStoreAction from exports, and the streamlining of texture creation processes in the BloomEffect class. These alterations aim to enhance code maintainability and reduce complexity.

Changes

File Change Summary
packages/core/src/RenderPipeline/PipelineUtils.ts Removed the renderBufferStoreAction parameter from the blitTexture method in the PipelineUtils class.
packages/core/src/RenderPipeline/index.ts Removed RenderBufferStoreAction from exports, re-added PipelineStage to exports.
packages/core/src/postProcess/effects/BloomEffect.ts Removed references to Engine and RenderBufferStoreAction, simplified texture creation and blitting logic.

Poem

In lines of code where textures blend,
A rabbit hops, new paths to tend.
The blitTexture sans extra weight,
Makes rendering fine and great!
Bloom's now brighter, clear, and keen,
In this streamlined code serene.


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@GuoLei1990 GuoLei1990 added the ignore for release ignore for release label Jul 12, 2024
@GuoLei1990 GuoLei1990 merged commit 1ed063d into galacean:dev/1.3 Jul 12, 2024
6 checks passed
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
packages/core/src/RenderPipeline/PipelineUtils.ts (1)

161-162: Ensure blitTexture calls reflect the new signature:

The following calls to blitTexture need to be updated to match the new signature:

  • packages/core/src/postProcess/PostProcessManager.ts
    • PipelineUtils.blitTexture(engine, srcTexture, destTarget, 0, camera.viewport, this._uberMaterial);
  • packages/core/src/postProcess/effects/BloomEffect.ts
    • PipelineUtils.blitTexture(engine, srcTexture, this._mipDownRT[0], undefined, undefined, this._bloomMaterial, 0);
    • Multiple other instances in BloomEffect.ts
  • packages/core/src/RenderPipeline/BasicRenderPipeline.ts
    • PipelineUtils.blitTexture(engine, <Texture2D>internalColorTarget.getColorTexture(0), cameraRenderTarget, 0, camera.viewport);
  • packages/core/src/RenderPipeline/OpaqueTexturePass.ts
    • PipelineUtils.blitTexture(this.engine, <Texture2D>this._cameraColorTexture, this._renderTarget);

Please update these calls to ensure they match the new method signature without the renderBufferStoreAction parameter.

Analysis chain

Change Approved: Simplified Method Signature

The renderBufferStoreAction parameter has been removed from the blitTexture method, simplifying its signature and internal logic.

Ensure that all calls to blitTexture are updated to reflect this change.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `blitTexture` match the new signature.

# Test: Search for the function usage. Expect: Only occurances of the new signature.
rg --type js -A 5 $'PipelineUtils.blitTexture'

Length of output: 45


Script:

#!/bin/bash
# Description: Verify all function calls to `blitTexture` match the new signature.

# Search for calls to the `blitTexture` method across the codebase.
rg --type ts 'blitTexture\(' -A 5

Length of output: 3835

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a69eb60 and c2ecec0.

Files selected for processing (3)
  • packages/core/src/RenderPipeline/PipelineUtils.ts (4 hunks)
  • packages/core/src/RenderPipeline/index.ts (1 hunks)
  • packages/core/src/postProcess/effects/BloomEffect.ts (8 hunks)
Additional comments not posted (7)
packages/core/src/RenderPipeline/index.ts (1)

3-3: Change Approved: Removed Export

The export of RenderBufferStoreAction has been removed, which aligns with the PR's objective to delete its usage.

packages/core/src/postProcess/effects/BloomEffect.ts (6)

265-265: Change Approved: Simplified Texture Creation

The msaaSamples parameter has been set to 1, simplifying the texture creation logic.


278-278: Change Approved: Simplified Texture Creation

The msaaSamples parameter has been set to 1, simplifying the texture creation logic.


287-287: Change Approved: Removed RenderBufferStoreAction

The RenderBufferStoreAction parameter has been removed from the blitTexture method call, aligning with the PR's objective.


307-307: Change Approved: Removed RenderBufferStoreAction

The RenderBufferStoreAction parameter has been removed from the blitTexture method call, aligning with the PR's objective.


316-316: Change Approved: Removed RenderBufferStoreAction

The RenderBufferStoreAction parameter has been removed from the blitTexture method call, aligning with the PR's objective.


340-340: Change Approved: Removed RenderBufferStoreAction

The RenderBufferStoreAction parameter has been removed from the blitTexture method call, aligning with the PR's objective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ignore for release ignore for release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants