Struct TextureAtlasFile

pub struct TextureAtlasFile {
    pub padding: u32,
    pub bleeding: u32,
    pub usages: RenderAssetUsages,
    pub entries: Vec<TextureAtlasEntry>,
}

Asset file representation of TextureAtlas.

This struct impls Serialize and Deserialize, which means it may be (de)serialized into any implementation, albeit TextureAtlasLoader uses RON format specifically.

Fields

padding: u32

How far away the edges of one sprite to another and to the page boundaries, in pixels. This may be utilized to mitigate the imperfect precision with texture sampling where a fraction of neighboring sprites actually get sampled instead.

bleeding: u32

How much the sprites will “bleed” outside its edge. That is, how much times the edges of a sprite is copied to its surrounding border, creating a bleeding effect. This may be utilized to mitigate the imperfect precision with texture sampling where the edge of a sprite doesn’t quite reach the edge of the vertices.

usages: RenderAssetUsages

Defines the usages for the resulting atlas pages.

entries: Vec<TextureAtlasEntry>

File entries relative to the atlas configuration file.

Implementations

impl TextureAtlasFile

pub const fn default_padding() -> u32

Default padding of a texture atlas is 4 pixels.

pub const fn default_bleeding() -> u32

Default bleeding of a texture atlas is 4 pixels.

pub const fn default_usages() -> RenderAssetUsages

Default usage of texture atlas pages is RenderAssetUsages::RENDER_WORLD.

pub fn serialize_usages<S: Serializer>( usages: &RenderAssetUsages, ser: S, ) -> Result<S::Ok, S::Error>

Serializes the usages into (main: <bool>, render: <bool>).

pub fn deserialize_usages<'de, D: Deserializer<'de>>( de: D, ) -> Result<RenderAssetUsages, D::Error>

Deserializes the usages from (main: <bool>, render: <bool>).

Trait Implementations

impl Clone for TextureAtlasFile

fn clone(&self) -> TextureAtlasFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextureAtlasFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextureAtlasFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TextureAtlasFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.