Batch (libGDX Core 1.5.1 API)

All Superinterfaces:

Disposable

All Known Implementing Classes:

CpuSpriteBatch, PolygonSpriteBatch, SpriteBatch
```
public interface Batch
extends Disposable
```
A Batch is used to draw 2D rectangles that reference a texture (region). The class will batch the drawing commands and optimize them for processing by the GPU.
To draw something with a Batch one has to first call the begin() method which will setup appropriate render states. When you are done with drawing you have to call end() which will actually draw the things you specified.
All drawing commands of the Batch operate in screen coordinates. The screen coordinate system has an x-axis pointing to the right, an y-axis pointing upwards and the origin is in the lower left corner of the screen. You can also provide your own transformation and projection matrices if you so wish.
A Batch is managed. In case the OpenGL context is lost all OpenGL resources a Batch uses internally get invalidated. A context is lost when a user switches to another application or receives an incoming call on Android. A Batch will be automatically reloaded after the OpenGL context is restored.
A Batch is a pretty heavy object so you should only ever have one in your program.
A Batch works with OpenGL ES 1.x and 2.0. In the case of a 2.0 context it will use its own custom shader to draw all provided sprites. You can set your own custom shader via setShader(ShaderProgram).
A Batch has to be disposed if it is no longer used.

Author:

mzechner, Nathan Sweet

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`C1`
`static int`	`C2`
`static int`	`C3`
`static int`	`C4`
`static int`	`U1`
`static int`	`U2`
`static int`	`U3`
`static int`	`U4`
`static int`	`V1`
`static int`	`V2`
`static int`	`V3`
`static int`	`V4`
`static int`	`X1`
`static int`	`X2`
`static int`	`X3`
`static int`	`X4`
`static int`	`Y1`
`static int`	`Y2`
`static int`	`Y3`
`static int`	`Y4`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`begin()` Sets up the Batch for drawing.
`void`	`disableBlending()` Disables blending for drawing sprites.
`void`	`draw(Texture texture, float[] spriteVertices, int offset, int count)` Draws a rectangle using the given vertices.
`void`	`draw(Texture texture, float x, float y)` Draws a rectangle with the bottom left corner at x,y having the width and height of the texture.
`void`	`draw(Texture texture, float x, float y, float width, float height)` Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
`void`	`draw(Texture texture, float x, float y, float width, float height, float u, float v, float u2, float v2)` Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels.
`void`	`draw(Texture texture, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation, int srcX, int srcY, int srcWidth, int srcHeight, boolean flipX, boolean flipY)` Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels.
`void`	`draw(Texture texture, float x, float y, float width, float height, int srcX, int srcY, int srcWidth, int srcHeight, boolean flipX, boolean flipY)` Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels.
`void`	`draw(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight)` Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels.
`void`	`draw(TextureRegion region, float x, float y)` Draws a rectangle with the bottom left corner at x,y having the width and height of the region.
`void`	`draw(TextureRegion region, float width, float height, Affine2 transform)` Draws a rectangle transformed by the given matrix.
`void`	`draw(TextureRegion region, float x, float y, float width, float height)` Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
`void`	`draw(TextureRegion region, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation)` Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
`void`	`draw(TextureRegion region, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation, boolean clockwise)` Draws a rectangle with the texture coordinates rotated 90 degrees.
`void`	`enableBlending()` Enables blending for drawing sprites.
`void`	`end()` Finishes off rendering.
`void`	`flush()` Causes any pending sprites to be rendered, without ending the Batch.
`int`	`getBlendDstFunc()`
`int`	`getBlendSrcFunc()`
`Color`	`getColor()`
`float`	`getPackedColor()`
`Matrix4`	`getProjectionMatrix()` Returns the current projection matrix.
`Matrix4`	`getTransformMatrix()` Returns the current transform matrix.
`boolean`	`isBlendingEnabled()`
`boolean`	`isDrawing()`
`void`	`setBlendFunction(int srcFunc, int dstFunc)` Sets the blending function to be used when rendering sprites.
`void`	`setColor(Color tint)` Sets the color used to tint images when they are added to the Batch.
`void`	`setColor(float color)`
`void`	`setColor(float r, float g, float b, float a)`
`void`	`setProjectionMatrix(Matrix4 projection)` Sets the projection matrix to be used by this Batch.
`void`	`setShader(ShaderProgram shader)` Sets the shader to be used in a GLES 2.0 environment.
`void`	`setTransformMatrix(Matrix4 transform)` Sets the transform matrix to be used by this Batch.

