playn.core

Class UniformQuadBatch

java.lang.Object

playn.core.GLBatch

playn.core.TexturedBatch

playn.core.QuadBatch

playn.core.UniformQuadBatch

All Implemented Interfaces:

java.lang.AutoCloseable, Closeable

public class UniformQuadBatch
extends QuadBatch

A batch which renders quads by stuffing them into a big(ish) GLSL uniform variable. Turns out to work pretty well for 2D rendering as we rarely render more than a modest number of quads before flushing the shader and it allows us to avoid sending a lot of duplicated data as is necessary when rendering quads via a batch of triangles.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UniformQuadBatch.Source The source for the stock quad batch shader program.

Nested classes/interfaces inherited from interface react.Closeable

Closeable.Set, Closeable.Util

Field Summary

Fields inherited from class playn.core.TexturedBatch

gl

Constructor Summary

Constructors

Constructor and Description
UniformQuadBatch(GL20 gl) Creates a uniform quad batch with the default shader programs.
UniformQuadBatch(GL20 gl, UniformQuadBatch.Source source) Creates a uniform quad batch with the supplied custom shader program builder.

Method Summary

Modifier and Type	Method and Description
void	addQuad(int tint, float m00, float m01, float m10, float m11, float tx, float ty, float x1, float y1, float sx1, float sy1, float x2, float y2, float sx2, float sy2, float x3, float y3, float sx3, float sy3, float x4, float y4, float sx4, float sy4) Adds a transformed axis-aligned quad to this batch.
void	begin(float fbufWidth, float fbufHeight, boolean flip) Must be called before this batch is used to accumulate and send drawing commands.
void	close() Releases any GPU resources retained by this batch.
void	end() Must be called when one is done using this batch to accumulate and send drawing commands.
void	flush() Sends any accumulated drawing calls to the GPU.
static boolean	isLikelyToPerform(GL20 gl) Returns false if the GL context doesn't support sufficient numbers of vertex uniform vectors to allow this shader to run with good performance, true otherwise.
java.lang.String	toString()

Methods inherited from class playn.core.QuadBatch

addQuad, addQuad, addQuad, addQuad

Methods inherited from class playn.core.TexturedBatch

setTexture

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UniformQuadBatch

public UniformQuadBatch(GL20 gl)

Creates a uniform quad batch with the default shader programs.

UniformQuadBatch

public UniformQuadBatch(GL20 gl,
                        UniformQuadBatch.Source source)

Creates a uniform quad batch with the supplied custom shader program builder.

Method Detail

isLikelyToPerform

public static boolean isLikelyToPerform(GL20 gl)

Returns false if the GL context doesn't support sufficient numbers of vertex uniform vectors to allow this shader to run with good performance, true otherwise.

addQuad

public void addQuad(int tint,
                    float m00,
                    float m01,
                    float m10,
                    float m11,
                    float tx,
                    float ty,
                    float x1,
                    float y1,
                    float sx1,
                    float sy1,
                    float x2,
                    float y2,
                    float sx2,
                    float sy2,
                    float x3,
                    float y3,
                    float sx3,
                    float sy3,
                    float x4,
                    float y4,
                    float sx4,
                    float sy4)

Description copied from class: QuadBatch

Adds a transformed axis-aligned quad to this batch. m00, m01, m10, m11, tx, ty define the affine transform applied to the quad. x1, y1, .., x4, y4 define the corners of the quad. sx1, sy1, .., sx4, sy4 define the texture coordinate of the quad.

Specified by:

addQuad in class QuadBatch

begin

public void begin(float fbufWidth,
                  float fbufHeight,
                  boolean flip)

Description copied from class: GLBatch

Must be called before this batch is used to accumulate and send drawing commands.

Overrides:

begin in class GLBatch

flip - whether or not to flip the y-axis. This is generally true when rendering to the default frame buffer (the screen), and false when rendering to textures.

flush

public void flush()

Description copied from class: GLBatch

Sends any accumulated drawing calls to the GPU. Depending on the nature of the batch, this may be necessary before certain state changes (like switching to a new texture). This should be a NOOP if there's nothing to flush.

Overrides:

flush in class GLBatch

end

public void end()

Description copied from class: GLBatch

Must be called when one is done using this batch to accumulate and send drawing commands. The default implementation calls GLBatch.flush() and marks this batch as inactive.

Overrides:

end in class TexturedBatch

close

public void close()

Description copied from class: GLBatch

Releases any GPU resources retained by this batch. This should be called when the batch will never again be used.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class GLBatch

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object