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

Sync 1.4 pbr editor props #2502

Open
wants to merge 1 commit into
base: dev/1.4
Choose a base branch
from

Conversation

zhuxudong
Copy link
Member

@zhuxudong zhuxudong commented Jan 10, 2025

sync https://github.com/galacean/editor/pull/3011

Summary by CodeRabbit

  • New Features

    • Added new properties for shader configuration, including refraction mode, transparency, render face, and blend mode
    • Enhanced anisotropy, iridescence, and sheen property controls
  • Refactor

    • Restructured shader property naming and organization
    • Simplified property signatures for improved clarity

@zhuxudong zhuxudong requested a review from hhhhkrx January 10, 2025 09:11
Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces significant structural and naming modifications to the PBR.gs shader file. The changes primarily focus on reorganizing the Editor section, renaming properties, and introducing new configuration options for material rendering. The modifications enhance the shader's property organization without fundamentally altering its core functionality, providing more granular control over material properties like anisotropy, iridescence, sheen, and transparency.

Changes

File Change Summary
packages/shader-shaderlab/src/shaders/PBR.gs - Renamed EditorProperties to Editor
- Introduced nested Properties block
- Restructured "Anisotropy", "Thin Film Iridescence", and "Sheen" sections
- Added new properties: refractionMode, isTransparent, renderFace, blendMode

Possibly related PRs

Suggested labels

Rendering, shader, material

Poem

🐰 A shader's dance, properties rearranged,
Lines of code, elegantly exchanged
Anisotropy twirls, iridescence gleams bright
Rendering magic in pure digital light!
Hop, hop, shader rabbit's delight! 🌈✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a8414f9 and 701f50f.

📒 Files selected for processing (1)
  • packages/shader-shaderlab/src/shaders/PBR.gs (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (22.x, windows-latest)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov
🔇 Additional comments (7)
packages/shader-shaderlab/src/shaders/PBR.gs (7)

2-3: LGTM: Improved structure organization.

The reorganization of the Editor section with a nested Properties block improves the shader's structure clarity.


17-19: LGTM: Improved property naming and added rotation control.

The changes enhance clarity with more concise property names and add important anisotropy rotation control.


47-50: LGTM: Enhanced iridescence control with granular properties.

The separation into individual properties (Iridescence, IOR, ThicknessRange) provides more precise control over the iridescent effect.


55-56: LGTM: Consistent property naming.

The removal of the ui_ prefix and property renaming aligns with the naming convention used throughout the shader.


67-69: LGTM: Added refraction mode control.

The addition of refractionMode with Sphere/Planar options provides necessary control over the transmission rendering approach.


73-75: Verify the impact of new rendering controls.

The addition of transparency, render face, and blend mode controls provides essential functionality. However, please verify:

  1. The interaction between isTransparent and the existing alpha cutoff
  2. The performance impact of Double-sided rendering when renderFace is set to 2
  3. The compatibility of the Additive blend mode with the PBR lighting model

Consider documenting the performance implications of these settings in the shader comments.


80-81: LGTM: Well-structured property organization.

The shader maintains a clear, logical organization with appropriate property groupings and default values.


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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.48%. Comparing base (a8414f9) to head (701f50f).

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.4    #2502      +/-   ##
===========================================
- Coverage    68.50%   68.48%   -0.02%     
===========================================
  Files          956      956              
  Lines       100007   100007              
  Branches      8545     8545              
===========================================
- Hits         68506    68490      -16     
- Misses       31245    31261      +16     
  Partials       256      256              
Flag Coverage Δ
unittests 68.48% <ø> (-0.02%) ⬇️

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant