Skip to main content

Atlas

Struct Atlas 

Source
#[non_exhaustive]
pub struct Atlas { pub states: Vec<StateSet>, pub icon_sets: Vec<IconSet>, pub image: Image, pub padding: u32, pub regions: Vec<Region>, pub animations: Vec<AtlasAnimation>, pub groups: Vec<Group>, }
Expand description

Every sprite of a document in one texture, and where each one is.

Sprites with identical pixels share one rectangle. Documents with themes also retain palette/key identity, so recoloring cannot change the packing.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§states: Vec<StateSet>§icon_sets: Vec<IconSet>§image: Image§padding: u32§regions: Vec<Region>

Named sprites in the order defined, then animation frames’ sprites in the order first used.

§animations: Vec<AtlasAnimation>§groups: Vec<Group>

The groups, each naming sprites of regions.

Implementations§

Source§

impl Atlas

Source

pub fn region(&self, name: &str) -> Option<Rect>

The rectangle of a sprite or frame sprite.

Source

pub fn to_json(&self, image: &str) -> String

The metadata as JSON, naming the atlas image file image. See the README for the form.

Trait Implementations§

Source§

impl Clone for Atlas

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Atlas

Source§

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

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

impl Eq for Atlas

Source§

impl PartialEq for Atlas

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Atlas

Auto Trait Implementations§

§

impl Freeze for Atlas

§

impl RefUnwindSafe for Atlas

§

impl Send for Atlas

§

impl Sync for Atlas

§

impl Unpin for Atlas

§

impl UnsafeUnpin for Atlas

§

impl UnwindSafe for Atlas

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.