Struct pixel_engine::Sprite

pub struct Sprite {
    pub width: u32,
    pub height: u32,
    // some fields omitted
}

Represent a Sprite

Fields

width: u32

The width (in pixels) of the Sprite

height: u32

The height (in pixels) of the Sprite

Implementations

impl Sprite

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

Load an rgba slice as an Sprite, will clone the slice

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

Load an image from bytes, will clone the slice

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

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 It needs to be between 0.0 and 1.0 (both included)

pub fn get_raw(&self) -> Box<[u8], Global>

Return the raw Image of the sprite

Trait Implementations

impl Clone for Sprite

pub 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

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

Formats the value using the given formatter.