Struct SkyBox

pub struct SkyBox { /* private fields */ }

Skybox is a huge box around camera. Each face has its own texture, when textures are properly made, there is no seams and you get good decoration which contains static skies and/or some other objects (mountains, buildings, etc.). Usually skyboxes used in outdoor scenes, however real use of it limited only by your imagination. Skybox will be drawn first, none of objects could be drawn before skybox.

Implementations

impl SkyBox

pub const FRONT: &'static str = "front"

pub const BACK: &'static str = "back"

pub const LEFT: &'static str = "left"

pub const RIGHT: &'static str = "right"

pub const TOP: &'static str = "top"

pub const BOTTOM: &'static str = "bottom"

impl SkyBox

pub fn cubemap(&self) -> Option<TextureResource>

Returns cubemap texture

pub fn cubemap_ref(&self) -> Option<&TextureResource>

Returns cubemap texture

pub fn validate(&self) -> Result<(), SkyBoxError>

Validates input set of texture and checks if it possible to create a cube map from them. There are two main conditions for successful cube map creation:

• All textures must have same width and height, and width must be equal to height.
• All textures must have same pixel kind.

pub fn create_cubemap(&mut self) -> Result<(), SkyBoxError>

Creates a cubemap using provided faces. If some face has not been provided corresponding side will be black.

Important notes.

It will fail if provided face’s kind is not TextureKind::Rectangle.

pub fn textures(&self) -> [Option<TextureResource>; 6]

Returns slice with all textures, where: 0 - Left, 1 - Right, 2 - Top, 3 - Bottom 4 - Front, 5 - Back.

Important notes.

These textures are not used for rendering! The renderer uses cube map made of these textures. Public access for these textures is needed in case you need to read internals of the textures.

pub fn set_left( &mut self, texture: Option<TextureResource>, ) -> Option<TextureResource>

Set new texture for the left side of the skybox.

pub fn left(&self) -> Option<TextureResource>

Returns a texture that is used for left face of the cube map.

Important notes.

This textures is not used for rendering! The renderer uses cube map made of face textures.

pub fn set_right( &mut self, texture: Option<TextureResource>, ) -> Option<TextureResource>

Set new texture for the right side of the skybox.

pub fn right(&self) -> Option<TextureResource>

Returns a texture that is used for right face of the cube map.

Important notes.

This textures is not used for rendering! The renderer uses cube map made of face textures.

pub fn set_top( &mut self, texture: Option<TextureResource>, ) -> Option<TextureResource>

Set new texture for the top side of the skybox.

pub fn top(&self) -> Option<TextureResource>

Returns a texture that is used for top face of the cube map.

Important notes.

This textures is not used for rendering! The renderer uses cube map made of face textures.

pub fn set_bottom( &mut self, texture: Option<TextureResource>, ) -> Option<TextureResource>

Set new texture for the bottom side of the skybox.

pub fn bottom(&self) -> Option<TextureResource>

Returns a texture that is used for bottom face of the cube map.

Important notes.

This textures is not used for rendering! The renderer uses cube map made of face textures.

pub fn set_front( &mut self, texture: Option<TextureResource>, ) -> Option<TextureResource>

Set new texture for the front side of the skybox.

pub fn front(&self) -> Option<TextureResource>

Returns a texture that is used for front face of the cube map.

Important notes.

This textures is not used for rendering! The renderer uses cube map made of face textures.

pub fn set_back( &mut self, texture: Option<TextureResource>, ) -> Option<TextureResource>

Set new texture for the back side of the skybox.

pub fn back(&self) -> Option<TextureResource>

Returns a texture that is used for back face of the cube map.

Important notes.

This textures is not used for rendering! The renderer uses cube map made of face textures.

Trait Implementations

impl Clone for SkyBox

fn clone(&self) -> SkyBox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SkyBox

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

Formats the value using the given formatter.

impl Default for SkyBox

fn default() -> SkyBox

Returns the “default value” for a type.

impl PartialEq for SkyBox

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for SkyBox

where Self: 'static, Option<TextureResource>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn set_field( &mut self, name: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>), )

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl TypeUuidProvider for SkyBox

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for SkyBox

where Option<TextureResource>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl Eq for SkyBox

impl StructuralPartialEq for SkyBox