forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Improve BloomSettings docs (#6465)

Browse Source 
Co-authored-by: JMS55 <47158642+JMS55@users.noreply.github.com>
Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Co-authored-by: DGriffin91 <github@dgdigital.net>
This commit is contained in:
JMS55 2022-11-04 17:53:55 +00:00
parent 9dd019bf86
commit 1fe3589a1a
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
crates/bevy_core_pipeline/src/bloom/mod.rs
View File

@ -126,6 +126,15 @@ impl Plugin for BloomPlugin {
/// Applies a bloom effect to a HDR-enabled 2d or 3d camera. /// Applies a bloom effect to a HDR-enabled 2d or 3d camera.
/// ///
/// Bloom causes bright objects to "glow", emitting a halo of light around them.
///
/// Often used in conjunction with `bevy_pbr::StandardMaterial::emissive`.
///
/// Note: This light is not "real" in the way directional or point lights are.
///
/// Bloom will not cast shadows or bend around other objects - it is purely a post-processing
/// effect overlaid on top of the already-rendered scene.
///
/// See also <https://en.wikipedia.org/wiki/Bloom_(shader_effect)>. /// See also <https://en.wikipedia.org/wiki/Bloom_(shader_effect)>.
#[derive(Component, Reflect, Clone)] #[derive(Component, Reflect, Clone)]
pub struct BloomSettings { pub struct BloomSettings {