de.bitbrain.braingdx.graphics.postprocessing.utils

Class PingPongBuffer

java.lang.Object

de.bitbrain.braingdx.graphics.postprocessing.utils.PingPongBuffer

public final class PingPongBuffer
extends Object

Encapsulates a framebuffer with the ability to ping-pong between two buffers.

Upon begin() the buffer is reset to a known initial state, this is usually done just before the first usage of the buffer.

Subsequent capture() calls will initiate writing to the next available buffer, returning the previously used one, effectively ping-ponging between the two. Until end() is called, chained rendering will be possible by retrieving the necessary buffers via #getSourceTexture(), getSourceBuffer(), getResultTexture() or getResultBuffer().

When finished, end() should be called to stop capturing. When the OpenGL context is lost, rebind() should be called.

Author:

bmanuel

Field Summary

Fields

Modifier and Type	Field and Description
com.badlogic.gdx.graphics.glutils.FrameBuffer	buffer1
com.badlogic.gdx.graphics.glutils.FrameBuffer	buffer2
int	height
boolean	ownResources
com.badlogic.gdx.graphics.Texture	texture1
com.badlogic.gdx.graphics.Texture	texture2
int	width

Constructor Summary

Constructors

Constructor and Description
PingPongBuffer(com.badlogic.gdx.graphics.glutils.FrameBuffer buffer1, com.badlogic.gdx.graphics.glutils.FrameBuffer buffer2) Creates a new ping-pong buffer with the given buffers.
PingPongBuffer(int width, int height, com.badlogic.gdx.graphics.Pixmap.Format frameBufferFormat, boolean hasDepth) Creates a new ping-pong buffer and owns the resources.

Method Summary

Methods

Modifier and Type	Method and Description
void	begin() Ensures the initial buffer state is always the same before starting ping-ponging.
com.badlogic.gdx.graphics.Texture	capture() Starts and/or continue ping-ponging, begin capturing on the next available buffer, returns the result of the previous capture() call.
void	dispose() Free the resources, if any.
void	end() Finishes ping-ponging, must always be called after a call to capture()
com.badlogic.gdx.graphics.glutils.FrameBuffer	getResultBuffer()
com.badlogic.gdx.graphics.Texture	getResultTexture()
com.badlogic.gdx.graphics.Texture	getSouceTexture()
com.badlogic.gdx.graphics.glutils.FrameBuffer	getSourceBuffer()
void	rebind() When needed graphics memory could be invalidated so buffers should be rebuilt.
void	reset() Restore the previous buffers if the instance was owning resources.
void	set(com.badlogic.gdx.graphics.glutils.FrameBuffer buffer1, com.badlogic.gdx.graphics.glutils.FrameBuffer buffer2) An instance of this object can also be used to manipulate some other externally-allocated buffers, applying just the same ping-ponging behavior.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ownResources

public final boolean ownResources

buffer1

public com.badlogic.gdx.graphics.glutils.FrameBuffer buffer1

buffer2

public com.badlogic.gdx.graphics.glutils.FrameBuffer buffer2

texture1

public com.badlogic.gdx.graphics.Texture texture1

texture2

public com.badlogic.gdx.graphics.Texture texture2

width

public int width

height

public int height

Constructor Detail

PingPongBuffer

public PingPongBuffer(int width,
              int height,
              com.badlogic.gdx.graphics.Pixmap.Format frameBufferFormat,
              boolean hasDepth)

Creates a new ping-pong buffer and owns the resources.

PingPongBuffer

public PingPongBuffer(com.badlogic.gdx.graphics.glutils.FrameBuffer buffer1,
              com.badlogic.gdx.graphics.glutils.FrameBuffer buffer2)

Creates a new ping-pong buffer with the given buffers.

Method Detail

set

public void set(com.badlogic.gdx.graphics.glutils.FrameBuffer buffer1,
       com.badlogic.gdx.graphics.glutils.FrameBuffer buffer2)

An instance of this object can also be used to manipulate some other externally-allocated buffers, applying just the same ping-ponging behavior.

If this instance of the object was owning the resources, they will be preserved and will be restored by a reset() call.

Parameters:

buffer1 - the first buffer

buffer2 - the second buffer

reset

public void reset()

Restore the previous buffers if the instance was owning resources.

dispose

public void dispose()

Free the resources, if any.

rebind

public void rebind()

When needed graphics memory could be invalidated so buffers should be rebuilt.

begin

public void begin()

Ensures the initial buffer state is always the same before starting ping-ponging.

capture

public com.badlogic.gdx.graphics.Texture capture()

Starts and/or continue ping-ponging, begin capturing on the next available buffer, returns the result of the previous capture() call.

Returns:

the Texture containing the result.

end

public void end()

Finishes ping-ponging, must always be called after a call to capture()

getSouceTexture

public com.badlogic.gdx.graphics.Texture getSouceTexture()

Returns:

the source texture of the current ping-pong chain.

getSourceBuffer

public com.badlogic.gdx.graphics.glutils.FrameBuffer getSourceBuffer()

Returns:

the source buffer of the current ping-pong chain.

getResultTexture

public com.badlogic.gdx.graphics.Texture getResultTexture()

Returns:

the result's texture of the latest capture().

getResultBuffer

public com.badlogic.gdx.graphics.glutils.FrameBuffer getResultBuffer()

Returns:

Returns the result's buffer of the latest capture().