Methods inherited from interface com.badlogic.gdx.utils.Disposable
dispose

- Field Detail
  - X1
```
static final int X1
```
    See Also:
    Constant Field Values
  - Y1
```
static final int Y1
```
    See Also:
    Constant Field Values
  - C1
```
static final int C1
```
    See Also:
    Constant Field Values
  - U1
```
static final int U1
```
    See Also:
    Constant Field Values
  - V1
```
static final int V1
```
    See Also:
    Constant Field Values
  - X2
```
static final int X2
```
    See Also:
    Constant Field Values
  - Y2
```
static final int Y2
```
    See Also:
    Constant Field Values
  - C2
```
static final int C2
```
    See Also:
    Constant Field Values
  - U2
```
static final int U2
```
    See Also:
    Constant Field Values
  - V2
```
static final int V2
```
    See Also:
    Constant Field Values
  - X3
```
static final int X3
```
    See Also:
    Constant Field Values
  - Y3
```
static final int Y3
```
    See Also:
    Constant Field Values
  - C3
```
static final int C3
```
    See Also:
    Constant Field Values
  - U3
```
static final int U3
```
    See Also:
    Constant Field Values
  - V3
```
static final int V3
```
    See Also:
    Constant Field Values
  - X4
```
static final int X4
```
    See Also:
    Constant Field Values
  - Y4
```
static final int Y4
```
    See Also:
    Constant Field Values
  - C4
```
static final int C4
```
    See Also:
    Constant Field Values
  - U4
```
static final int U4
```
    See Also:
    Constant Field Values
  - V4
```
static final int V4
```
    See Also:
    Constant Field Values
- Method Detail
  - begin
```
void begin()
```
    Sets up the Batch for drawing. This will disable depth buffer writing. It enables blending and texturing. If you have more texture units enabled than the first one you have to disable them before calling this. Uses a screen coordinate system by default where everything is given in pixels. You can specify your own projection and modelview matrices via setProjectionMatrix(Matrix4) and setTransformMatrix(Matrix4).
  - end
```
void end()
```
    Finishes off rendering. Enables depth writes, disables blending and texturing. Must always be called after a call to begin()
  - setColor
```
void setColor(Color tint)
```
    Sets the color used to tint images when they are added to the Batch. Default is Color.WHITE.
  - setColor
```
void setColor(float r,
            float g,
            float b,
            float a)
```
    See Also:
    setColor(Color)
  - setColor
```
void setColor(float color)
```
    See Also:
    setColor(Color), Color.toFloatBits()
  - getColor
```
Color getColor()
```
    Returns:
    the rendering color of this Batch. Manipulating the returned instance has no effect.
  - getPackedColor
```
float getPackedColor()
```
    Returns:
    the rendering color of this Batch in vertex format
    See Also:
    Color.toFloatBits()
  - draw
```
void draw(Texture texture,
        float x,
        float y,
        float originX,
        float originY,
        float width,
        float height,
        float scaleX,
        float scaleY,
        float rotation,
        int srcX,
        int srcY,
        int srcWidth,
        int srcHeight,
        boolean flipX,
        boolean flipY)
```
    Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. The rectangle is offset by originX, originY relative to the origin. Scale specifies the scaling factor by which the rectangle should be scaled around originX, originY. Rotation specifies the angle of counter clockwise rotation of the rectangle around originX, originY. The portion of the Texture given by srcX, srcY and srcWidth, srcHeight is used. These coordinates and sizes are given in texels. FlipX and flipY specify whether the texture portion should be flipped horizontally or vertically.
    
    Parameters:
    x - the x-coordinate in screen space
    y - the y-coordinate in screen space
    originX - the x-coordinate of the scaling and rotation origin relative to the screen space coordinates
    originY - the y-coordinate of the scaling and rotation origin relative to the screen space coordinates
    width - the width in pixels
    height - the height in pixels
    scaleX - the scale of the rectangle around originX/originY in x
    scaleY - the scale of the rectangle around originX/originY in y
    rotation - the angle of counter clockwise rotation of the rectangle around originX/originY
    srcX - the x-coordinate in texel space
    srcY - the y-coordinate in texel space
    srcWidth - the source with in texels
    srcHeight - the source height in texels
    flipX - whether to flip the sprite horizontally
    flipY - whether to flip the sprite vertically
  - draw
