Struct pixel_engine::Sprite

pub struct Sprite { /* private fields */ }

Represent a Sprite

Implementations

impl Sprite

pub fn size(&self) -> &Vec2d<u32>

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn get_read_lock(&self) -> (&mut [u8], RwLockWriteGuard<'_, RawRwLock, ()>)

pub fn load_rgba(
    rgba: &[u8],
    width: usize,
    height: usize
) -> Result<Sprite, String>

Load an rgba slice as an Sprite, will clone the slice the dimentions are in pixel

Errors

if the slice isn’t an rgba slice it will return an Err this means that slice.len() % 4 = 0 and that slice.len() = width * height * 4

pub fn create_sub_sprite(
    &self,
    pos: Vec2d<i32>,
    size: Vec2d<u32>
) -> Result<SpriteMutRef<'_>, OverlappingError>

Creates a subsprite on a given parent sprite The real position will be clamped to the sprite dimentions, so if the pos has some negative parts, it will be clipped, only showing the positive part. Same with if the size + pos goes outside of the sprite.

Errors

This will return an error if an subsprite already exists and that it overlaps

pub unsafe fn create_sub_sprite_unchecked(
    &self,
    pos: Vec2d<u32>,
    size: Vec2d<u32>,
    index: usize
) -> SpriteMutRef<'_>

Creates a subsprite without any checks

Safety

• You need to make sure there is no overlap with another subsprite
• You need to make sure that the size is correct and fit inside the base sprites
• You need to make sure that the area has been inserted in the area list and that the given index is the one pointing to the subsprite’s area;

pub unsafe fn get_areas(&self) -> &Mutex<RawMutex, Slab<Area>>

This is used when using create_sub_sprite_unchecked()

Safety

Editing this could lead to overlapping subsprite so be careful when handling the list (slab) of areas.

pub fn load_image_bytes(bytes: &[u8]) -> Result<Sprite, String>

Load an image from bytes, will clone the slice

Errors

If the slice isn’t an valid image format handled by the image crate, returns an error

pub fn load_from_file<P>(path: P) -> Result<Sprite, String>where
    P: AsRef<Path>,

Load a image file and return a Sprite object representing that image

Errors

If the file isn’t an valid image format handled by the image crate or if the file IO failed, returns an error

pub fn new_blank() -> Sprite

Create Sprite with a size of 1x1

pub fn new_with_color(w: u32, h: u32, col: Color) -> Sprite

Create Sprite with given size and Color

pub fn new(w: u32, h: u32) -> Sprite

Create a blank Sprite with given size

pub fn set_pixel(&mut self, x: u32, y: u32, col: Color)

Set pixel’s Color on a Sprite

pub fn get_pixel(&self, x: u32, y: u32) -> Color

Return the Color of the pixel at given coordinates, if it exist

pub fn get_sample(&self, x: f64, y: f64) -> Color

Return the Color of the pixel at given sample This sampling will take only the fractional part of the given sample coordinates, so it is effictivly from [O; 1)

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sprite

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

Formats the value using the given formatter.

impl DrawSpriteTrait for Sprite

unsafe fn get_pixel_unchecked(&self, pos: Vec2d<u32>) -> Color

Safety

its up to the caller to make sure that the given position is in bounds

unsafe fn set_pixel_unchecked(&mut self, pos: Vec2d<u32>, col: Color)

Safety

its up to the caller to make sure that the given position is in bounds

fn get_pixel(&self, pos: Vec2d<i32>) -> Option<Color>

fn set_pixel(&mut self, pos: Vec2d<i32>, col: Color)

fn size(&self) -> Vec2d<u32>

impl Send for Sprite