Struct Module 

pub struct Module { /* private fields */ }

A module containing sprites

Implementations

impl Module

pub fn new<R, S, T>(name: R, sprite_paths: S, submodules: T) -> Self

where R: Into<String>, S: IntoIterator<Item = PathBuf>, T: IntoIterator<Item = Module>,

Create a module from its name, its sprite paths, and its submodules

pub fn parse(self) -> Result<ParsedModule, PngToWasm4SrcError>

Parse the sprites in the module

Parse all the sprites in the module and generate their Rust variables.

pub fn flatten(self) -> Self

Flatten the module

Flatten the module so that all sprites are defined in the top-level module.

pub fn generate_cargo_build_instructions<W>( &self, output: &mut W, ) -> Result<(), Error>

where W: Write,

Generate instructions for cargo build

Build scripts communicate with cargo by printing instructions starting with cargo: to standard output. This function generates a list of instructions to force a rebuild when source PNGs are modified.

Trait Implementations

impl Debug for Module

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

Formats the value using the given formatter.

impl Ord for Module

fn cmp(&self, other: &Module) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Module

fn eq(&self, other: &Module) -> 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 PartialOrd for Module

fn partial_cmp(&self, other: &Module) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Module

impl StructuralPartialEq for Module