```
void draw(Texture texture,
        float x,
        float y,
        float width,
        float height,
        int srcX,
        int srcY,
        int srcWidth,
        int srcHeight,
        boolean flipX,
        boolean flipY)
```
    Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. The portion of the Texture given by srcX, srcY and srcWidth, srcHeight is used. These coordinates and sizes are given in texels. FlipX and flipY specify whether the texture portion should be flipped horizontally or vertically.
    
    Parameters:
    x - the x-coordinate in screen space
    y - the y-coordinate in screen space
    width - the width in pixels
    height - the height in pixels
    srcX - the x-coordinate in texel space
    srcY - the y-coordinate in texel space
    srcWidth - the source with in texels
    srcHeight - the source height in texels
    flipX - whether to flip the sprite horizontally
    flipY - whether to flip the sprite vertically
  - draw
```
void draw(Texture texture,
        float x,
        float y,
        int srcX,
        int srcY,
        int srcWidth,
        int srcHeight)
```
    Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. The portion of the Texture given by srcX, srcY and srcWidth, srcHeight are used. These coordinates and sizes are given in texels.
    
    Parameters:
    x - the x-coordinate in screen space
    y - the y-coordinate in screen space
    srcX - the x-coordinate in texel space
    srcY - the y-coordinate in texel space
    srcWidth - the source with in texels
    srcHeight - the source height in texels
  - draw
```
void draw(Texture texture,
        float x,
        float y,
        float width,
        float height,
        float u,
        float v,
        float u2,
        float v2)
```
    Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. The portion of the Texture given by u, v and u2, v2 are used. These coordinates and sizes are given in texture size percentage. The rectangle will have the given tint Color.
    
    Parameters:
    x - the x-coordinate in screen space
    y - the y-coordinate in screen space
    width - the width in pixels
    height - the height in pixels
  - draw
```
void draw(Texture texture,
        float x,
        float y)
```
    Draws a rectangle with the bottom left corner at x,y having the width and height of the texture.
    
    Parameters:
    x - the x-coordinate in screen space
    y - the y-coordinate in screen space
  - draw
```
void draw(Texture texture,
        float x,
        float y,
        float width,
        float height)
```
    Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
  - draw
```
void draw(Texture texture,
        float[] spriteVertices,
        int offset,
        int count)
```
    Draws a rectangle using the given vertices. There must be 4 vertices, each made up of 5 elements in this order: x, y, color, u, v. The getColor() from the Batch is not applied.
  - draw
```
void draw(TextureRegion region,
        float x,
        float y)
```
    Draws a rectangle with the bottom left corner at x,y having the width and height of the region.
  - draw
```
void draw(TextureRegion region,
        float x,
        float y,
        float width,
        float height)
```
    Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
  - draw
```
void draw(TextureRegion region,
        float x,
        float y,
        float originX,
        float originY,
        float width,
        float height,
        float scaleX,
        float scaleY,
        float rotation)
```
    Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height. The rectangle is offset by originX, originY relative to the origin. Scale specifies the scaling factor by which the rectangle should be scaled around originX, originY. Rotation specifies the angle of counter clockwise rotation of the rectangle around originX, originY.
  - draw
