GLFrameBuffer (libgdx API)

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 java.lang.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

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.util.Map<Application,Array<GLFrameBuffer>>`	`buffers` the frame buffers
`protected T`	`colorTexture` the color buffer texture
`protected static int`	`defaultFramebufferHandle` the default framebuffer handle, a.k.a screen.
`protected static boolean`	`defaultFramebufferHandleInitialized` true if we have polled for the default handle already.
`protected int`	`depthbufferHandle` the depthbuffer render object handle
`protected int`	`depthStencilPackedBufferHandle` the depth stencil packed render buffer object handle
`protected Pixmap.Format`	`format` format
`protected int`	`framebufferHandle` the framebuffer handle
`protected static int`	`GL_DEPTH24_STENCIL8_OES`
`protected boolean`	`hasDepth` depth
`protected boolean`	`hasDepthStencilPackedBuffer` if has depth stencil packed buffer
`protected boolean`	`hasStencil` stencil
`protected int`	`height` height
`protected int`	`stencilbufferHandle` the stencilbuffer render object handle
`protected int`	`width` width

Constructor Summary

Constructors
Constructor and Description
`GLFrameBuffer(Pixmap.Format format, int width, int height, boolean hasDepth)` Creates a new FrameBuffer having the given dimensions and potentially a depth buffer attached.
`GLFrameBuffer(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

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`attachFrameBufferColorTexture()` Override this method in a derived class to attach the backing texture to the GL framebuffer object.
`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.
`protected void`	`build()`
`static void`	`clearAllFrameBuffers(Application app)`
`protected abstract T`	`createColorTexture()` Override this method in a derived class to set up the backing texture as you like.
`void`	`dispose()` Releases all resources associated with the FrameBuffer.
`protected abstract void`	`disposeColorTexture(T colorTexture)` Override this method in a derived class to dispose the backing texture as you like.
`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()`
`int`	`getDepth()`
`int`	`getDepthBufferHandle()`
`protected int`	`getDepthStencilPackedBuffer()`
`int`	`getFramebufferHandle()`
`int`	`getHeight()`
`static java.lang.String`	`getManagedStatus()`
`static java.lang.StringBuilder`	`getManagedStatus(java.lang.StringBuilder builder)`
`int`	`getStencilBufferHandle()`
`int`	`getWidth()`
`static void`	`invalidateAllFrameBuffers(Application app)` Invalidates all frame buffers.
`protected void`	`setFrameBufferViewport()` Sets viewport to the dimensions of framebuffer.
`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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - buffers
```
protected static final java.util.Map<Application,Array<GLFrameBuffer>> buffers
```
    the frame buffers
  - GL_DEPTH24_STENCIL8_OES
```
protected static final int GL_DEPTH24_STENCIL8_OES
```
    See Also:
    
    Constant Field Values
  - colorTexture
```
protected T extends GLTexture colorTexture
```
    the color buffer texture
  - defaultFramebufferHandle
```
protected static int defaultFramebufferHandle
```
    the default framebuffer handle, a.k.a screen.
  - defaultFramebufferHandleInitialized
```
protected static boolean defaultFramebufferHandleInitialized
```
    true if we have polled for the default handle already.
  - framebufferHandle
```
protected int framebufferHandle
```
    the framebuffer handle
  - depthbufferHandle
```
protected int depthbufferHandle
```
    the depthbuffer render object handle
  - stencilbufferHandle
```
protected int stencilbufferHandle
```
    the stencilbuffer render object handle
  - depthStencilPackedBufferHandle
```
protected int depthStencilPackedBufferHandle
```
    the depth stencil packed render buffer object handle
  - width
```
protected final int width
```
    width
  - height
```
protected final int height
```
    height
  - hasDepth
```
protected final boolean hasDepth
```
    depth
  - hasStencil
```
protected final boolean hasStencil
```
    stencil
  - hasDepthStencilPackedBuffer
```
protected boolean hasDepthStencilPackedBuffer
```
    if has depth stencil packed buffer
  - format
```
protected final Pixmap.Format format
```
    format
- Constructor Detail
  - GLFrameBuffer
```
public GLFrameBuffer(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 -
  - GLFrameBuffer
```
public GLFrameBuffer(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
  - createColorTexture
```
protected abstract T createColorTexture()
```
    Override this method in a derived class to set up the backing texture as you like.
  - disposeColorTexture
```
protected abstract void disposeColorTexture(T colorTexture)
```
    Override this method in a derived class to dispose the backing texture as you like.
  - attachFrameBufferColorTexture
```
protected abstract void attachFrameBufferColorTexture()
```
    Override this method in a derived class to attach the backing texture to the GL framebuffer object.
  - build
```
protected void build()
```
  - 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.
  - setFrameBufferViewport
```
protected void setFrameBufferViewport()
```
    Sets viewport to the dimensions of framebuffer. Called by begin().
  - 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 T getColorBufferTexture()
```
    Returns:
    
    the gl texture
  - 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
  - getDepthStencilPackedBuffer
```
protected int getDepthStencilPackedBuffer()
```
    Returns:
    
    The OpenGL handle of the packed depth & stencil buffer (GL_DEPTH24_STENCIL8_OES) or 0 if not used.
  - getHeight
```
public int getHeight()
```
    Returns:
    
    the height of the framebuffer in pixels
  - getWidth
```
public int getWidth()
```
    Returns:
    
    the width of the framebuffer in pixels
  - getDepth
```
public int getDepth()
```
    Returns:
    
    the depth of the framebuffer in pixels (if applicable)
  - 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 java.lang.StringBuilder getManagedStatus(java.lang.StringBuilder builder)
```
  - getManagedStatus
```
public static java.lang.String getManagedStatus()
```

Class GLFrameBuffer<T extends GLTexture>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buffers

GL_DEPTH24_STENCIL8_OES

colorTexture

defaultFramebufferHandle

defaultFramebufferHandleInitialized

framebufferHandle

depthbufferHandle

stencilbufferHandle

depthStencilPackedBufferHandle

width

height

hasDepth

hasStencil

hasDepthStencilPackedBuffer

format

Constructor Detail

GLFrameBuffer

GLFrameBuffer

Method Detail

createColorTexture

disposeColorTexture

attachFrameBufferColorTexture

build

dispose

bind

unbind

begin

setFrameBufferViewport

end

end

getColorBufferTexture

getFramebufferHandle

getDepthBufferHandle

getStencilBufferHandle

getDepthStencilPackedBuffer

getHeight

getWidth

getDepth

invalidateAllFrameBuffers

clearAllFrameBuffers

getManagedStatus

getManagedStatus