com.badlogic.gdx.graphics.glutils

Class FrameBuffer

java.lang.Object

com.badlogic.gdx.graphics.glutils.FrameBuffer

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

FloatFrameBuffer

public class FrameBuffer
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 texture for the color attachment and a renderbuffer for the depth buffer. You can get a hold of the texture 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

Constructor Summary

Constructors

Constructor and Description
FrameBuffer(Pixmap.Format format, int width, int height, boolean hasDepth) Creates a new FrameBuffer having the given dimensions and potentially a depth buffer attached.
FrameBuffer(Pixmap.Format format, int width, int height, boolean hasDepth, boolean hasStencil) Creates a new FrameBuffer having the given dimensions and potentially a depth and a stencil buffer attached.

Method Summary

Methods

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.
Texture	getColorBufferTexture()
int	getHeight()
static String	getManagedStatus()
static StringBuilder	getManagedStatus(StringBuilder builder)
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

Constructor Detail

FrameBuffer

public FrameBuffer(Pixmap.Format format,
           int width,
           int height,
           boolean hasDepth)

Creates a new FrameBuffer having the given dimensions and potentially a depth buffer attached.

Parameters:

format -

width -

height -

hasDepth -

FrameBuffer

public FrameBuffer(Pixmap.Format format,
           int width,
           int height,
           boolean hasDepth,
           boolean hasStencil)

Creates a new FrameBuffer having the given dimensions and potentially a depth and a stencil buffer attached.

Parameters:

format - the format of the color buffer; according to the OpenGL ES 2.0 spec, only RGB565, RGBA4444 and RGB5_A1 are color-renderable

width - the width of the framebuffer in pixels

height - the height of the framebuffer in pixels

hasDepth - whether to attach a depth buffer

Throws:

GdxRuntimeException - in case the FrameBuffer could not be created

Method Detail

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

getColorBufferTexture

public Texture getColorBufferTexture()

Returns:

the color buffer texture

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()