Struct AtlasRegions 

pub struct AtlasRegions { /* private fields */ }

The name-to-rectangle index of a sprite atlas, without the image handle.

Separating the index from the image keeps the lookup half of an atlas free of any DOM dependency, so region bookkeeping can be exercised without a live HtmlImageElement.

Implementations

impl AtlasRegions

Implements the pure name-to-rectangle index for AtlasRegions.

pub fn insert(&mut self, name: &str, region: Rect)

Inserts or replaces the source rectangle stored under a name.

Arguments

• &str - The sprite name.
• Rect - The source rectangle in atlas pixels.

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

Returns the source rectangle stored under a name.

Arguments

• &str - The sprite name.

Returns

• Option<Rect> - The source rectangle, or None if the name is unknown.

pub fn contains(&self, name: &str) -> bool

Returns whether a name is present in the index.

Arguments

• &str - The sprite name.

Returns

• bool - true when the name has a stored rectangle.

pub fn len(&self) -> usize

Returns the number of named regions in the index.

Returns

• usize - The region count.

pub fn is_empty(&self) -> bool

Returns whether the index holds no regions.

Returns

• bool - true when no region has been inserted.

pub fn names(&self) -> Vec<String>

Returns the stored names in unspecified order.

Returns

• Vec<String> - Every stored sprite name.

impl AtlasRegions

pub fn get_regions(&self) -> &HashMap<String, Rect>

pub fn set_regions(&mut self, val: HashMap<String, Rect>) -> &mut Self

impl AtlasRegions

pub fn new(regions: HashMap<String, Rect>) -> Self

Trait Implementations

impl Clone for AtlasRegions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AtlasRegions

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

Formats the value using the given formatter.

impl Default for AtlasRegions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for AtlasRegions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AtlasRegions