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 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.

Methods

impl SpriteBatch

pub fn new(image: Image) -> Self

Creates a new SpriteBatch, drawing with the given image.

pub fn add(&mut self, param: DrawParam) -> SpriteIdx

Adds a new sprite to the sprite batch.

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

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

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

pub fn clear(&mut self)

Removes all data from the sprite batch.

pub fn into_inner(self) -> Image

Unwraps the contained Image

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

Replaces the contained Image, returning the old one.

pub fn with_image<'a>(&'a mut self, image: &'a Image) -> BoundSpriteBatch<'a>

Deprecated

Create an object which draws the current sprite batch with a different image.

Trait Implementations

impl Debug for SpriteBatch

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

Formats the value using the given formatter.

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 Drawable for SpriteBatch

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

Actually draws the object to the screen.

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 get_blend_mode(&self) -> Option<BlendMode>

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

fn draw(&self, ctx: &mut Context, dest: Point2, rotation: f32) -> GameResult<()>

Draws the drawable onto the rendering target.