Struct olc_pixel_game_engine::Sprite
source · pub struct Sprite { /* private fields */ }
Expand description
Mirror of olc::Sprite
.
An image represented by a 2D array of olc::Pixel
.
Implementations§
source§impl Sprite
impl Sprite
sourcepub fn empty() -> Self
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
.
sourcepub fn with_dims(width: i32, height: i32) -> Self
pub fn with_dims(width: i32, height: i32) -> Self
Creates an empty sprite with dimensions width
x height
.
sourcepub fn from_image(path: &str) -> Result<Self, Error>
pub fn from_image(path: &str) -> Result<Self, Error>
Loads a sprite from the image. Returns error if the image could be loaded.
sourcepub fn sample_mode(&self) -> SpriteMode
pub fn sample_mode(&self) -> SpriteMode
Returns sample mode for the sprite.
sourcepub fn set_sample_mode(&mut self, mode: SpriteMode)
pub fn set_sample_mode(&mut self, mode: SpriteMode)
Sets sample mode.
Trait Implementations§
Auto Trait Implementations§
impl RefUnwindSafe for Sprite
impl !Send for Sprite
impl !Sync for Sprite
impl Unpin for Sprite
impl UnwindSafe for Sprite
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more