java.lang.Object
- com.badlogic.gdx.graphics.g2d.SpriteBatch

All Implemented Interfaces:

Batch, Disposable

Direct Known Subclasses:

CpuSpriteBatch
```
public class SpriteBatch
extends java.lang.Object
implements Batch
```
Draws batched quads using indices.

See Also:

Batch

Field Summary

Fields
Modifier and Type	Field	Description
`static Mesh.VertexDataType`	`defaultVertexDataType`	Deprecated. Do not use, this field is for testing only and is likely to be removed.
`int`	`maxSpritesInBatch`	The maximum number of sprites rendered in one batch so far.
`int`	`renderCalls`	Number of render calls since the last `begin()`.
`int`	`totalRenderCalls`	Number of rendering calls, ever.

Fields inherited from interface com.badlogic.gdx.graphics.g2d.Batch
C1, C2, C3, C4, U1, U2, U3, U4, V1, V2, V3, V4, X1, X2, X3, X4, Y1, Y2, Y3, Y4

Constructor Summary

Constructors
Constructor	Description
`SpriteBatch()`	Constructs a new SpriteBatch with a size of 1000, one buffer, and the default shader.
`SpriteBatch(int size)`	Constructs a SpriteBatch with one buffer and the default shader.
`SpriteBatch(int size, ShaderProgram defaultShader)`	Constructs a new SpriteBatch.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`begin()`	Sets up the Batch for drawing.
`static ShaderProgram`	`createDefaultShader()`	Returns a new instance of the default shader used by SpriteBatch for GL2 when no shader is specified.
`void`	`disableBlending()`	Disables blending for drawing sprites.
`void`	`dispose()`	Releases all resources of this object.
`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 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`	`draw(TextureRegion region, float width, float height, Affine2 transform)`	Draws a rectangle transformed by the given matrix.
`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`	`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`	`getBlendDstFuncAlpha()`
`int`	`getBlendSrcFunc()`
`int`	`getBlendSrcFuncAlpha()`
`Color`	`getColor()`
`float`	`getPackedColor()`
`Matrix4`	`getProjectionMatrix()`	Returns the current projection matrix.
`ShaderProgram`	`getShader()`
`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`	`setBlendFunctionSeparate(int srcFuncColor, int dstFuncColor, int srcFuncAlpha, int dstFuncAlpha)`	Sets separate (color/alpha) blending function to be used when rendering sprites.
`void`	`setColor(float r, float g, float b, float a)`
`void`	`setColor(Color tint)`	Sets the color used to tint images when they are added to the Batch.
`void`	`setPackedColor(float packedColor)`	Sets the rendering color of this Batch, expanding the alpha from 0-254 to 0-255.
`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.
`protected void`	`setupMatrices()`
`protected void`	`switchTexture(Texture texture)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defaultVertexDataType
```
@Deprecated
public static Mesh.VertexDataType defaultVertexDataType
```
    Deprecated.
    Do not use, this field is for testing only and is likely to be removed. Sets the Mesh.VertexDataType to be used when gles 3 is not available, defaults to Mesh.VertexDataType.VertexArray.
  - renderCalls
```
public int renderCalls
```
    Number of render calls since the last begin().
  - totalRenderCalls
```
public int totalRenderCalls
```
    Number of rendering calls, ever. Will not be reset unless set manually.
  - maxSpritesInBatch
```
public int maxSpritesInBatch
```
    The maximum number of sprites rendered in one batch so far.
- Constructor Detail
  - SpriteBatch
```
public SpriteBatch()
```
    Constructs a new SpriteBatch with a size of 1000, one buffer, and the default shader.
    
    See Also:
    
    SpriteBatch(int, ShaderProgram)
  - SpriteBatch
```
public SpriteBatch(int size)
```
    Constructs a SpriteBatch with one buffer and the default shader.
    
    See Also:
    
    SpriteBatch(int, ShaderProgram)
  - SpriteBatch
