Skip to main content

SpriteRegistry

Struct SpriteRegistry 

Source
pub struct SpriteRegistry { /* private fields */ }
Expand description

Registry for sprites and variants.

Handles resolution of sprite names to renderable sprites, including expanding variants to their effective sprite representation.

Implementations§

Source§

impl SpriteRegistry

Source

pub fn new() -> Self

Create a new empty sprite registry.

Source

pub fn register_sprite(&mut self, sprite: Sprite)

Register a sprite.

Source

pub fn register_variant(&mut self, variant: Variant)

Register a variant.

Source

pub fn get_sprite(&self, name: &str) -> Option<&Sprite>

Get a sprite by name (does not resolve variants).

Source

pub fn get_variant(&self, name: &str) -> Option<&Variant>

Get a variant by name.

Source

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

Check if a name refers to a sprite or variant.

Source

pub fn resolve( &self, name: &str, palette_registry: &PaletteRegistry, strict: bool, ) -> Result<ResolvedSprite, SpriteError>

Resolve a name to a sprite-like structure, expanding variants.

In strict mode, returns an error if the name or base is not found. In lenient mode, returns a fallback result with warnings.

The returned ResolvedSprite contains the effective grid and merged palette.

Source

pub fn names(&self) -> impl Iterator<Item = &String>

Get all sprite and variant names.

Source

pub fn len(&self) -> usize

Get the total number of sprites and variants in the registry.

Source

pub fn is_empty(&self) -> bool

Check if the registry is empty (no sprites or variants).

Source

pub fn clear(&mut self)

Clear all sprites and variants from the registry.

Source

pub fn sprite_count(&self) -> usize

Get the number of sprites (excluding variants).

Source

pub fn variant_count(&self) -> usize

Get the number of variants (excluding sprites).

Source

pub fn sprites(&self) -> impl Iterator<Item = (&String, &Sprite)>

Iterate over all sprites in the registry.

Source

pub fn variants(&self) -> impl Iterator<Item = (&String, &Variant)>

Iterate over all variants in the registry.

Trait Implementations§

Source§

impl Clone for SpriteRegistry

Source§

fn clone(&self) -> SpriteRegistry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpriteRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SpriteRegistry

Source§

fn default() -> SpriteRegistry

Returns the “default value” for a type. Read more
Source§

impl Registry<Sprite> for SpriteRegistry

Source§

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

Check if an item with the given name exists in the registry.
Source§

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

Get an item by name. Read more
Source§

fn len(&self) -> usize

Get the number of items in the registry.
Source§

fn clear(&mut self)

Clear all items from the registry.
Source§

fn names(&self) -> Box<dyn Iterator<Item = &String> + '_>

Get an iterator over all names in the registry.
Source§

fn is_empty(&self) -> bool

Check if the registry is empty.
Source§

impl Registry<Variant> for SpriteRegistry

Source§

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

Check if an item with the given name exists in the registry.
Source§

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

Get an item by name. Read more
Source§

fn len(&self) -> usize

Get the number of items in the registry.
Source§

fn clear(&mut self)

Clear all items from the registry.
Source§

fn names(&self) -> Box<dyn Iterator<Item = &String> + '_>

Get an iterator over all names in the registry.
Source§

fn is_empty(&self) -> bool

Check if the registry is empty.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more