com.badlogic.gdx.graphics.glutils

Class FrameBuffer

java.lang.Object

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

com.badlogic.gdx.graphics.glutils.FrameBuffer

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

FloatFrameBuffer

public class FrameBuffer
extends GLFrameBuffer<Texture>

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 GLFrameBuffer.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/interfaces inherited from class com.badlogic.gdx.graphics.glutils.GLFrameBuffer

GLFrameBuffer.FloatFrameBufferBuilder, GLFrameBuffer.FrameBufferBuilder, GLFrameBuffer.FrameBufferCubemapBuilder, GLFrameBuffer.GLFrameBufferBuilder<U extends GLFrameBuffer<? extends GLTexture>>

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

Modifier and Type	Method and Description
static void	unbind() See GLFrameBuffer.unbind()

Methods inherited from class com.badlogic.gdx.graphics.glutils.GLFrameBuffer

begin, bind, clearAllFrameBuffers, dispose, end, end, getColorBufferTexture, getDepthBufferHandle, getFramebufferHandle, getHeight, getManagedStatus, getManagedStatus, getStencilBufferHandle, getTextureAttachments, getWidth, invalidateAllFrameBuffers

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.

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

unbind

public static void unbind()

See GLFrameBuffer.unbind()