HDR and sRGB Values in Bevy
- Dominant language
- Rust
- Stars
- 48.2k
- Forks
- 4.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 171
Description
While studying the Bevy engine and the [2D Bloom example](https://github.com/bevyengine/bevy/blob/latest/examples/2d/bloom_2d.rs), I noticed that the example compiles and works fine, but the documentation is unclear about handling large color values, especially with HDR.
A similar issue was raised over a year ago:
> I guess at this point I would be happy if there was a small mention in the documentation that large values are allowed with HDR, and `Mul` implementation for Srgb and LinearRgb to manipulate HDR brightness (palette has this too).
>
>
>
> All color space conversions may not work very well with HDR but maybe it doesn't matter if they weren't even designed for that.
_Originally posted by @eero-lehtinen in [#12089](https://github.com/bevyengine/bevy/issues/12089#issuecomment-1962844451)_
I suggest updating the documentation to clarify how HDR works with large values.
#20281
Contributor guide
Research direction
Start with the 2D Bloom example at examples/2d/bloom_2d.rs and review the referenced discussion in issue #12089. Update the relevant documentation to explain how HDR permits large color values and clarify the expected handling of HDR brightness and color-space conversions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- computer-graphics, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100