Struct rusty_spine::Atlas

pub struct Atlas { /* private fields */ }

An atlas loaded from Spine’s .atlas file format.

Spine API Reference

Implementations

impl Atlas

pub fn new<P: AsRef<Path>>(data: &[u8], dir: P) -> Result<Atlas, SpineError>

Create an Atlas from an in-memory vector.

use rusty_spine::Atlas;
fn load_atlas() -> Atlas {
    let atlas_file = std::fs::read("skeleton.atlas").unwrap();
    Atlas::new(&atlas_file, "").unwrap()
}

Errors

Returns the SpineError::NulError if dir or data contain an internal 0 byte. Returns SpineError::PathNotUtf8 if the specified dir is not utf-8. This function does not error if the atlas file is invalid or malformed. The file is parsed line-by-line and invalid lines are simply ignored.

pub fn new_from_file<P: AsRef<Path>>(path: P) -> Result<Atlas, SpineError>

Create an Atlas from a file.

use rusty_spine::Atlas;
fn load_atlas() -> Result<Atlas, rusty_spine::SpineError>{
    Ok(Atlas::new_from_file("skeleton.json")?)
}

Errors

Returns SpineError::FailedToReadFile if the file could not be read, returns SpineError::NulError if path contains an internal 0 byte or if the loaded atlas contains a 0 byte. Returns SpineError::PathNotUtf8 if the specified path is not utf-8.

pub fn pages(&self) -> AtlasPageIterator<'_>

Iterator over the AtlasPage list in this atlas.

pub fn find_page(&self, name: &str) -> Option<CTmpRef<'_, Self, AtlasPage>>

Find an AtlasPage in this atlas by name.

pub fn regions(&self) -> AtlasRegionIterator<'_>

Iterator over the AtlasRegion list in this atlas, across all pages.

pub fn find_region(&self, name: &str) -> Option<CTmpRef<'_, Self, AtlasRegion>>

Find an AtlasRegion in this atlas by name, across all pages.

pub fn renderer_object(&self) -> RendererObject<'_>

pub const fn c_ptr(&self) -> *mut spAtlas

Get a pointer to the underlying spine-c type.

Trait Implementations

impl Debug for Atlas

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

Formats the value using the given formatter.

impl Drop for Atlas

fn drop(&mut self)

Executes the destructor for this type.

impl NewFromPtr<spAtlas> for Atlas

unsafe fn new_from_ptr(c_atlas: *mut spAtlas) -> Atlas