Skip to content

StandardMaterial docs: Make clear that lighting won't look correct if is_srgb is true #20037

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

772
Copy link
Contributor

@772 772 commented Jul 8, 2025

Objective

Solution

Testing

  • This pull request if only changing docs. But I tested the formatting via cargo doc --no-deps --open.

@772 772 changed the title StandardMaterial docs: Make clear that lighting won't look correct if is_srgb is false StandardMaterial docs: Make clear that lighting won't look correct if is_srgb is true Jul 8, 2025
@alice-i-cecile alice-i-cecile requested a review from BD103 July 8, 2025 17:29
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jul 8, 2025
@alice-i-cecile
Copy link
Member

@DGriffin91 does this look right to you?

@alice-i-cecile alice-i-cecile added the D-Straightforward Simple bug fixes and API improvements, docs, test and examples label Jul 8, 2025
@DGriffin91
Copy link
Contributor

Yes, this looks correct. A few of the examples do exactly this, and the GLTF loader deals with it here:

let is_srgb = !linear_textures.contains(&gltf_texture.index());

Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

@772, please ping me once CI is passing and I'll get this merged for you :) It looks like you're going to need to add a bit of boilerplate above your code snippet. Feel free to just mock it if needed and then use # to hide the mocked lines.

@alice-i-cecile alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jul 8, 2025
Copy link
Member

@BD103 BD103 left a comment

Choose a reason for hiding this comment

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

Thank you very much for working on this!

Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jul 8, 2025
@772
Copy link
Contributor Author

772 commented Jul 8, 2025

@alice-i-cecile
ping :) @BD103 fixed CI.

Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com>
@alice-i-cecile alice-i-cecile enabled auto-merge July 8, 2025 19:56
@alice-i-cecile
Copy link
Member

Alright, let's try that :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Document loading texture normals in linear RGB
4 participants