Struct ImageTable 

#[non_exhaustive]
pub struct ImageTable {
    pub images: BTreeMap<&'static str, ImageInfo>,
}

Every image the game can draw, by bundle path (/-separated). Build it with ImageTable::new, Default or ImageTable::load (ADR-0039).

Fields (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.

images: BTreeMap<&'static str, ImageInfo>

Size by path.

Implementations

impl ImageTable

pub const fn new(images: BTreeMap<&'static str, ImageInfo>) -> Self

The table of images, their sizes by path.

pub fn load(bundle: &Bundle, skip: &[&str]) -> Result<Self, Vec<ContentError>>

Reads the size of every PNG in bundle but those at the paths in skip (e.g. a font atlas, checked on its own), reporting every bad file.

pub fn load_with( bundle: &Bundle, formats: &Formats, skip: &[&str], ) -> Result<Self, Vec<ContentError>>

Like ImageTable::load, with the image formats of formats: every file in bundle whose extension one of them claims (Formats::claims), but those at the paths in skip, read by them (ImageTable::from_files_with). With Formats::standard it reads the files load reads.

pub fn from_files_with<'a>( bundle: &Bundle, formats: &Formats, files: impl IntoIterator<Item = (&'static str, &'a [u8])>, ) -> Result<Self, Vec<ContentError>>

Like ImageTable::from_files, each file read by the image formats of formats (Formats::decode). With Formats::standard it gives what from_files gives for files named .png.

pub fn from_files<'a>( bundle: &Bundle, files: impl IntoIterator<Item = (&'static str, &'a [u8])>, ) -> Result<Self, Vec<ContentError>>

The table of files (bundle path and contents), or every problem found: a file that isn’t a PNG (or a one-bit picture in a PNG’s place), an empty image, or one with a side over MAX_SIDE. Errors name each file as bundle shows it.

pub fn id(&self, path: &str) -> Option<ImageId>

The id of the image at path, or None if the table lacks it.

pub fn info(&self, id: ImageId) -> Option<ImageInfo>

The size of image id, or None if it is another table’s.

pub fn ids(&self) -> impl Iterator<Item = ImageId> + '_

Every image’s id, in path order.

Trait Implementations

impl Clone for ImageTable

fn clone(&self) -> ImageTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageTable

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

Formats the value using the given formatter.

impl Default for ImageTable

fn default() -> ImageTable

Returns the “default value” for a type.

impl Eq for ImageTable

impl PartialEq for ImageTable

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ImageTable