Skip to main content

SkyConfig

Struct SkyConfig 

Source
pub struct SkyConfig {
    pub sky_type: SkyType,
    pub sun_position: Option<[f32; 2]>,
    pub sun_intensity: f32,
    pub atmosphere_color: [f32; 3],
    pub halo_color: [f32; 3],
    pub opacity: f32,
}
Expand description

User-facing sky / atmosphere configuration.

When attached to a StyleDocument or set directly on [MapState], this enables a procedural sky background rendered behind all scene geometry.

Default values produce a physically-plausible Earth-like atmosphere with the sun matching the directional light position from LightConfig.

Fields§

§sky_type: SkyType

Rendering mode. Default: SkyType::Atmosphere.

§sun_position: Option<[f32; 2]>

Sun position as [azimuth_deg, altitude_deg].

  • azimuth_deg: compass bearing (0 = north, 90 = east).
  • altitude_deg: elevation above the horizon (0 = horizon, 90 = zenith).

When None, inherits from the directional light direction in LightConfig.

§sun_intensity: f32

Sun brightness multiplier (0–100). Default: 10.0.

§atmosphere_color: [f32; 3]

Tint for Rayleigh scattering (linear RGB, 0–1). Default: white.

§halo_color: [f32; 3]

Tint for Mie scattering / halo (linear RGB, 0–1). Default: white.

§opacity: f32

Overall sky opacity (0–1). Default: 1.0.

At 0.0 the sky pass is skipped entirely (clear-colour only).

Trait Implementations§

Source§

impl Clone for SkyConfig

Source§

fn clone(&self) -> SkyConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SkyConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SkyConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SkyConfig

Source§

fn eq(&self, other: &SkyConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SkyConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.