Struct Spritesheet 

pub struct Spritesheet { /* private fields */ }

Implementations

impl Spritesheet

pub fn new( sprites: BTreeMap<String, Sprite>, references: MultiMap<String, String>, sdf: bool, ) -> Option<Spritesheet>

pub fn build() -> SpritesheetBuilder

pub fn encode_png(&self) -> Result<Vec<u8>, SpreetError>

Encode the spritesheet to the in-memory PNG image.

The spritesheet Pixmap is converted to an in-memory PNG, optimised using the oxipng library.

The spritesheet will match an index that can be retrieved with Self::get_index.

pub fn save_spritesheet<P>(&self, path: P) -> Result<(), SpreetError>

where P: AsRef<Path>,

Saves the spritesheet to a local file named path.

A spritesheet, called an image file in the Mapbox Style Specification, is a PNG image containing all the individual sprite images. The spritesheet Pixmap is converted to an in-memory PNG, optimised using the oxipng library, and saved to a local file.

The spritesheet will match an index file that can be saved with Self::save_index.

pub fn get_index(&self) -> &BTreeMap<String, SpriteDescription>

Get the sprite_index that can be serialized to JSON.

An index file is defined in the Mapbox Style Specification as a JSON document containing a description of each sprite within a spritesheet. It contains the width, height, x and y positions, and pixel ratio of the sprite.

The index file will match a spritesheet that can be saved with Self::save_spritesheet.

pub fn save_index( &self, file_name_prefix: &str, minify: bool, ) -> Result<(), Error>

Saves the sprite_index to a local file named file_name_prefix + “.json”.

An index file is defined in the Mapbox Style Specification as a JSON document containing a description of each sprite within a spritesheet. It contains the width, height, x and y positions, and pixel ratio of the sprite.

The index file will match a spritesheet that can be saved with Self::save_spritesheet.