Struct olc_pixel_game_engine::Sprite

pub struct Sprite { /* fields omitted */ }

Mirror of olc::Sprite. An image represented by a 2D array of olc::Pixel.

Implementations

impl Sprite

pub fn empty() -> Self

Returns a new empty sprite, alias for Sprite::new. This can be used to initialise a sprite instead of using Option.

pub fn new() -> Self

Creates a new empty sprite.

pub fn with_dims(width: i32, height: i32) -> Self

Creates an empty sprite with dimensions width x height.

pub fn from_image(path: &str) -> Result<Self, Error>

Loads a sprite from the image. Returns error if the image could be loaded.

pub fn width(&self) -> i32

Returns width of the sprite.

pub fn height(&self) -> i32

Returns height of the sprite.

pub fn has_data(&self) -> bool

Returns true if sprite has data.

pub fn sample_mode(&self) -> SpriteMode

Returns sample mode for the sprite.

pub fn set_sample_mode(&mut self, mode: SpriteMode)

Sets sample mode.

pub fn get_pixel(&self, x: i32, y: i32) -> Pixel

Returns pixel at (x, y).

pub fn set_pixel(&mut self, x: i32, y: i32, p: Pixel) -> bool

Sets pixel at (x, y).

pub fn sample(&self, x: f32, y: f32) -> Pixel

Samples sprite for x and y, x and y should be between 0.0 and 1.0.

pub fn sample_bl(&self, u: f32, v: f32) -> Pixel

Sample BL for u and v.

Trait Implementations

impl Debug for Sprite

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

Formats the value using the given formatter.

impl Display for Sprite

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

Formats the value using the given formatter.

impl Drop for Sprite

fn drop(&mut self)

Executes the destructor for this type.