Struct SpriteSheet 

pub struct SpriteSheet { /* private fields */ }

Defines a sprite sheet with uniform frame grid dimensions.

Implementations

impl SpriteSheet

Implements frame extraction, rendering, and animation creation for SpriteSheet.

pub fn from_image( image: HtmlImageElement, frame_width: f64, frame_height: f64, ) -> SpriteSheet

Creates a new sprite sheet from an image element and uniform frame dimensions.

Computes the grid columns and rows from the image dimensions and frame size.

Arguments

• HtmlImageElement - The sprite sheet image.
• f64 - The width of each frame.
• f64 - The height of each frame.

Returns

• SpriteSheet - The new sprite sheet.

pub fn frame_source(&self, index: u32) -> Rect

Returns the source rectangle for the frame at the given grid index.

Arguments

• u32 - The frame index (left-to-right, top-to-bottom).

Returns

• Rect - The source rectangle.

pub fn frame(&self, index: u32) -> SpriteFrame

Creates a frame at the given grid index with a default duration.

Arguments

• u32 - The frame index.

Returns

• SpriteFrame - The new frame.

pub fn animation( &self, name: &str, start: u32, end: u32, mode: AnimationMode, ) -> SpriteAnimation

Creates an animation from a range of frame indices.

Arguments

• &str - The animation name.
• u32 - The starting frame index (inclusive).
• u32 - The ending frame index (exclusive).
• AnimationMode - The playback mode.

Returns

• SpriteAnimation - The new animation.

pub fn draw_frame( &self, context: &CanvasRenderingContext2d, frame_index: u32, transform: &Transform2D, )

Draws a static (non-animated) sprite frame onto the canvas.

Arguments

• &CanvasRenderingContext2d - The canvas context.
• u32 - The frame index to draw.
• &Transform2D - The world-space transform to apply.

impl SpriteSheet

pub fn get_image(&self) -> &HtmlImageElement

pub fn get_mut_image(&mut self) -> &mut HtmlImageElement

pub fn set_image(&mut self, val: HtmlImageElement) -> &mut Self

pub fn get_frame_width(&self) -> f64

pub fn get_mut_frame_width(&mut self) -> &mut f64

pub fn set_frame_width(&mut self, val: f64) -> &mut Self

pub fn get_frame_height(&self) -> f64

pub fn get_mut_frame_height(&mut self) -> &mut f64

pub fn set_frame_height(&mut self, val: f64) -> &mut Self

impl SpriteSheet

pub fn new( image: HtmlImageElement, frame_width: f64, frame_height: f64, columns: u32, rows: u32, ) -> Self

Trait Implementations

impl Clone for SpriteSheet

fn clone(&self) -> SpriteSheet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpriteSheet

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

Formats the value using the given formatter.

impl PartialEq for SpriteSheet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SpriteSheet