eq::util::FrameBufferObject Class Reference

A C++ class to abstract OpenGL frame buffer objects. More...

#include <frameBufferObject.h>

Inheritance diagram for eq::util::FrameBufferObject:

[legend]

Collaboration diagram for eq::util::FrameBufferObject:

[legend]

List of all members.

Public Member Functions
	FrameBufferObject (GLEWContext *const glewContext)
	Construct a new Frame Buffer Object.
	~FrameBufferObject ()
	Destruct the Frame Buffer Object.
void	setColorFormat (const GLuint format)
	Set format for all color textures, if desired format differs from the default format GL_RGBA.
bool	addColorTexture ()
	Add one color texture to the FBO.
bool	init (const int width, const int height, const int depthSize, const int stencilSize)
	Initialize the Frame Buffer Object.
void	exit ()
	De-initialize the Frame Buffer Object.
void	bind ()
	Bind to the Frame Buffer Object as the read and draw buffer of the current context.
void	unbind ()
	Unbind any Frame Buffer Object and use the default drawable for the current context.
bool	resize (const int width, const int height)
	Resize the FBO.
const TextureVector &	getColorTextures () const
const Texture &	getDepthTexture () const
const Texture &	getStencilTexture () const
const std::string &	getErrorMessage ()
PixelViewport	getPixelViewport () const
GLEWContext *	glewGetContext ()
const GLEWContext *	glewGetContext () const

Detailed Description

A C++ class to abstract OpenGL frame buffer objects.

Definition at line 34 of file frameBufferObject.h.

Member Function Documentation

void eq::util::FrameBufferObject::setColorFormat ( const GLuint format )

Set format for all color textures, if desired format differs from the default format GL_RGBA.

This function should be called before init().

Parameters:

format

new format of color texture

Definition at line 58 of file frameBufferObject.cpp.

Referenced by eq::GLWindow::configInitFBO(), and eq::util::AccumBufferObject::init().

Here is the caller graph for this function:

bool eq::util::FrameBufferObject::addColorTexture ( )

Add one color texture to the FBO.

One color texture is automatically created in the constructor. The maximum number of textures per FBO is 16. Added color textures will have the same format as the existing texture(s). This function has to be called on an uninitialized FBO.

Returns:: false if color texture can't be added, otherwise true

Definition at line 64 of file frameBufferObject.cpp.

References EQERROR.

bool eq::util::FrameBufferObject::init	(	const int	width,
		const int	height,
		const int	depthSize,
		const int	stencilSize
	)

Initialize the Frame Buffer Object.

On successful initialization, the FBO is bound.

Parameters:

	width	the initial width of the rendering buffer.
	height	the initial height of the rendering buffer.
	depthSize	The bit depth of the depth attachment
	stencilSize	The bit depth of the stencil attachment.