```
public SpriteBatch(int size,
                   ShaderProgram defaultShader)
```
    Constructs a new SpriteBatch. Sets the projection matrix to an orthographic projection with y-axis point upwards, x-axis point to the right and the origin being in the bottom left corner of the screen. The projection will be pixel perfect with respect to the current screen resolution.
    The defaultShader specifies the shader to use. Note that the names for uniforms for this default shader are different than the ones expect for shaders set with setShader(ShaderProgram). See createDefaultShader().
    
    Parameters:
    
    size - The max number of sprites in a single batch. Max of 8191.
    
    defaultShader - The default shader to use. This is not owned by the SpriteBatch and must be disposed separately.
- Method Detail
  - createDefaultShader
```
public static ShaderProgram createDefaultShader()
```
    Returns a new instance of the default shader used by SpriteBatch for GL2 when no shader is specified.
  - begin
```
public void begin()
```
    Description copied from interface: Batch
    
    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 Batch.setProjectionMatrix(Matrix4) and Batch.setTransformMatrix(Matrix4).
    
    Specified by:
    
    begin in interface Batch
  - end
```
public void end()
```
    Description copied from interface: Batch
    
    Finishes off rendering. Enables depth writes, disables blending and texturing. Must always be called after a call to Batch.begin()
    
    Specified by:
    
    end in interface Batch
  - setColor
```
public void setColor(Color tint)
```
    Description copied from interface: Batch
    
    Sets the color used to tint images when they are added to the Batch. Default is Color.WHITE.
    
    Specified by:
    
    setColor in interface Batch
  - setColor
```
public void setColor(float r,
                     float g,
                     float b,
                     float a)
```
    Specified by:
    
    setColor in interface Batch
    
    See Also:
    
    Batch.setColor(Color)
  - getColor
```
public Color getColor()
```
    Specified by:
    
    getColor in interface Batch
    
    Returns:
    
    the rendering color of this Batch. If the returned instance is manipulated, Batch.setColor(Color) must be called afterward.
  - setPackedColor
```
public void setPackedColor(float packedColor)
```
    Description copied from interface: Batch
    
    Sets the rendering color of this Batch, expanding the alpha from 0-254 to 0-255.
    
    Specified by:
    
    setPackedColor in interface Batch
    
    See Also:
    
    Batch.setColor(Color), Color.toFloatBits()
  - getPackedColor
```
public float getPackedColor()
```
    Specified by:
    
    getPackedColor in interface Batch
    
    Returns:
    
    the rendering color of this Batch in vertex format (alpha compressed to 0-254)
    
    See Also:
    
    Color.toFloatBits()
  - draw
```
public 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)
```
    Description copied from interface: Batch
    
    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.
    
    Specified by:
    
    draw in interface Batch
    
    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
```
public void draw(Texture texture,
                 float x,
                 float y,
                 float width,
                 float height,
                 int srcX,
                 int srcY,
                 int srcWidth,
                 int srcHeight,
                 boolean flipX,
                 boolean flipY)
```
    Description copied from interface: Batch
    
    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.
    
    Specified by:
    
    draw in interface Batch
    
    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
```
public void draw(Texture texture,
                 float x,
                 float y,
                 int srcX,
                 int srcY,
                 int srcWidth,
                 int srcHeight)
```
    Description copied from interface: Batch
    
    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.
    
    Specified by:
    
    draw in interface Batch
    
    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
```
public void draw(Texture texture,
                 float x,
                 float y,
                 float width,
                 float height,
                 float u,
                 float v,
                 float u2,
                 float v2)
```
    Description copied from interface: Batch
    
    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.
    
    Specified by:
    
    draw in interface Batch
    
    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
```
public void draw(Texture texture,
                 float x,
                 float y)
```
    Description copied from interface: Batch
    
    Draws a rectangle with the bottom left corner at x,y having the width and height of the texture.
    
    Specified by:
    
    draw in interface Batch
    
    x - the x-coordinate in screen space
    
    y - the y-coordinate in screen space
  - draw