```
void draw(TextureRegion region,
        float x,
        float y,
        float originX,
        float originY,
        float width,
        float height,
        float scaleX,
        float scaleY,
        float rotation,
        boolean clockwise)
```
    Draws a rectangle with the texture coordinates rotated 90 degrees. The bottom left corner at x,y and stretching the region to cover the given width and height. The rectangle is offset by originX, originY relative to the origin. Scale specifies the scaling factor by which the rectangle should be scaled around originX, originY. Rotation specifies the angle of counter clockwise rotation of the rectangle around originX, originY.
    
    Parameters:
    clockwise - If true, the texture coordinates are rotated 90 degrees clockwise. If false, they are rotated 90 degrees counter clockwise.
  - draw
```
void draw(TextureRegion region,
        float width,
        float height,
        Affine2 transform)
```
    Draws a rectangle transformed by the given matrix.
  - flush
```
void flush()
```
    Causes any pending sprites to be rendered, without ending the Batch.
  - disableBlending
```
void disableBlending()
```
    Disables blending for drawing sprites. Calling this within begin()/end() will flush the batch.
  - enableBlending
```
void enableBlending()
```
    Enables blending for drawing sprites. Calling this within begin()/end() will flush the batch.
  - setBlendFunction
```
void setBlendFunction(int srcFunc,
                    int dstFunc)
```
    Sets the blending function to be used when rendering sprites.
    
    Parameters:
    srcFunc - the source function, e.g. GL11.GL_SRC_ALPHA. If set to -1, Batch won't change the blending function.
    dstFunc - the destination function, e.g. GL11.GL_ONE_MINUS_SRC_ALPHA
  - getBlendSrcFunc
```
int getBlendSrcFunc()
```
  - getBlendDstFunc
```
int getBlendDstFunc()
```
  - getProjectionMatrix
```
Matrix4 getProjectionMatrix()
```
    Returns the current projection matrix. Changing this within begin()/end() results in undefined behaviour.
  - getTransformMatrix
```
Matrix4 getTransformMatrix()
```
    Returns the current transform matrix. Changing this within begin()/end() results in undefined behaviour.
  - setProjectionMatrix
```
void setProjectionMatrix(Matrix4 projection)
```
    Sets the projection matrix to be used by this Batch. If this is called inside a begin()/end() block, the current batch is flushed to the gpu.
  - setTransformMatrix
```
void setTransformMatrix(Matrix4 transform)
```
    Sets the transform matrix to be used by this Batch. If this is called inside a begin()/end() block, the current batch is flushed to the gpu.
  - setShader
```
void setShader(ShaderProgram shader)
```
    Sets the shader to be used in a GLES 2.0 environment. Vertex position attribute is called "a_position", the texture coordinates attribute is called "a_texCoord0", the color attribute is called "a_color". See ShaderProgram.POSITION_ATTRIBUTE, ShaderProgram.COLOR_ATTRIBUTE and ShaderProgram.TEXCOORD_ATTRIBUTE which gets "0" appended to indicate the use of the first texture unit. The combined transform and projection matrx is uploaded via a mat4 uniform called "u_projTrans". The texture sampler is passed via a uniform called "u_texture".
    Call this method with a null argument to use the default shader.
    This method will flush the batch before setting the new shader, you can call it in between begin() and end().
    
    Parameters:
    shader - the ShaderProgram or null to use the default shader.
  - isBlendingEnabled
```
boolean isBlendingEnabled()
```
    Returns:
    true if blending for sprites is enabled
  - isDrawing
```
boolean isDrawing()
```
    Returns:
    true if currently between begin and end.

Interface Batch

Field Summary

Method Summary

Methods inherited from interface com.badlogic.gdx.utils.Disposable

Field Detail

X1

Y1

C1

U1

V1

X2

Y2

C2

U2

V2

X3

Y3

C3

U3

V3

X4

Y4

C4

U4

V4

Method Detail

begin

end

setColor

setColor

setColor

getColor

getPackedColor

draw

draw

draw

draw

draw

draw

draw

draw

draw

draw

draw

draw

flush

disableBlending

enableBlending

setBlendFunction

getBlendSrcFunc

getBlendDstFunc

getProjectionMatrix

getTransformMatrix

setProjectionMatrix

setTransformMatrix

setShader

isBlendingEnabled

isDrawing