Struct Sprite

pub struct Sprite<Bytes: ?Sized = [u8]> {
    pub indices: DrawIndices,
    /* private fields */
}

Fields

indices: DrawIndices

Implementations

impl<const N: usize> Sprite<[u8; N]>

pub const fn from_byte_array( bytes: [u8; N], shape: [u32; 2], bpp: BitsPerPixel, draw_colors: DrawIndices, ) -> Option<Self>

Create a sprite from an array of bytes and other metadata.

Errors

Returns None if bytes wont fit the given sprite shape and bpp.

impl<Bytes> Sprite<Bytes>

pub const unsafe fn from_bytes_unchecked( bytes: Bytes, shape: [u32; 2], bpp: BitsPerPixel, draw_colors: DrawIndices, ) -> Self

Create a sprite from an array of bytes and other metadata without a safety check.

Safety

Invalidates type’s safety invariant Sprite::from_byte_array would return None. It wont error if safety requirement is violated during const evaluation, instead resulting in undefined behavior when returned object’s methods are called.

impl<Bytes: AsRef<[u8]>> Sprite<Bytes>

pub fn from_bytes( bytes: Bytes, shape: [u32; 2], bpp: BitsPerPixel, draw_colors: DrawIndices, ) -> Option<Self>

impl<Bytes: ?Sized> Sprite<Bytes>

pub const fn bytes(&self) -> &Bytes

Get a reference to the sprite’s bytes.

pub const fn shape(&self) -> [u32; 2]

Get the sprite’s shape.

pub const fn width(&self) -> u32

Get the sprite’s width.

pub const fn height(&self) -> u32

Get the sprite’s height.

pub const fn bpp(&self) -> BitsPerPixel

Get the sprite’s bpp (bits per pixel).

impl Sprite

pub const fn view( &self, start: [u32; 2], shape: [u32; 2], ) -> Option<SpriteView<'_>>

Create a subview to the sprite. Returns None if subview is out of bounds of the sprite.

pub const unsafe fn view_unchecked( &self, start: [u32; 2], shape: [u32; 2], ) -> SpriteView<'_>

Create a subview to the sprite. Does not perform in bounds checks.

Safety

Resulting subview should be inside of the bounds of the Sprite

Trait Implementations

impl<Bytes: Clone + ?Sized> Clone for Sprite<Bytes>

fn clone(&self) -> Sprite<Bytes>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Bytes: Copy + ?Sized> Copy for Sprite<Bytes>