From 0f1754341b396ef5ca741d87ec7e4802a79dcd15 Mon Sep 17 00:00:00 2001 From: JMS55 <47158642+JMS55@users.noreply.github.com> Date: Sun, 5 Mar 2023 18:09:47 +0000 Subject: [PATCH] Tweak bloom docs (#7907) --- crates/bevy_core_pipeline/src/bloom/settings.rs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/crates/bevy_core_pipeline/src/bloom/settings.rs b/crates/bevy_core_pipeline/src/bloom/settings.rs index a1a4d64431..32cfab0702 100644 --- a/crates/bevy_core_pipeline/src/bloom/settings.rs +++ b/crates/bevy_core_pipeline/src/bloom/settings.rs @@ -15,8 +15,7 @@ use bevy_render::{extract_component::ExtractComponent, prelude::Camera}; /// /// **Bloom is currently not compatible with WebGL2.** /// -/// Often used in conjunction with `bevy_pbr::StandardMaterial::emissive` -/// for 3d meshes or [`bevy_render::color::Color::Hsla`]`::lightness` for 2d sprites. +/// Often used in conjunction with `bevy_pbr::StandardMaterial::emissive` for 3d meshes. /// /// Bloom is best used alongside a tonemapping function that desaturates bright colors, /// such as [`crate::tonemapping::Tonemapping::TonyMcMapface`]. @@ -30,6 +29,13 @@ use bevy_render::{extract_component::ExtractComponent, prelude::Camera}; pub struct BloomSettings { /// Controls the baseline of how much the image is scattered (default: 0.15). /// + /// This parameter should be used only to control the strength of the bloom + /// for the scene as a whole. Increasing it too much will make the scene appear + /// blurry and over-exposed. + /// + /// To make a mesh glow brighter, rather than increase the bloom intensity, + /// you should increase the mesh's `emissive` value. + /// /// # In energy-conserving mode /// The value represents how likely the light is to scatter. ///