Struct VolumetricFog 

pub struct VolumetricFog {
    pub enabled: bool,
    pub color: [f32; 3],
    pub density: f32,
    pub height_falloff: f32,
    pub height_reference: f32,
    pub max_distance: f32,
    pub phase_g: f32,
    pub ambient: f32,
}

Environmental volumetric fog: a single lit medium that wraps the scene, thicker near the ground and thinning with height, with extra glow around the sun.

Only one VolumetricFog is honoured: the first declared instance wins; later instances are silently dropped. With none declared, there is no fog.

VolumetricFog {
    density: 0.08,
    color: [0.75, 0.82, 0.95],
    height_falloff: 0.18,
    max_distance: 160.0,
    phase_g: 0.5,
    ..Default::default()
};

Fields

enabled: bool

Master toggle. false disables the fog even when this asset is present.

color: [f32; 3]

Linear-space RGB tint of the fog: the colour the camera sees in the far distance.

density: f32

Base thickness of the fog at height_reference (per world unit). Higher is thicker. Floored at 0.

height_falloff: f32

How quickly the fog thins with height above height_reference. 0 keeps it uniform; larger values pin it to the ground.

height_reference: f32

World-space Y at which the fog reaches full density. It thickens below this height and thins above it.

max_distance: f32

Maximum distance the fog covers from the camera, in world units. Past this, distant geometry stays clear.

phase_g: f32

Sun-glow anisotropy in (-1, 1). Positive values concentrate brightness around the sun (haloes), negative values scatter away from it, 0 is uniform.

ambient: f32

Constant ambient brightness so the fog keeps some colour in shaded areas.

Trait Implementations

impl Clone for VolumetricFog

fn clone(&self) -> VolumetricFog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for VolumetricFog

const NAME: &'static str = "VolumetricFog"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<VolumetricFog, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

impl ComponentSlot for VolumetricFog

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.

fn slot(s: &ComponentStorage) -> &Column<VolumetricFog>

Borrow this type’s column out of the storage.

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<VolumetricFog>

Mutably borrow this type’s column out of the storage.

impl Debug for VolumetricFog

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

Formats the value using the given formatter.

impl Default for VolumetricFog

fn default() -> VolumetricFog

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VolumetricFog

where VolumetricFog: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<VolumetricFog, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<VolumetricFog> for ComponentAsset

fn from(c: VolumetricFog) -> ComponentAsset

Converts to this type from the input type.

impl RuntimeComponent for VolumetricFog

impl Serialize for VolumetricFog

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.