```
public void draw(Texture texture,
                 float x,
                 float y,
                 float width,
                 float height)
```
    Description copied from interface: Batch
    
    Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
    
    Specified by:
    
    draw in interface Batch
  - draw
```
public void draw(Texture texture,
                 float[] spriteVertices,
                 int offset,
                 int count)
```
    Description copied from interface: Batch
    
    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 Batch.getColor() from the Batch is not applied.
    
    Specified by:
    
    draw in interface Batch
  - draw
```
public void draw(TextureRegion region,
                 float x,
                 float y)
```
    Description copied from interface: Batch
    
    Draws a rectangle with the bottom left corner at x,y having the width and height of the region.
    
    Specified by:
    
    draw in interface Batch
  - draw
```
public void draw(TextureRegion region,
                 float x,
                 float y,
                 float width,
                 float height)
```
    Description copied from interface: Batch
    
    Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
    
    Specified by:
    
    draw in interface Batch
  - draw
```
public void draw(TextureRegion region,
                 float x,
                 float y,
                 float originX,
                 float originY,
                 float width,
                 float height,
                 float scaleX,
                 float scaleY,
                 float rotation)
```
    Description copied from interface: Batch
    
    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.
    
    Specified by:
    
    draw in interface Batch
  - draw
```
public void draw(TextureRegion region,
                 float x,
                 float y,
                 float originX,
                 float originY,
                 float width,
                 float height,
                 float scaleX,
                 float scaleY,
                 float rotation,
                 boolean clockwise)
```
    Description copied from interface: Batch
    
    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.
    
    Specified by:
    
    draw in interface Batch
    
    clockwise - If true, the texture coordinates are rotated 90 degrees clockwise. If false, they are rotated 90 degrees counter clockwise.
  - draw
```
public void draw(TextureRegion region,
                 float width,
                 float height,
                 Affine2 transform)
```
    Description copied from interface: Batch
    
    Draws a rectangle transformed by the given matrix.
    
    Specified by:
    
    draw in interface Batch
  - flush
```
public void flush()
```
    Description copied from interface: Batch
    
    Causes any pending sprites to be rendered, without ending the Batch.
    
    Specified by:
    
    flush in interface Batch
  - disableBlending
```
public void disableBlending()
```
    Description copied from interface: Batch
    
    Disables blending for drawing sprites. Calling this within Batch.begin()/Batch.end() will flush the batch.
    
    Specified by:
    
    disableBlending in interface Batch
  - enableBlending
```
public void enableBlending()
```
    Description copied from interface: Batch
    
    Enables blending for drawing sprites. Calling this within Batch.begin()/Batch.end() will flush the batch.
    
    Specified by:
    
    enableBlending in interface Batch
  - setBlendFunction
```
public void setBlendFunction(int srcFunc,
                             int dstFunc)
```
    Description copied from interface: Batch
    
    Sets the blending function to be used when rendering sprites.
    
    Specified by:
    
    setBlendFunction in interface Batch
    
    Parameters:
    
    srcFunc - the source function, e.g. GL20.GL_SRC_ALPHA. If set to -1, Batch won't change the blending function.
    
    dstFunc - the destination function, e.g. GL20.GL_ONE_MINUS_SRC_ALPHA
  - setBlendFunctionSeparate
```
public void setBlendFunctionSeparate(int srcFuncColor,
                                     int dstFuncColor,
                                     int srcFuncAlpha,
                                     int dstFuncAlpha)
```
    Description copied from interface: Batch
    
    Sets separate (color/alpha) blending function to be used when rendering sprites.
    
    Specified by:
    
    setBlendFunctionSeparate in interface Batch
    
    Parameters:
    
    srcFuncColor - the source color function, e.g. GL20.GL_SRC_ALPHA. If set to -1, Batch won't change the blending function.
    
    dstFuncColor - the destination color function, e.g. GL20.GL_ONE_MINUS_SRC_ALPHA.
    
    srcFuncAlpha - the source alpha function, e.g. GL20.GL_SRC_ALPHA.
    
    dstFuncAlpha - the destination alpha function, e.g. GL20.GL_ONE_MINUS_SRC_ALPHA.
  - getBlendSrcFunc
