Struct pixel_game_lib::sprite::Sprite

pub struct Sprite { /* private fields */ }

Sprite that can be drawn on the canvas.

Implementations

impl Sprite

pub fn from_buffer( buffer: &[u32], size: Extent2<usize>, offset: SpriteOffset ) -> Self

Create a sprite from a buffer of colors.

pub fn render(&self, offset: Vec2<f64>, canvas: &mut Canvas<'_>)

Draw the sprite based on a camera offset.

pub fn render_area( &self, offset: Vec2<f64>, area: Extent2<usize>, canvas: &mut Canvas<'_> )

Draw the sprite filling the area.

The behavior depends on the metadata of the sprite.

pub fn render_options( &self, blit_options: &BlitOptions, canvas: &mut Canvas<'_> )

Draw the sprite with custom blitting options.

This won’t set any of the regular defaults, like the position.

pub fn is_pixel_transparent(&self, pixel: Vec2<u32>) -> bool

Whether a pixel on the image is transparent.

pub fn width(&self) -> u32

Width of the image.

pub fn height(&self) -> u32

Height of the image.

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

Size of the image.

pub fn into_blit_buffer(self) -> BlitBuffer

Raw buffer.

pub fn pixels_mut(&mut self) -> &mut [u32]

Get the raw pixels.

Trait Implementations

impl Compound for Sprite

fn load(cache: AnyCache<'_>, id: &SharedString) -> Result<Self, BoxedError>

Loads an asset from the cache.

const HOT_RELOADED: bool = true

If false, disable hot-reloading for assets of this type (true by default). If so, you may want to implement NotHotReloaded for this type to enable additional functions.

impl Debug for Sprite

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

Formats the value using the given formatter.

impl Default for Sprite

fn default() -> Self

Returns the “default value” for a type.