Struct bevy_pbr::VolumetricFogSettings

pub struct VolumetricFogSettings {
    pub fog_color: Color,
    pub ambient_color: Color,
    pub ambient_intensity: f32,
    pub step_count: u32,
    pub max_depth: f32,
    pub absorption: f32,
    pub scattering: f32,
    pub density: f32,
    pub scattering_asymmetry: f32,
    pub light_tint: Color,
    pub light_intensity: f32,
}

When placed on a Camera3d, enables volumetric fog and volumetric lighting, also known as light shafts or god rays.

Fields

fog_color: Color

The color of the fog.

Note that the fog must be lit by a VolumetricLight or ambient light in order for this color to appear.

Defaults to white.

ambient_color: Color

Color of the ambient light.

This is separate from Bevy’s AmbientLight because an EnvironmentMapLight is still considered an ambient light for the purposes of volumetric fog. If you’re using a EnvironmentMapLight, for best results, this should be a good approximation of the average color of the environment map.

Defaults to white.

ambient_intensity: f32

The brightness of the ambient light.

If there’s no EnvironmentMapLight, set this to 0.

Defaults to 0.1.

step_count: u32

The number of raymarching steps to perform.

Higher values produce higher-quality results with less banding, but reduce performance.

The default value is 64.

max_depth: f32

The maximum distance that Bevy will trace a ray for, in world space.

You can think of this as the radius of a sphere of fog surrounding the camera. It has to be capped to a finite value or else there would be an infinite amount of fog, which would result in completely-opaque areas where the skybox would be.

The default value is 25.

absorption: f32

The absorption coefficient, which measures what fraction of light is absorbed by the fog at each step.

Increasing this value makes the fog darker.

The default value is 0.3.

scattering: f32

The scattering coefficient, which measures the fraction of light that’s scattered toward, and away from, the viewer.

The default value is 0.3.

density: f32

The density of fog, which measures how dark the fog is.

The default value is 0.1.

scattering_asymmetry: f32

Measures the fraction of light that’s scattered toward the camera, as opposed to away from the camera.

Increasing this value makes light shafts become more prominent when the camera is facing toward their source and less prominent when the camera is facing away. Essentially, a high value here means the light shafts will fade into view as the camera focuses on them and fade away when the camera is pointing away.

The default value is 0.8.

light_tint: Color

Applies a nonphysical color to the light.

This can be useful for artistic purposes but is nonphysical.

The default value is white.

light_intensity: f32

Scales the light by a fixed fraction.

This can be useful for artistic purposes but is nonphysical.

The default value is 1.0, which results in no adjustment.

Trait Implementations

impl Clone for VolumetricFogSettings

fn clone(&self) -> VolumetricFogSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for VolumetricFogSettings

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for VolumetricFogSettings

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

Formats the value using the given formatter.

impl Default for VolumetricFogSettings

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for VolumetricFogSettings

where Self: Any + Send + Sync, Color: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for VolumetricFogSettings

where Self: Any + Send + Sync, Color: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Reflect for VolumetricFogSettings

where Self: Any + Send + Sync, Color: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

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 try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable 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 apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

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.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for VolumetricFogSettings

where Self: Any + Send + Sync, Color: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection,

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 TypePath for VolumetricFogSettings

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for VolumetricFogSettings

where Self: Any + Send + Sync, Color: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for VolumetricFogSettings