Struct bevy_skybox_cubemap::SkyboxMaterial

pub struct SkyboxMaterial {
    pub color: Color,
    pub texture: Option<Handle<Texture>>,
}

Material for a Skybox. Consists of a base color and an optional 6-sided array-texture.

When rendering, the color from the texure is multiplied by the base color. This can be used to tint the skybox. When creating a new material, the default color is [Color::WHITE] which will have no effect on the texture color.

It is also possible to use a skybox texture with only a [Color]. One reason you might want to do this is that (at time of writing) Bevy does not seem to antialias against the window [ClearColor] properly, instead antialiasing with white for objects that have not other 3d object behind them. This leads to white borders around antialiased object that overlap the window clear color. To avoid this, you could spawn a skybox using only a color. Since the skybox is a 3d rendered object, antialiasing against it works properly.

Skyboxes should generally be spawned using SkyboxBundle, and you can see that type for info on what components are used with this material.

Fields

color: Color

Base color of the skybox. Multiplied with the color from the texture if a texture is supplied, otherwise used by itself as the skybox color.

texture: Option<Handle<Texture>>

Texture to use for the skybox. This must be a an aray texture with 6 layers which are all square and the same size. See the crate overview for details on the required layer order and how to get a texture in this format.

Implementations

impl SkyboxMaterial

pub fn from_texture(texture: Handle<Texture>) -> Self

Creates a SkyboxMaterial with just a texture. The color will be set to [Color::WHITE] to avoid tinting the texture.

pub fn from_color(color: Color) -> Self

Creates a SkyboxMaterial with only a color. This could be used in place of [ClearColor] if ClearColor is giving you issues with antialiasing. Otherwise it’s not all that useful.

Trait Implementations

impl Debug for SkyboxMaterial

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

Formats the value using the given formatter.

impl Default for SkyboxMaterial

fn default() -> Self

Creates a new skybox material with color set to white and no texture.

impl RenderResources for SkyboxMaterial

fn render_resources_len(&self) -> usize

fn get_render_resource(&self, index: usize) -> Option<&dyn RenderResource>

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

fn get_render_resource_hints(&self, index: usize) -> Option<RenderResourceHints>

fn iter(&self) -> RenderResourceIterator<'_>

impl ShaderDefs for SkyboxMaterial

fn shader_defs_len(&self) -> usize

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

fn iter_shader_defs(&self) -> ShaderDefIterator<'_>

impl TypeUuid for SkyboxMaterial

const TYPE_UUID: Uuid