8000 Support camera HDR require alpha config by GuoLei1990 · Pull Request #2662 · galacean/engine · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Support camera HDR require alpha config #2662

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 15, 2025
Merged

Support camera HDR require alpha config #2662

merged 1 commit into from
May 15, 2025

Conversation

GuoLei1990
Copy link
Member
@GuoLei1990 GuoLei1990 commented May 15, 2025 •
edited by coderabbitai bot
Loading

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

    • Added an option to control whether the alpha channel is preserved in camera output.

  • Behavior Changes

    • The internal color texture format selection now adapts based on the alpha output requirement, potentially affecting rendering results when HDR is enabled.

@GuoLei1990 GuoLei1990 self-assigned this May 15, 2025
@GuoLei1990 GuoLei1990 requested a review from zhuxudong May 15, 2025 07:49
@coderabbitai coderabbitai
Copy link
coderabbitai bot commented May 15, 2025 •
edited
Loading

Walkthrough

A new boolean property, isAlphaOutputRequired, was introduced to the Camera class to specify whether the output alpha channel should always be preserved. The method responsible for determining the internal color texture format now considers this property, altering its logic for selecting texture formats when HDR is enabled.

Changes

File(s) Change Summary
packages/core/src/Camera.ts Added isAlphaOutputRequired property to Camera; updated _getInternalColorTextureFormat() to use this property when selecting texture formats in HDR mode.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Camera
    participant Renderer

    User->>Camera: Set isAlphaOutputRequired (optional)
    Camera->>Camera: _getInternalColorTextureFormat()
    Camera->>Renderer: Query WebGL2 support
    alt HDR enabled
        alt WebGL2 supported and isAlphaOutputRequired is false
            Camera-->>User: Return R11G11B10_UFloat format
        else isAlphaOutputRequired is true or WebGL2 unsupported
            Camera-->>User: Return R16G16B16A16 format
        end
    else HDR not enabled
        Camera-->>User: Return standard format
    end
Loading

Poem

A toggle for alpha, now in our sight,
Camera’s output, translucent or bright.
HDR decisions, with logic anew,
Texture formats chosen, just for you.
Rabbits rejoice, in code so refined,
Pixels and channels, perfectly aligned!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ea51cf3 and 1160c01.

📒 Files selected for processing (1)
  • packages/core/src/Camera.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: codecov
  • GitHub Check: e2e (22.x)
🔇 Additional comments (2)
packages/core/src/Camera.ts (2)

106-116: Well-documented property addition for alpha channel control.

The new isAlphaOutputRequired property is clearly documented with good explanations about its purpose and use cases. Having this property set to false by default maintains backward compatibility.

756-762: Implementation properly handles HDR with alpha preservation.

The modification to _getInternalColorTextureFormat() correctly incorporates the new property into the texture format selection logic. It ensures that when HDR is enabled:

  1. If WebGL2 is supported AND alpha output is not required, it uses the more efficient R11G11B10_UFloat format
  2. Otherwise, it uses R16G16B16A16 to preserve the alpha channel

This change properly supports use cases like canvas transparent blending that require alpha channel preservation.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@GuoLei1990 GuoLei1990 requested a review from hhhhkrx May 15, 2025 07:49
@GuoLei1990 GuoLei1990 added the rendering Rendering related functions label May 15, 2025
@GuoLei1990 GuoLei1990 added this to the 1.5 milestone May 15, 2025
@codecov Codecov
Copy link
codecov bot commented May 15, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 92.30769% with 1 line in your changes missing coverage. Please review.

Please upload report for BASE (dev/1.5@ea51cf3). Learn more about missing BASE report.
Report is 25 commits behind head on dev/1.5.

Files with missing lines Patch % Lines
packages/core/src/Camera.ts 92.30% 0 Missing and 1 partial ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             dev/1.5    #2662   +/-   ##
==========================================
  Coverage           ?   68.58%           
==========================================
  Files              ?      974           
  Lines              ?   102480           
  Branches           ?     8806           
==========================================
  Hits               ?    70289           
  Misses             ?    31923           
  Partials           ?      268
Flag Coverage Δ
unittests 68.58% <92.30%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@GuoLei1990 GuoLei1990 merged commit 974a8a1 into galacean:dev/1.5 May 15, 2025
9 checks passed
@GuoLei1990 GuoLei1990 linked an issue May 15, 2025 that may be closed by this pull request
Support Alpha channel in internal RT when HDR enabled #2554
Closed
@GuoLei1990 GuoLei1990 added the enhancement New feature or request label May 22, 2025
@coderabbitai coderabbitai bot mentioned this pull request May 22, 2025
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zhuxudong zhuxudong zhuxudong approved these changes

@hhhhkrx hhhhkrx Awaiting requested review from hhhhkrx

Assignees

@GuoLei1990 GuoLei1990

Labels
enhancement New feature or request rendering Rendering related functions
Projects
None yet
Milestone
1.5
Development

Successfully merging this pull request may close these issues.

Support Alpha channel in internal RT when HDR enabled
2 participants
@GuoLei1990 @zhuxudong
0