Struct ggez::graphics::spritebatch::SpriteBatch

pub struct SpriteBatch { /* fields omitted */ }

A SpriteBatch draws a number of copies of the same image, using a single draw call.

This is generally faster than drawing the same sprite with many invocations of draw(), though it has a bit of overhead to set up the batch. This overhead makes it run very slowly in debug mode because it spends a lot of time on array bounds checking and un-optimized math; you need to build with optimizations enabled to really get the speed boost.

Implementations

impl SpriteBatch

pub fn new(image: Image) -> Self

Creates a new SpriteBatch, drawing with the given image.

Takes ownership of the Image, but cloning an Image is cheap since they have an internal Arc containing the actual image data.

pub fn add<P>(&mut self, param: P) -> SpriteIdx where
    P: Into<DrawParam>, 

Adds a new sprite to the sprite batch.

Returns a handle with which to modify the sprite using set()

pub fn set<P>(&mut self, handle: SpriteIdx, param: P) -> GameResult where
    P: Into<DrawParam>, 

Alters a sprite in the batch to use the given draw params

pub fn get_sprites(&self) -> &[DrawParam]

Returns a reference to the sprites.

pub fn get_sprites_mut(&mut self) -> &mut [DrawParam]

Returns a mutable reference to the sprites.

Unlike with MeshBatch, manually calling flush after altering sprites in this slice is currently unnecessary, as SpriteBatch flushes automatically on every draw call. This might change in the future though.

pub fn clear(&mut self)

Removes all data from the sprite batch.

pub fn into_inner(self) -> Image

Unwraps and returns the contained Image

pub fn set_image(&mut self, image: Image) -> Image

Replaces the contained Image, returning the old one.

pub fn filter(&self) -> FilterMode

Get the filter mode for the SpriteBatch.

pub fn set_filter(&mut self, mode: FilterMode)

Set the filter mode for the SpriteBatch.

Trait Implementations

impl Clone for SpriteBatch

fn clone(&self) -> SpriteBatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteBatch

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

Formats the value using the given formatter.

impl Drawable for SpriteBatch

fn draw(&self, ctx: &mut Context, param: DrawParam) -> GameResult

Draws the drawable onto the rendering target.

fn dimensions(&self, _ctx: &mut Context) -> Option<Rect>

Returns a bounding box in the form of a Rect.

fn set_blend_mode(&mut self, mode: Option<BlendMode>)

Sets the blend mode to be used when drawing this drawable. This overrides the general graphics::set_blend_mode(). If None is set, defers to the blend mode set by graphics::set_blend_mode().

fn blend_mode(&self) -> Option<BlendMode>

Gets the blend mode to be used when drawing this drawable.

impl PartialEq<SpriteBatch> for SpriteBatch

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

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

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

This method tests for !=.

impl StructuralPartialEq for SpriteBatch