Struct amethyst_rendy::sprite::Sprite

pub struct Sprite {
    pub width: f32,
    pub height: f32,
    pub offsets: [f32; 2],
    pub tex_coords: TextureCoordinates,
}

Dimensions and texture coordinates of each sprite in a sprite sheet.

Fields

width: f32

Pixel width of the sprite

height: f32

Pixel height of the sprite

offsets: [f32; 2]

Number of pixels to shift the sprite to the left and down relative to the entity

tex_coords: TextureCoordinates

Texture coordinates of the sprite

Methods

impl Sprite

pub fn from_pixel_values(
    image_w: u32,
    image_h: u32,
    sprite_w: u32,
    sprite_h: u32,
    pixel_left: u32,
    pixel_top: u32,
    offsets: [f32; 2],
    flip_horizontal: bool,
    flip_vertical: bool
) -> Sprite

Creates a Sprite from pixel values.

This function expects pixel coordinates -- starting from the top left of the image. X increases to the right, Y increases downwards. Texture coordinates are calculated from the pixel values.

Parameters

• image_w: Width of the full sprite sheet.
• image_h: Height of the full sprite sheet.
• sprite_w: Width of the sprite.
• sprite_h: Height of the sprite.
• pixel_left: Pixel X coordinate of the left side of the sprite.
• pixel_top: Pixel Y coordinate of the top of the sprite.
• offsets: Number of pixels to shift the sprite to the left and down relative to the entity.

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 PartialEq<Sprite> for Sprite

fn eq(&self, other: &Sprite) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Sprite) -> bool

This method tests for !=.

impl From<((f32, f32), [f32; 4])> for Sprite

fn from((dimensions, tex_coords): ((f32, f32), [f32; 4])) -> Self

Performs the conversion.

impl From<((f32, f32), [f32; 2], [f32; 4])> for Sprite

fn from(
    ((width, height), offsets, tex_coords): ((f32, f32), [f32; 2], [f32; 4])
) -> Self

Performs the conversion.

impl Debug for Sprite

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

Formats the value using the given formatter.

impl Serialize for Sprite

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Sprite

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.