To draw something with a PolygonSpriteBatch one has to first call the PolygonSpriteBatch#begin() method which will
setup appropriate render states. When you are done with drawing you have to call PolygonSpriteBatch#end() which will
actually draw the things you specified.
All drawing commands of the PolygonSpriteBatch 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 PolygonSpriteBatch is managed. In case the OpenGL context is lost all OpenGL resources a PolygonSpriteBatch uses internally get invalidated. A context is lost when a user switches to another application or receives an incoming call on Android. A SpritPolygonSpriteBatcheBatch will be automatically reloaded after the OpenGL context is restored.
A PolygonSpriteBatch is a pretty heavy object so you should only ever have one in your program.
A PolygonSpriteBatch 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 PolygonSpriteBatch has to be disposed if it is no longer used.
| Modifier and Type | Field and Description |
|---|---|
| private int | |
| private int | |
| private boolean | |
| private int | |
| private int | |
| private final Color | |
| pack-priv float | |
| private final Matrix4 | |
| private ShaderProgram | |
| private boolean | |
| private float | |
| private float | |
| private Texture | |
| public int | maxTrianglesInBatch
The maximum number of triangles rendered in one batch so far. |
| private Mesh | |
| private boolean | |
| private final Matrix4 | |
| public int | renderCalls
Number of render calls since the last |
| private final ShaderProgram | |
| public int | totalRenderCalls
Number of rendering calls, ever. |
| private final Matrix4 | |
| private int | |
| private final short[] | |
| private int | |
| private final float[] |
| Access | Constructor and Description |
|---|---|
| public | PolygonSpriteBatch()
Constructs a PolygonSpriteBatch with the default shader, 2000 vertices, and 4000 triangles. |
| public | PolygonSpriteBatch(int
The max number of vertices and number of triangles in a single batch. Max of 32767. size)Constructs a PolygonSpriteBatch with the default shader, size vertices, and size * 2 triangles. |
| public | PolygonSpriteBatch(int
The max number of vertices and number of triangles in a single batch. Max of 32767. size, ShaderProgram defaultShader)Constructs a PolygonSpriteBatch with the specified shader, size vertices and size * 2 triangles. |
| public | PolygonSpriteBatch(int
The max number of vertices in a single batch. Max of 32767. maxVertices, int The max number of triangles in a single batch. maxTriangles, ShaderProgram The default shader to use. This is not owned by the PolygonSpriteBatch and must be disposed separately.
May be null to use the default shader. defaultShader)Constructs a new PolygonSpriteBatch. |
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| public void | disableBlending()
Implements com. Disables blending for drawing sprites. |
| public void | dispose()
Implements com. Releases all resources of this object. |
| public void | draw(PolygonRegion region, float x, float y)
Implements com. Draws a polygon region with the bottom left corner at x,y having the width and height of the region. |
| public void | draw(PolygonRegion region, float x, float y, float width, float height)
Implements com. Draws a polygon region with the bottom left corner at x,y and stretching the region to cover the given width and height. |
| public void | draw(PolygonRegion region, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation)
Implements com. Draws the polygon region with the bottom left corner at x,y and stretching the region to cover the given width and height. |
| public void | draw(Texture texture, float[] polygonVertices, int verticesOffset, int verticesCount, short[] polygonTriangles, int trianglesOffset, int trianglesCount)
Implements com. Draws the polygon using the given vertices and triangles. |
| 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)
Implements com. Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. |
| 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)
Implements com. Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. |
| public void | draw(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight)
Implements com. Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. |
| public void | draw(Texture texture, float x, float y, float width, float height, float u, float v, float u2, float v2)
Implements com. Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. |
| public void | draw(Texture texture, float x, float y)
Implements com. Draws a rectangle with the bottom left corner at x,y having the width and height of the texture. |
| public void | draw(Texture texture, float x, float y, float width, float height)
Implements com. Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height. |
| public void | draw(Texture texture, float[] spriteVertices, int offset, int count)
Implements com. Draws a rectangle using the given vertices. |
| public void | draw(TextureRegion region, float x, float y)
Implements com. Draws a rectangle with the bottom left corner at x,y having the width and height of the region. |
| public void | draw(TextureRegion region, float x, float y, float width, float height)
Implements com. Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height. |
| public void | draw(TextureRegion region, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation)
Implements com. Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height. |
| 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)
Implements com. Draws a rectangle with the texture coordinates rotated 90 degrees. |
| public void | draw(TextureRegion region, float width, float height, Affine2 transform)
Implements com. Draws a rectangle transformed by the given matrix. |
| public void | enableBlending()
Implements com. Enables blending for drawing sprites. |
| public void | |
| public void | flush()
Implements com. Causes any pending sprites to be rendered, without ending the Batch. |
| public int | |
| public int | |
| public int | |
| public int | |
| public Color | |
| public float | |
| public Matrix4 | getProjectionMatrix()
Implements com. Returns the current projection matrix. |
| public ShaderProgram | |
| public Matrix4 | getTransformMatrix()
Implements com. Returns the current transform matrix. |
| public boolean | |
| public boolean | |
| public void | setBlendFunction(int srcFunc, int dstFunc)
Implements com. Sets the blending function to be used when rendering sprites. |
| public void | setBlendFunctionSeparate(int srcFuncColor, int dstFuncColor, int srcFuncAlpha, int dstFuncAlpha)
Implements com. Sets separate (color/alpha) blending function to be used when rendering sprites. |
| public void | setColor(Color tint)
Implements com. Sets the color used to tint images when they are added to the Batch. |
| public void | setColor(float r, float g, float b, float a)
Implements com.
|
| public void | setPackedColor(float packedColor)
Implements com. Sets the rendering color of this Batch, expanding the alpha from 0-254 to 0-255. |
| public void | setProjectionMatrix(Matrix4 projection)
Implements com. Sets the projection matrix to be used by this Batch. |
| public void | setShader(ShaderProgram shader)
Implements com. Sets the shader to be used in a GLES 2.0 environment. |
| public void | setTransformMatrix(Matrix4 transform)
Implements com. Sets the transform matrix to be used by this Batch. |
| protected void | |
| protected void |
| blendDstFunc | back to summary |
|---|---|
| private int blendDstFunc | |
| blendDstFuncAlpha | back to summary |
|---|---|
| private int blendDstFuncAlpha | |
| blendingDisabled | back to summary |
|---|---|
| private boolean blendingDisabled | |
| blendSrcFunc | back to summary |
|---|---|
| private int blendSrcFunc | |
| blendSrcFuncAlpha | back to summary |
|---|---|
| private int blendSrcFuncAlpha | |
| color | back to summary |
|---|---|
| private final Color color | |
| colorPacked | back to summary |
|---|---|
| pack-priv float colorPacked | |
| combinedMatrix | back to summary |
|---|---|
| private final Matrix4 combinedMatrix | |
| customShader | back to summary |
|---|---|
| private ShaderProgram customShader | |
| drawing | back to summary |
|---|---|
| private boolean drawing | |
| invTexHeight | back to summary |
|---|---|
| private float invTexHeight | |
| invTexWidth | back to summary |
|---|---|
| private float invTexWidth | |
| lastTexture | back to summary |
|---|---|
| private Texture lastTexture | |
| maxTrianglesInBatch | back to summary |
|---|---|
| public int maxTrianglesInBatch The maximum number of triangles rendered in one batch so far. | |
| mesh | back to summary |
|---|---|
| private Mesh mesh | |
| ownsShader | back to summary |
|---|---|
| private boolean ownsShader | |
| projectionMatrix | back to summary |
|---|---|
| private final Matrix4 projectionMatrix | |
| renderCalls | back to summary |
|---|---|
| public int renderCalls Number of render calls since the last | |
| shader | back to summary |
|---|---|
| private final ShaderProgram shader | |
| totalRenderCalls | back to summary |
|---|---|
| public int totalRenderCalls Number of rendering calls, ever. Will not be reset unless set manually. | |
| transformMatrix | back to summary |
|---|---|
| private final Matrix4 transformMatrix | |
| triangleIndex | back to summary |
|---|---|
| private int triangleIndex | |
| triangles | back to summary |
|---|---|
| private final short[] triangles | |
| vertexIndex | back to summary |
|---|---|
| private int vertexIndex | |
| vertices | back to summary |
|---|---|
| private final float[] vertices | |
| PolygonSpriteBatch | back to summary |
|---|---|
| public PolygonSpriteBatch() Constructs a PolygonSpriteBatch with the default shader, 2000 vertices, and 4000 triangles. | |
| PolygonSpriteBatch | back to summary |
|---|---|
| public PolygonSpriteBatch(int size) Constructs a PolygonSpriteBatch with the default shader, size vertices, and size * 2 triangles.
| |
| PolygonSpriteBatch | back to summary |
|---|---|
| public PolygonSpriteBatch(int size, ShaderProgram defaultShader) Constructs a PolygonSpriteBatch with the specified shader, size vertices and size * 2 triangles.
| |
| PolygonSpriteBatch | back to summary |
|---|---|
| public PolygonSpriteBatch(int maxVertices, int maxTriangles, ShaderProgram defaultShader) Constructs a new PolygonSpriteBatch. 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
| |
| begin | back to summary |
|---|---|
| public void begin() Implements com. Doc from com. 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
| |
| disableBlending | back to summary |
|---|---|
| public void disableBlending() Implements com. Doc from com. Disables blending for drawing sprites. Calling this within
| |
| dispose | back to summary |
|---|---|
| public void dispose() Implements com. Doc from com. Releases all resources of this object.
| |
| draw | back to summary |
|---|---|
| public void draw(PolygonRegion region, float x, float y) Implements com. Doc from com. Draws a polygon region with the bottom left corner at x,y having the width and height of the region.
| |
| draw | back to summary |
|---|---|
| public void draw(PolygonRegion region, float x, float y, float width, float height) Implements com. Doc from com. Draws a polygon region with the bottom left corner at x,y and stretching the region to cover the given width and height.
| |
| draw | back to summary |
|---|---|
| public void draw(PolygonRegion region, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation) Implements com. Doc from com. Draws the polygon region with the bottom left corner at x,y and stretching the region to cover the given width and height. The polygon region is offset by originX, originY relative to the origin. Scale specifies the scaling factor by which the polygon region should be scaled around originX, originY. Rotation specifies the angle of counter clockwise rotation of the rectangle around originX, originY.
| |
| draw | back to summary |
|---|---|
| public void draw(Texture texture, float[] polygonVertices, int verticesOffset, int verticesCount, short[] polygonTriangles, int trianglesOffset, int trianglesCount) Implements com. Doc from com. Draws the polygon using the given vertices and triangles. Each vertices must be made up of 5 elements in this order: x, y, color, u, v.
| |
| draw | back to summary |
|---|---|
| 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) Implements com. Doc from com. 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
| |
| draw | back to summary |
|---|---|
| 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) Implements com. Doc from com. Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. The portion of the
| |
| draw | back to summary |
|---|---|
| public void draw(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight) Implements com. Doc from com. Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. The portion of the
| |
| draw | back to summary |
|---|---|
| public void draw(Texture texture, float x, float y, float width, float height, float u, float v, float u2, float v2) Implements com. Doc from com. Draws a rectangle with the bottom left corner at x,y having the given width and height in pixels. The portion of the
| |
| draw | back to summary |
|---|---|
| public void draw(Texture texture, float x, float y) Implements com. Doc from com. Draws a rectangle with the bottom left corner at x,y having the width and height of the texture.
| |
| draw | back to summary |
|---|---|
| public void draw(Texture texture, float x, float y, float width, float height) Implements com. Doc from com. Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
| |
| draw | back to summary |
|---|---|
| public void draw(Texture texture, float[] spriteVertices, int offset, int count) Implements com. Doc from com. 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
| |
| draw | back to summary |
|---|---|
| public void draw(TextureRegion region, float x, float y) Implements com. Doc from com. Draws a rectangle with the bottom left corner at x,y having the width and height of the region.
| |
| draw | back to summary |
|---|---|
| public void draw(TextureRegion region, float x, float y, float width, float height) Implements com. Doc from com. Draws a rectangle with the bottom left corner at x,y and stretching the region to cover the given width and height.
| |
| draw | back to summary |
|---|---|
| public void draw(TextureRegion region, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation) Implements com. Doc from com. 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 | back to summary |
|---|---|
| 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) Implements com. Doc from com. 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.
| |
| draw | back to summary |
|---|---|
| public void draw(TextureRegion region, float width, float height, Affine2 transform) Implements com. Doc from com. Draws a rectangle transformed by the given matrix.
| |
| enableBlending | back to summary |
|---|---|
| public void enableBlending() Implements com. Doc from com. Enables blending for drawing sprites. Calling this within
| |
| end | back to summary |
|---|---|
| public void end() Implements com. Doc from com. Finishes off rendering. Enables depth writes, disables blending and texturing. Must always be called after a call to
| |
| flush | back to summary |
|---|---|
| public void flush() Implements com. Doc from com. Causes any pending sprites to be rendered, without ending the Batch.
| |
| getBlendDstFunc | back to summary |
|---|---|
| public int getBlendDstFunc() Implements com.
| |
| getBlendDstFuncAlpha | back to summary |
|---|---|
| public int getBlendDstFuncAlpha() Implements com.
| |
| getBlendSrcFunc | back to summary |
|---|---|
| public int getBlendSrcFunc() Implements com.
| |
| getBlendSrcFuncAlpha | back to summary |
|---|---|
| public int getBlendSrcFuncAlpha() Implements com.
| |
| getColor | back to summary |
|---|---|
| public Color getColor() Implements com.
| |
| getPackedColor | back to summary |
|---|---|
| public float getPackedColor() Implements com.
| |
| getProjectionMatrix | back to summary |
|---|---|
| public Matrix4 getProjectionMatrix() Implements com. Doc from com. Returns the current projection matrix. Changing this within
| |
| getShader | back to summary |
|---|---|
| public ShaderProgram getShader() Implements com.
| |
| getTransformMatrix | back to summary |
|---|---|
| public Matrix4 getTransformMatrix() Implements com. Doc from com. Returns the current transform matrix. Changing this within
| |
| isBlendingEnabled | back to summary |
|---|---|
| public boolean isBlendingEnabled() Implements com.
| |
| isDrawing | back to summary |
|---|---|
| public boolean isDrawing() Implements com.
| |
| setBlendFunction | back to summary |
|---|---|
| public void setBlendFunction(int srcFunc, int dstFunc) Implements com. Doc from com. Sets the blending function to be used when rendering sprites.
| |
| setBlendFunctionSeparate | back to summary |
|---|---|
| public void setBlendFunctionSeparate(int srcFuncColor, int dstFuncColor, int srcFuncAlpha, int dstFuncAlpha) Implements com. Doc from com. Sets separate (color/alpha) blending function to be used when rendering sprites.
| |
| setColor | back to summary |
|---|---|
| public void setColor(Color tint) Implements com. Doc from com. Sets the color used to tint images when they are added to the Batch. Default is
| |
| setColor | back to summary |
|---|---|
| public void setColor(float r, float g, float b, float a) Implements com.
| |
| setPackedColor | back to summary |
|---|---|
| public void setPackedColor(float packedColor) Implements com. Doc from com. Sets the rendering color of this Batch, expanding the alpha from 0-254 to 0-255.
| |
| setProjectionMatrix | back to summary |
|---|---|
| public void setProjectionMatrix(Matrix4 projection) Implements com. Doc from com. Sets the projection matrix to be used by this Batch. If this is called inside a
| |
| setShader | back to summary |
|---|---|
| public void setShader(ShaderProgram shader) Implements com. Doc from com. 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
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
| |
| setTransformMatrix | back to summary |
|---|---|
| public void setTransformMatrix(Matrix4 transform) Implements com. Doc from com. Sets the transform matrix to be used by this Batch.
| |
| setupMatrices | back to summary |
|---|---|
| protected void setupMatrices() | |
| switchTexture | back to summary |
|---|---|
| protected void switchTexture(Texture texture) | |
