[Merged by Bors] - Revamp Bloom

Cargo.toml

@@ -50,7 +50,7 @@ default = [
   "x11",
   "filesystem_watcher",
   "android_shared_stdcxx",
-  "tonemapping_luts"
+  "tonemapping_luts",
 ]
 
 # Force dynamic linking, which improves iterative compile times
@@ -166,6 +166,7 @@ hidden = true
 [[example]]
 name = "bloom_2d"
 path = "examples/2d/bloom_2d.rs"
+required-features = ["tonemapping_luts"]
 
 [package.metadata.example.bloom_2d]
 name = "2D Bloom"
@@ -387,6 +388,7 @@ wasm = true
 [[example]]
 name = "bloom_3d"
 path = "examples/3d/bloom_3d.rs"
+required-features = ["tonemapping_luts"]
 
 [package.metadata.example.bloom_3d]
 name = "3D Bloom"

crates/bevy_core_pipeline/src/bloom/bloom.wgsl

@@ -7,7 +7,6 @@
 // * [PBB] - Physically Based Bloom - https://learnopengl.com/Guest-Articles/2022/Phys.-Based-Bloom
 
 #import bevy_core_pipeline::fullscreen_vertex_shader
-#import bevy_core_pipeline::tonemapping
 
 struct BloomDownsamplingUniforms {
     threshold_precomputations: vec4<f32>,
@@ -35,6 +34,16 @@ fn soft_threshold(color: vec3<f32>) -> vec3<f32> {
 }
 #endif
 
+// luminance coefficients from Rec. 709.
+// https://en.wikipedia.org/wiki/Rec._709
+fn tonemapping_luminance(v: vec3<f32>) -> f32 {
+    return dot(v, vec3<f32>(0.2126, 0.7152, 0.0722));
+}
+
+fn rgb_to_srgb_simple(color: vec3<f32>) -> vec3<f32> {
+    return pow(color, vec3<f32>(1.0 / 2.2));
+}
+
 // http://graphicrants.blogspot.com/2013/12/tone-mapping.html
 fn karis_average(color: vec3<f32>) -> f32 {
     // Luminance calculated by gamma-correcting linear RGB to non-linear sRGB using pow(color, 1.0 / 2.2)
@@ -45,26 +54,19 @@ fn karis_average(color: vec3<f32>) -> f32 {
 
 // [COD] slide 153
 fn sample_input_13_tap(uv: vec2<f32>) -> vec3<f32> {
-    let texel_size = 1.0 / vec2<f32>(textureDimensions(input_texture));
-    let x = texel_size.x;
-    let y = texel_size.y;
-
-    let a = textureSample(input_texture, s, vec2<f32>(uv.x - 2.0 * x, uv.y + 2.0 * y)).rgb;
-    let b = textureSample(input_texture, s, vec2<f32>(uv.x, uv.y + 2.0 * y)).rgb;
-    let c = textureSample(input_texture, s, vec2<f32>(uv.x + 2.0 * x, uv.y + 2.0 * y)).rgb;
-
-    let d = textureSample(input_texture, s, vec2<f32>(uv.x - 2.0 * x, uv.y)).rgb;
-    let e = textureSample(input_texture, s, vec2<f32>(uv.x, uv.y)).rgb;
-    let f = textureSample(input_texture, s, vec2<f32>(uv.x + 2.0 * x, uv.y)).rgb;
-
-    let g = textureSample(input_texture, s, vec2<f32>(uv.x - 2.0 * x, uv.y - 2.0 * y)).rgb;
-    let h = textureSample(input_texture, s, vec2<f32>(uv.x, uv.y - 2.0 * y)).rgb;
-    let i = textureSample(input_texture, s, vec2<f32>(uv.x + 2.0 * x, uv.y - 2.0 * y)).rgb;
-
-    let j = textureSample(input_texture, s, vec2<f32>(uv.x - x, uv.y + y)).rgb;
-    let k = textureSample(input_texture, s, vec2<f32>(uv.x + x, uv.y + y)).rgb;
-    let l = textureSample(input_texture, s, vec2<f32>(uv.x - x, uv.y - y)).rgb;
-    let m = textureSample(input_texture, s, vec2<f32>(uv.x + x, uv.y - y)).rgb;
+    let a = textureSample(input_texture, s, uv, vec2<i32>(-2, 2)).rgb;
+    let b = textureSample(input_texture, s, uv, vec2<i32>(0, 2)).rgb;
+    let c = textureSample(input_texture, s, uv, vec2<i32>(2, 2)).rgb;
+    let d = textureSample(input_texture, s, uv, vec2<i32>(-2, 0)).rgb;
+    let e = textureSample(input_texture, s, uv).rgb;
+    let f = textureSample(input_texture, s, uv, vec2<i32>(2, 0)).rgb;
+    let g = textureSample(input_texture, s, uv, vec2<i32>(-2, -2)).rgb;
+    let h = textureSample(input_texture, s, uv, vec2<i32>(0, -2)).rgb;
+    let i = textureSample(input_texture, s, uv, vec2<i32>(2, -2)).rgb;
+    let j = textureSample(input_texture, s, uv, vec2<i32>(-1, 1)).rgb;
+    let k = textureSample(input_texture, s, uv, vec2<i32>(1, 1)).rgb;
+    let l = textureSample(input_texture, s, uv, vec2<i32>(-1, -1)).rgb;
+    let m = textureSample(input_texture, s, uv, vec2<i32>(1, -1)).rgb;
 
 #ifdef FIRST_DOWNSAMPLE
     // [COD] slide 168

crates/bevy_core_pipeline/src/bloom/settings.rs

@@ -19,7 +19,7 @@ use bevy_render::{extract_component::ExtractComponent, prelude::Camera};
 /// for 3d meshes or [`bevy_render::color::Color::Hsla`]`::lightness` for 2d sprites.
 ///
 /// Bloom is best used alongside a tonemapping function that desaturates bright colors,
-/// such as TODO - fix in tonemapping PR.
+/// such as [`crate::tonemapping::Tonemapping::TonyMcMapface`].
 ///
 /// Bevy's implementation uses a parametric curve to blend between a set of
 /// blurred (lower frequency) images generated from the camera's view.
@@ -28,7 +28,7 @@ use bevy_render::{extract_component::ExtractComponent, prelude::Camera};
 #[allow(clippy::doc_markdown)]
 #[derive(Component, Reflect, Clone)]
 pub struct BloomSettings {
-    /// Controls the baseline of how much the image is scattered (default: 0.3).
+    /// Controls the baseline of how much the image is scattered (default: 0.15).
     ///
     /// # In energy-conserving mode
     /// The value represents how likely the light is to scatter.

crates/bevy_core_pipeline/src/tonemapping/mod.rs

@@ -171,6 +171,7 @@ impl Tonemapping {
         *self != Tonemapping::None
     }
 }
+
 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
 pub struct TonemappingPipelineKey {
     deband_dither: DebandDither,

examples/2d/bloom_2d.rs

@@ -1,7 +1,10 @@
 //! Illustrates bloom post-processing in 2d.
 
 use bevy::{
-    core_pipeline::bloom::{BloomCompositeMode, BloomSettings},
+    core_pipeline::{
+        bloom::{BloomCompositeMode, BloomSettings},
+        tonemapping::Tonemapping,
+    },
     prelude::*,
     sprite::MaterialMesh2dBundle,
 };
@@ -27,16 +30,17 @@ fn setup(
                 hdr: true, // 1. HDR is required for bloom
                 ..default()
             },
+            tonemapping: Tonemapping::TonyMcMapface, // 2. Using a tonemapper that saturates to white is recommended
             ..default()
         },
-        BloomSettings::default(), // 2. Enable bloom for the camera
+        BloomSettings::default(), // 3. Enable bloom for the camera
     ));
 
     // Sprite
     commands.spawn(SpriteBundle {
         texture: asset_server.load("branding/icon.png"),
         sprite: Sprite {
-            color: Color::hsl(0.0, 0.0, 2.5), // 3. Put something bright in a dark environment to see the effect
+            color: Color::rgb(5.0, 5.0, 5.0), // 4. Put something bright in a dark environment to see the effect
             custom_size: Some(Vec2::splat(160.0)),
             ..default()
         },
@@ -46,8 +50,8 @@ fn setup(
     // Circle mesh
     commands.spawn(MaterialMesh2dBundle {
         mesh: meshes.add(shape::Circle::new(100.).into()).into(),
-        // 3. Put something bright in a dark environment to see the effect
-        material: materials.add(ColorMaterial::from(Color::rgb(1.5, 0.0, 1.5))),
+        // 4. Put something bright in a dark environment to see the effect
+        material: materials.add(ColorMaterial::from(Color::rgb(7.5, 0.0, 7.5))),
         transform: Transform::from_translation(Vec3::new(-200., 0., 0.)),
         ..default()
     });
@@ -57,8 +61,8 @@ fn setup(
         mesh: meshes
             .add(shape::RegularPolygon::new(100., 6).into())
             .into(),
-        // 3. Put something bright in a dark environment to see the effect
-        material: materials.add(ColorMaterial::from(Color::rgb(1.25, 1.88, 1.82))),
+        // 4. Put something bright in a dark environment to see the effect
+        material: materials.add(ColorMaterial::from(Color::rgb(6.25, 9.4, 9.1))),
         transform: Transform::from_translation(Vec3::new(200., 0., 0.)),
         ..default()
     });

examples/3d/bloom_3d.rs

@@ -1,7 +1,10 @@
 //! Illustrates bloom post-processing using HDR and emissive materials.
 
 use bevy::{
-    core_pipeline::bloom::{BloomCompositeMode, BloomSettings},
+    core_pipeline::{
+        bloom::{BloomCompositeMode, BloomSettings},
+        tonemapping::Tonemapping,
+    },
     prelude::*,
 };
 use std::{
@@ -31,22 +34,23 @@ fn setup_scene(
                 hdr: true, // 1. HDR is required for bloom
                 ..default()
             },
+            tonemapping: Tonemapping::TonyMcMapface, // 2. Using a tonemapper that saturates to white is recommended
             transform: Transform::from_xyz(-2.0, 2.5, 5.0).looking_at(Vec3::ZERO, Vec3::Y),
             ..default()
         },
-        BloomSettings::default(), // 2. Enable bloom for the camera
+        BloomSettings::default(), // 3. Enable bloom for the camera
     ));
 
     let material_emissive1 = materials.add(StandardMaterial {
-        emissive: Color::rgb_linear(500.0, 50.0, 5.0), // 3. Put something bright in a dark environment to see the effect
+        emissive: Color::rgb_linear(5000.0, 500.0, 50.0), // 4. Put something bright in a dark environment to see the effect
         ..default()
     });
     let material_emissive2 = materials.add(StandardMaterial {
-        emissive: Color::rgb_linear(5.0, 500.0, 50.0),
+        emissive: Color::rgb_linear(50.0, 5000.0, 500.0),
         ..default()
     });
     let material_emissive3 = materials.add(StandardMaterial {
-        emissive: Color::rgb_linear(50.0, 5.0, 500.0),
+        emissive: Color::rgb_linear(500.0, 50.0, 5000.0),
         ..default()
     });
     let material_non_emissive = materials.add(StandardMaterial {