Skip to content

Clarify Image::set_color_at docs about R formats #23729

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

Open
lkolbly wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −1
Open

Clarify Image::set_color_at docs about R formats #23729

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion crates/bevy_image/src/image.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1664,7 +1664,10 @@ impl Image {
/// so if you read it back using `get_color_at`, the `Color` you get will not equal the value
/// you used when writing it using this function.
///
/// For R and RG formats, only the respective values from the linear RGB [`Color`] will be used.
/// For RG formats, only the respective values from the linear RGB [`Color`] will be used.
///
/// For R formats the linear RGB [`Color`] will be converted to grayscale
/// and the R channel will be the luminance.
///
/// Other [`TextureFormat`]s are unsupported, such as:
/// - block-compressed formats
Expand Down