com.badlogic.gdx.graphics.glutils

Class GLFrameBuffer<T extends GLTexture>

java.lang.Object

com.badlogic.gdx.graphics.glutils.GLFrameBuffer<T>

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

FrameBuffer, FrameBufferCubemap

public abstract class GLFrameBuffer<T extends GLTexture>
extends Object
implements Disposable

Encapsulates OpenGL ES 2.0 frame buffer objects. This is a simple helper class which should cover most FBO uses. It will automatically create a gltexture for the color attachment and a renderbuffer for the depth buffer. You can get a hold of the gltexture by getColorBufferTexture(). This class will only work with OpenGL ES 2.0.

FrameBuffers are managed. In case of an OpenGL context loss, which only happens on Android when a user switches to another application or receives an incoming call, the framebuffer will be automatically recreated.

A FrameBuffer must be disposed if it is no longer needed

Author:

mzechner, realitix

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GLFrameBuffer.FloatFrameBufferBuilder
static class	GLFrameBuffer.FrameBufferBuilder
static class	GLFrameBuffer.FrameBufferCubemapBuilder
static class	GLFrameBuffer.GLFrameBufferBuilder<U extends GLFrameBuffer<? extends GLTexture>>

Method Summary

Modifier and Type	Method and Description
void	begin() Binds the frame buffer and sets the viewport accordingly, so everything gets drawn to it.
void	bind() Makes the frame buffer current so everything gets drawn to it.
static void	clearAllFrameBuffers(Application app)
void	dispose() Releases all resources associated with the FrameBuffer.
void	end() Unbinds the framebuffer, all drawing will be performed to the normal framebuffer from here on.
void	end(int x, int y, int width, int height) Unbinds the framebuffer and sets viewport sizes, all drawing will be performed to the normal framebuffer from here on.
T	getColorBufferTexture() Convenience method to return the first Texture attachment present in the fbo
int	getDepthBufferHandle()
int	getFramebufferHandle()
int	getHeight()
static String	getManagedStatus()
static StringBuilder	getManagedStatus(StringBuilder builder)
int	getStencilBufferHandle()
Array<T>	getTextureAttachments() Return the Texture attachments attached to the fbo
int	getWidth()
static void	invalidateAllFrameBuffers(Application app) Invalidates all frame buffers.
static void	unbind() Unbinds the framebuffer, all drawing will be performed to the normal framebuffer from here on.

Methods inherited from class java.lang.Object

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

Method Detail

getColorBufferTexture

public T getColorBufferTexture()

Convenience method to return the first Texture attachment present in the fbo

getTextureAttachments

public Array<T> getTextureAttachments()

Return the Texture attachments attached to the fbo

dispose

public void dispose()

Releases all resources associated with the FrameBuffer.

Specified by:

dispose in interface Disposable

bind

public void bind()

Makes the frame buffer current so everything gets drawn to it.

unbind

public static void unbind()

Unbinds the framebuffer, all drawing will be performed to the normal framebuffer from here on.

begin

public void begin()

Binds the frame buffer and sets the viewport accordingly, so everything gets drawn to it.

end

public void end()

Unbinds the framebuffer, all drawing will be performed to the normal framebuffer from here on.

end

public void end(int x,
                int y,
                int width,
                int height)

Unbinds the framebuffer and sets viewport sizes, all drawing will be performed to the normal framebuffer from here on.

Parameters:

x - the x-axis position of the viewport in pixels

y - the y-asis position of the viewport in pixels

width - the width of the viewport in pixels

height - the height of the viewport in pixels

getFramebufferHandle

public int getFramebufferHandle()

Returns:

The OpenGL handle of the framebuffer (see GL20.glGenFramebuffer())

getDepthBufferHandle

public int getDepthBufferHandle()

Returns:

The OpenGL handle of the (optional) depth buffer (see GL20.glGenRenderbuffer()). May return 0 even if depth buffer enabled

getStencilBufferHandle

public int getStencilBufferHandle()

Returns:

The OpenGL handle of the (optional) stencil buffer (see GL20.glGenRenderbuffer()). May return 0 even if stencil buffer enabled

getHeight

public int getHeight()

Returns:

the height of the framebuffer in pixels

getWidth

public int getWidth()

Returns:

the width of the framebuffer in pixels

invalidateAllFrameBuffers

public static void invalidateAllFrameBuffers(Application app)

Invalidates all frame buffers. This can be used when the OpenGL context is lost to rebuild all managed frame buffers. This assumes that the texture attached to this buffer has already been rebuild! Use with care.

clearAllFrameBuffers

public static void clearAllFrameBuffers(Application app)

getManagedStatus

public static StringBuilder getManagedStatus(StringBuilder builder)

getManagedStatus

public static String getManagedStatus()