Struct SpriteBatch 

pub struct SpriteBatch { /* private fields */ }

SpriteBatch is a datastructure that handle all sprites that have the same texture. And make only 1 drawCall to draw them all. this way you can highly optimise data sended to GPU. You should use it in system where there is a lot’s of sprite that should be drawn with the same shaders and the same texture. SpriteBatch is a kind of collection that implement some iterator traits.

    let texture = Rc::new(Texture::from_path("path_to_texture"));
    let mut batch = SpriteBatch::from(&texture);

    SpriteData

The idea behind SpriteBatch is to limit draw calls. Even if your sprites havn’t the same texture can pack textures. And give your Vertex text_coord the actual texture coordinate that you want to be drawn.

Implementations

impl SpriteBatch

pub fn new() -> SpriteBatch

Create a new empty spriteBatch

pub fn extend_from_slice(&mut self, slice: &mut [SpriteData])

pub fn clear(&mut self)

Clear data.

pub fn reserve(&mut self, len: usize)

Reserve data for vertice and sprites.

pub fn sprites(&self) -> &[SpriteData]

Return spritedata slice

pub fn sprites_mut(&mut self) -> &mut [SpriteData]

Return sprite mutable slice

pub fn get_sprite_mut(&mut self, idx: usize) -> Option<&mut SpriteData>

Return maybe a mutable Slice.

Examples found in repository

examples/batch.rs (line 54)

fn event_process(event: Event, window: &mut Window, batch: &mut SpriteBatch) {
    match event.1 {
        Events::Key(Key::Escape, _, _, _) => {
            window.close();
        }
        Events::Key(Key::W, _, Action::Press, _) => {
            batch.translate(Vector::new(10.0, 10.0));
        }
        Events::Key(Key::D, _, Action::Press, _) => {
            batch
                .get_sprite_mut(0)
                .unwrap()
                .translate(Vector::new(10.0, 0.0));
        }
        Events::MouseButton(_, _, _) => {
            println!("Mouse button !");
        }
        Events::CursorPos(x, y) => {
            println!("x: {}, y: {}", x, y);
        }
        _ => println!("Another event !"),
    }
    drop(event);
}

pub fn get_sprite(&self, idx: usize) -> Option<&SpriteData>

Return maybe a SpriteData.

pub fn push_sprite(&mut self, sprites: SpriteData)

Examples found in repository

examples/batch.rs (line 23)

fn main() -> Result<(), Box<Error>> {
    let mut window = Window::new(gust::WIDTH, gust::HEIGHT, "Hello");

    let texture = Rc::new(Texture::from_path("examples/texture/Dirt.png").unwrap());
    let mut batch = SpriteBatch::from(&texture);
    for i in 0..1_000_000 {
        let mut data = SpriteData::new(Vector::new(i as f32 * 1.0, i as f32 * 10.0));
        data.set_texture_raw([Vector::new(0.0, 0.0), Vector::new(1.0, 1.0)]);
        batch.push_sprite(data);
    }

    let event_handler = EventHandler::new(&window);

    window.set_clear_color(Color::new(0.45, 0.0, 1.0));
    window.enable_cursor();
    window.poll(None);
    while window.is_open() {
        window.poll_events();
        for event in event_handler.fetch() {
            event_process(event, &mut window, &mut batch);
        }
        window.clear();
        window.draw_mut(&mut batch);
        window.display();
    }

    Ok(())
}

pub fn pop_sprite(&mut self) -> Option<SpriteData>

Pop a sprite and return it’s data.

Trait Implementations

impl Clone for SpriteBatch

fn clone(&self) -> SpriteBatch

Returns a duplicate 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 Default for SpriteBatch

fn default() -> Self

Returns the “default value” for a type.

impl Drawable for SpriteBatch

fn draw<T: Drawer>(&self, target: &mut T)

Draw the drawable structure, you need a Drawer(Where the struct will be draw)

fn draw_with_context(&self, _context: &mut Context<'_>)

Draw with a particular context

fn update(&mut self)

Update the openGL state of the drawable entity Should be call often so be carefull when implementing.

fn setup_draw(&self, context: &mut Context<'_>)

Setup the draw for the final system you don’t have to implement it in a normal drawable

impl DrawableMut for SpriteBatch

fn draw_mut<T: Drawer>(&mut self, target: &mut T)

Mutable version of draw function.

fn draw_with_context_mut(&mut self, context: &mut Context<'_>)

Mutable draw context function.

impl From<&Rc<Texture>> for SpriteBatch

fn from(what: &Rc<Texture>) -> SpriteBatch

Converts to this type from the input type.

impl Movable for SpriteBatch

fn translate<T>(&mut self, vec: Vector<T>)

where T: Scalar + Into<f32>,

Move the sprite off the offset

fn get_position(&self) -> Vector<f32>

Get current position

fn set_position<T>(&mut self, vec: Vector<T>)

where T: Scalar + Into<f32>,

Set position of the sprite

impl Rotable for SpriteBatch

fn rotate<T>(&mut self, angle: T)

where T: Scalar + Into<f32>,

Rotate from the actual angle with the angle given in argument.

fn set_rotation<T>(&mut self, angle: T)

where T: Scalar + Into<f32>,

Set the rotation of the Rotable struct.

fn get_rotation(&self) -> f32

Return the rotation of the struct.

impl Scalable for SpriteBatch

fn set_scale<T>(&mut self, vec: Vector<T>)

where T: Scalar + Into<f32>,

Set the scale of the sprite

fn get_scale(&self) -> Vector<f32>

Get the current scale

fn scale<T>(&mut self, factor: Vector<T>)

where T: Scalar + Into<f32>,

Scale the sprite from a factor

impl Transformable for SpriteBatch

fn contain<T: Scalar + Into<f32>>(&self, _vec: Point<T>) -> bool

Move the sprite off the offset.

fn set_origin<T: Scalar + Into<f32>>(&mut self, origin: Vector<T>)

Set the origin of the object.

fn get_origin(&self) -> Vector<f32>

Get the origin of the transformable.