Struct SkyboxData 

pub struct SkyboxData { /* private fields */ }

The sky one value of a game’s vocabulary is drawn and lit from: one of two kinds, an image of the whole sky or a gradient between three colors, the fraction of its own light it lands on a surface, and the ground color under its horizon where a game states one.

Implementations

impl SkyboxData

pub fn equirect(image: TextureData) -> Self

The sky image holds: the whole way around across it, and zenith to nadir down it, so it is twice as wide as it is tall.

Required if you want a sky an image holds. An image not twice as wide as it is tall stops startup naming the skybox.

pub fn gradient(zenith: Color, horizon: Color, nadir: Color) -> Self

The sky zenith straight up, horizon level, and nadir straight down, each texel between them the share its own elevation takes.

Required if you want a sky with no image at all: one color in all three lands that color on every surface, from every direction.

Examples found in repository

examples/animation.rs (line 247)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        match self {
            Self::Day => SkyboxData::gradient(SKY_ZENITH, SKY_HORIZON, SKY_NADIR).lit_by(SKY_LIGHT),
        }
    }

examples/stress-preview.rs (line 136)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        match self {
            Self::Day => SkyboxData::gradient(SKY_ZENITH, SKY_HORIZON, SKY_NADIR).lit_by(SKY_LIGHT),
        }
    }

examples/sound-lab.rs (line 132)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        match self {
            Self::Room => {
                SkyboxData::gradient(SKY_ZENITH, SKY_HORIZON, SKY_NADIR).lit_by(SKY_LIGHT)
            }
        }
    }

examples/isometric-board.rs (lines 216-220)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        SkyboxData::gradient(
            Color::rgb(0.55, 0.75, 0.95),
            Color::rgb(0.85, 0.90, 0.95),
            Color::rgb(0.35, 0.33, 0.30),
        )
        .lit_by(0.3)
    }

examples/ui-fonts.rs (lines 109-113)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        SkyboxData::gradient(
            Color::rgb(0.05, 0.06, 0.12),
            Color::rgb(0.18, 0.12, 0.16),
            Color::rgb(0.01, 0.01, 0.02),
        )
        .lit_by(0.25)
    }

examples/material-playground.rs (lines 591-595)

    fn build(&self, assets: &Assets) -> SkyboxData {
        let sky = match self {
            Self::Dawn => SkyboxData::gradient(
                Color::rgb(0.55, 0.55, 0.75),
                Color::rgb(0.95, 0.6, 0.35),
                Color::rgb(0.12, 0.08, 0.06),
            ),
            Self::Noon => SkyboxData::gradient(
                Color::rgb(0.2, 0.45, 0.85),
                Color::rgb(0.75, 0.82, 0.9),
                Color::rgb(0.3, 0.3, 0.28),
            ),
            Self::Dusk => SkyboxData::gradient(
                Color::rgb(0.18, 0.1, 0.3),
                Color::rgb(0.85, 0.35, 0.2),
                Color::rgb(0.03, 0.02, 0.03),
            ),
            Self::Night => SkyboxData::gradient(
                Color::rgb(0.02, 0.02, 0.06),
                Color::rgb(0.05, 0.05, 0.1),
                Color::rgb(0.0, 0.0, 0.0),
            ),
            Self::Clear => assets.skybox("sky-clear"),
            Self::Classic => assets.skybox("sky-classic"),
            Self::ImageDawn => assets.skybox("sky-dawn"),
            Self::Sinister => assets.skybox("sky-sinister"),
            Self::LightBlueStars => assets.skybox("sky-stars-lightblue"),
            Self::BlueStars => assets.skybox("sky-stars-blue"),
            Self::Default => SkyboxData::gradient(DEFAULT_SKY, DEFAULT_SKY, DEFAULT_SKY),
        };
        let sky = match self.ground() {
            Some(ground) => sky.with_ground(ground),
            None => sky,
        };

        sky.lit_by(self.light())
    }

pub fn lit_by(self, fraction: f32) -> Self

The same sky landing fraction of its own light on every surface, and a surface that reflects it reflecting that share. The sky the frame draws is unchanged.

Required if you want the frame’s own lights to show under a bright sky. 1.0 where never called, held at zero and above; past 1.0 lands more light than the sky holds.

Examples found in repository

examples/animation.rs (line 247)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        match self {
            Self::Day => SkyboxData::gradient(SKY_ZENITH, SKY_HORIZON, SKY_NADIR).lit_by(SKY_LIGHT),
        }
    }

examples/stress-preview.rs (line 136)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        match self {
            Self::Day => SkyboxData::gradient(SKY_ZENITH, SKY_HORIZON, SKY_NADIR).lit_by(SKY_LIGHT),
        }
    }

examples/sound-lab.rs (line 132)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        match self {
            Self::Room => {
                SkyboxData::gradient(SKY_ZENITH, SKY_HORIZON, SKY_NADIR).lit_by(SKY_LIGHT)
            }
        }
    }

