Struct BloomSettings

pub struct BloomSettings {
    pub threshold: f32,
    pub knee: f32,
    pub scale: f32,
    pub intensity: f32,
}

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).

Fields

threshold: f32

Baseline of the threshold curve (default: 1.0).

RGB values under the threshold curve will not have bloom applied.

knee: f32

Knee of the threshold curve (default: 0.1).

scale: f32

Scale used when upsampling (default: 1.0).

intensity: f32

Intensity of the bloom effect (default: 0.3).

Trait Implementations

impl Clone for BloomSettings

fn clone(&self) -> BloomSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for BloomSettings

where Self: Send + Sync + 'static,

type Storage = TableStorage

impl Default for BloomSettings

fn default() -> Self

Returns the “default value” for a type.

impl GetTypeRegistration for BloomSettings

where f32: Reflect,

fn get_type_registration() -> TypeRegistration

impl Reflect for BloomSettings

where f32: Reflect,

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl Struct for BloomSettings

where f32: Reflect,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl Typed for BloomSettings

where f32: Reflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.