From 1fe3589a1ada6d8583f3385126a31a8d286510ac Mon Sep 17 00:00:00 2001 From: JMS55 Date: Fri, 4 Nov 2022 17:53:55 +0000 Subject: [PATCH] Improve BloomSettings docs (#6465) Co-authored-by: JMS55 <47158642+JMS55@users.noreply.github.com> Co-authored-by: Carter Anderson Co-authored-by: DGriffin91 --- crates/bevy_core_pipeline/src/bloom/mod.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/crates/bevy_core_pipeline/src/bloom/mod.rs b/crates/bevy_core_pipeline/src/bloom/mod.rs index d61a0f3298..b710d8d834 100644 --- a/crates/bevy_core_pipeline/src/bloom/mod.rs +++ b/crates/bevy_core_pipeline/src/bloom/mod.rs @@ -126,6 +126,15 @@ impl Plugin for BloomPlugin { /// 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 . #[derive(Component, Reflect, Clone)] pub struct BloomSettings {