examples/isometric-board.rs (line 221)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        SkyboxData::gradient(
            Color::rgb(0.55, 0.75, 0.95),
            Color::rgb(0.85, 0.90, 0.95),
            Color::rgb(0.35, 0.33, 0.30),
        )
        .lit_by(0.3)
    }

examples/ui-fonts.rs (line 114)

    fn build(&self, _assets: &Assets) -> SkyboxData {
        SkyboxData::gradient(
            Color::rgb(0.05, 0.06, 0.12),
            Color::rgb(0.18, 0.12, 0.16),
            Color::rgb(0.01, 0.01, 0.02),
        )
        .lit_by(0.25)
    }

examples/material-playground.rs (line 624)

    fn build(&self, assets: &Assets) -> SkyboxData {
        let sky = match self {
            Self::Dawn => SkyboxData::gradient(
                Color::rgb(0.55, 0.55, 0.75),
                Color::rgb(0.95, 0.6, 0.35),
                Color::rgb(0.12, 0.08, 0.06),
            ),
            Self::Noon => SkyboxData::gradient(
                Color::rgb(0.2, 0.45, 0.85),
                Color::rgb(0.75, 0.82, 0.9),
                Color::rgb(0.3, 0.3, 0.28),
            ),
            Self::Dusk => SkyboxData::gradient(
                Color::rgb(0.18, 0.1, 0.3),
                Color::rgb(0.85, 0.35, 0.2),
                Color::rgb(0.03, 0.02, 0.03),
            ),
            Self::Night => SkyboxData::gradient(
                Color::rgb(0.02, 0.02, 0.06),
                Color::rgb(0.05, 0.05, 0.1),
                Color::rgb(0.0, 0.0, 0.0),
            ),
            Self::Clear => assets.skybox("sky-clear"),
            Self::Classic => assets.skybox("sky-classic"),
            Self::ImageDawn => assets.skybox("sky-dawn"),
            Self::Sinister => assets.skybox("sky-sinister"),
            Self::LightBlueStars => assets.skybox("sky-stars-lightblue"),
            Self::BlueStars => assets.skybox("sky-stars-blue"),
            Self::Default => SkyboxData::gradient(DEFAULT_SKY, DEFAULT_SKY, DEFAULT_SKY),
        };
        let sky = match self.ground() {
            Some(ground) => sky.with_ground(ground),
            None => sky,
        };

        sky.lit_by(self.light())
    }

pub fn with_ground(self, color: Color) -> Self

The same sky reading as color in every direction under the horizon, blended over the three degrees below it: what a metal reflects there and what the sky lands on a surface facing down take that color, and so does the sky the frame draws where nothing covers it.

Required if you want a metal to reflect the floor it stands on rather than the sky’s own underside. No ground where never called.

Examples found in repository

examples/material-playground.rs (line 620)

    fn build(&self, assets: &Assets) -> SkyboxData {
        let sky = match self {
            Self::Dawn => SkyboxData::gradient(
                Color::rgb(0.55, 0.55, 0.75),
                Color::rgb(0.95, 0.6, 0.35),
                Color::rgb(0.12, 0.08, 0.06),
            ),
            Self::Noon => SkyboxData::gradient(
                Color::rgb(0.2, 0.45, 0.85),
                Color::rgb(0.75, 0.82, 0.9),
                Color::rgb(0.3, 0.3, 0.28),
            ),
            Self::Dusk => SkyboxData::gradient(
                Color::rgb(0.18, 0.1, 0.3),
                Color::rgb(0.85, 0.35, 0.2),
                Color::rgb(0.03, 0.02, 0.03),
            ),
            Self::Night => SkyboxData::gradient(
                Color::rgb(0.02, 0.02, 0.06),
                Color::rgb(0.05, 0.05, 0.1),
                Color::rgb(0.0, 0.0, 0.0),
            ),
            Self::Clear => assets.skybox("sky-clear"),
            Self::Classic => assets.skybox("sky-classic"),
            Self::ImageDawn => assets.skybox("sky-dawn"),
            Self::Sinister => assets.skybox("sky-sinister"),
            Self::LightBlueStars => assets.skybox("sky-stars-lightblue"),
            Self::BlueStars => assets.skybox("sky-stars-blue"),
            Self::Default => SkyboxData::gradient(DEFAULT_SKY, DEFAULT_SKY, DEFAULT_SKY),
        };
        let sky = match self.ground() {
            Some(ground) => sky.with_ground(ground),
            None => sky,
        };

        sky.lit_by(self.light())
    }

Trait Implementations

impl Clone for SkyboxData

fn clone(&self) -> SkyboxData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SkyboxData

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

Formats the value using the given formatter.

impl Default for SkyboxData

fn default() -> Self

The sky a name no source holds returns: black the whole way around.