```
public int getBlendSrcFunc()
```
    Specified by:
    
    getBlendSrcFunc in interface Batch
  - getBlendDstFunc
```
public int getBlendDstFunc()
```
    Specified by:
    
    getBlendDstFunc in interface Batch
  - getBlendSrcFuncAlpha
```
public int getBlendSrcFuncAlpha()
```
    Specified by:
    
    getBlendSrcFuncAlpha in interface Batch
  - getBlendDstFuncAlpha
```
public int getBlendDstFuncAlpha()
```
    Specified by:
    
    getBlendDstFuncAlpha in interface Batch
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Releases all resources of this object.
    
    Specified by:
    
    dispose in interface Disposable
  - getProjectionMatrix
```
public Matrix4 getProjectionMatrix()
```
    Description copied from interface: Batch
    
    Returns the current projection matrix. Changing this within Batch.begin()/Batch.end() results in undefined behaviour.
    
    Specified by:
    
    getProjectionMatrix in interface Batch
  - getTransformMatrix
```
public Matrix4 getTransformMatrix()
```
    Description copied from interface: Batch
    
    Returns the current transform matrix. Changing this within Batch.begin()/Batch.end() results in undefined behaviour.
    
    Specified by:
    
    getTransformMatrix in interface Batch
  - setProjectionMatrix
```
public void setProjectionMatrix(Matrix4 projection)
```
    Description copied from interface: Batch
    
    Sets the projection matrix to be used by this Batch. If this is called inside a Batch.begin()/Batch.end() block, the current batch is flushed to the gpu.
    
    Specified by:
    
    setProjectionMatrix in interface Batch
  - setTransformMatrix
```
public void setTransformMatrix(Matrix4 transform)
```
    Description copied from interface: Batch
    
    Sets the transform matrix to be used by this Batch.
    
    Specified by:
    
    setTransformMatrix in interface Batch
  - setupMatrices
```
protected void setupMatrices()
```
  - switchTexture
```
protected void switchTexture(Texture texture)
```
  - setShader
```
public void setShader(ShaderProgram shader)
```
    Description copied from interface: Batch
    
    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 Batch.begin() and Batch.end().
    
    Specified by:
    
    setShader in interface Batch
    
    Parameters:
    
    shader - the ShaderProgram or null to use the default shader.
  - getShader
```
public ShaderProgram getShader()
```
    Specified by:
    
    getShader in interface Batch
    
    Returns:
    
    the current ShaderProgram set by Batch.setShader(ShaderProgram) or the defaultShader
  - isBlendingEnabled
```
public boolean isBlendingEnabled()
```
    Specified by:
    
    isBlendingEnabled in interface Batch
    
    Returns:
    
    true if blending for sprites is enabled
  - isDrawing
```
public boolean isDrawing()
```
    Specified by:
    
    isDrawing in interface Batch
    
    Returns:
    
    true if currently between begin and end.

Class SpriteBatch

Field Summary

Fields inherited from interface com.badlogic.gdx.graphics.g2d.Batch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultVertexDataType

renderCalls

totalRenderCalls

maxSpritesInBatch

Constructor Detail

SpriteBatch

SpriteBatch

SpriteBatch

Method Detail

createDefaultShader

begin

end

setColor

setColor

getColor

setPackedColor

getPackedColor

draw

draw

draw

draw

draw

draw

draw

draw

draw

draw

draw

draw

flush

disableBlending

enableBlending

setBlendFunction

setBlendFunctionSeparate

getBlendSrcFunc

getBlendDstFunc

getBlendSrcFuncAlpha

getBlendDstFuncAlpha

dispose

getProjectionMatrix

getTransformMatrix

setProjectionMatrix

setTransformMatrix

setupMatrices

switchTexture

setShader

getShader

isBlendingEnabled

isDrawing