SLGLFrameBuffer Class Reference

#include <SLGLFrameBuffer.h>

Public Member Functions
	SLGLFrameBuffer (SLsizei rboWidth, SLsizei rboHeight)
	Constructor. More...
virtual	~SLGLFrameBuffer ()
void	clear ()
	Calls delete and clears data. More...
void	deleteGL ()
	Deletes this buffers. More...
void	generate ()
	Generates the framebuffer. More...
void	bind ()
	Binds the framebuffer and renderbuffer. More...
void	unbind ()
	Unbinds the framebuffer and renderbuffer. More...
void	bindAndSetBufferStorage (SLsizei width, SLsizei height)
	Sets the size of the buffer storage. More...
void	attachTexture2D (SLenum attachment, SLenum target, SLGLTexture *texture, SLint level=0)
	Attaches texture image to framebuffer. More...
SLuint	fboId ()
SLuint	rboId ()
SLsizei	rboWidth ()
SLsizei	rboHeight ()

Static Public Attributes
static SLuint	totalBufferCount = 0
static SLuint	totalBufferSize = 0
	static total no. of buffers in use More...

Protected Attributes
SLuint	_fboId
	static total size of all buffers in bytes More...
SLuint	_prevFboId
	previously active frame buffer identifier More...
SLuint	_rboId
	render buffer identifier More...
SLuint	_sizeBytes
	size in bytes of this buffer More...
SLsizei	_rboWidth
	width of the render buffer More...
SLsizei	_rboHeight
	height of the render buffer More...

Detailed Description

The frame buffer class generates a frame buffer and a render buffer, with the default size of 512x512, this can also in run time be changed.

Definition at line 21 of file SLGLFrameBuffer.h.

Constructor & Destructor Documentation

SLGLFrameBuffer()

SLGLFrameBuffer::SLGLFrameBuffer	(	SLsizei	rboWidth,
		SLsizei	rboHeight
	)

Constructor.

Definition at line 18 of file SLGLFrameBuffer.cpp.

{
    _fboId     = 0;
    _rboId     = 0;
    _prevFboId = 0;
    _rboWidth  = rboWidth;
    _rboHeight = rboHeight;
}

~SLGLFrameBuffer()

virtual SLGLFrameBuffer::~SLGLFrameBuffer ( )

inlinevirtual

Definition at line 25 of file SLGLFrameBuffer.h.

{ clear(); }

Member Function Documentation

attachTexture2D()

void SLGLFrameBuffer::attachTexture2D	(	SLenum	attachment,
		SLenum	target,
		SLGLTexture *	texture,
		SLint	level = 0
	)

Attaches texture image to framebuffer.

attach one 2D texture to the frame buffer

Definition at line 116 of file SLGLFrameBuffer.cpp.

{
    assert(_fboId && _rboId);
    glFramebufferTexture2D(GL_FRAMEBUFFER,
                           attachment,
                           target,
                           texture->texID(),
                           level);
}

bind()

void SLGLFrameBuffer::bind

(

)

Binds the framebuffer and renderbuffer.

Definition at line 78 of file SLGLFrameBuffer.cpp.

{
    assert(_fboId && "No framebuffer generated");
 
    // Keep the previous FB ID for later unbinding
    SLint prevFboId;
    glGetIntegerv(GL_FRAMEBUFFER_BINDING, &prevFboId);
    if (prevFboId != _fboId)
        _prevFboId = prevFboId;
 
    glBindFramebuffer(GL_FRAMEBUFFER, _fboId);
 
    assert(_rboId && "No renderbuffer generated");
    glBindRenderbuffer(GL_RENDERBUFFER, _rboId);
}

bindAndSetBufferStorage()

void SLGLFrameBuffer::bindAndSetBufferStorage	(	SLsizei	width,
		SLsizei	height
	)

Sets the size of the buffer storage.

change the render buffer size at will

Definition at line 103 of file SLGLFrameBuffer.cpp.

{
    bind();
    _rboWidth  = width;
    _rboHeight = height;
    glRenderbufferStorage(GL_RENDERBUFFER,
                          GL_DEPTH_COMPONENT24,
                          width,
                          height);
}

clear()

void SLGLFrameBuffer::clear

(

)

Calls delete and clears data.

clear delete buffers and respectively adjust the stats variables

Definition at line 29 of file SLGLFrameBuffer.cpp.

{
    deleteGL();
    totalBufferCount--;
    totalBufferSize -= _sizeBytes;
}

deleteGL()

void SLGLFrameBuffer::deleteGL

(

)

Deletes this buffers.

calls the delete functions only if the buffers exist

Definition at line 37 of file SLGLFrameBuffer.cpp.

{
    unbind();
 
    if (_fboId)
    {
        glDeleteBuffers(1, &_fboId);
        _fboId = 0;
    }
 
    if (_rboId)
    {
        glDeleteBuffers(1, &_rboId);
        _rboId = 0;
    }
}

fboId()

SLuint SLGLFrameBuffer::fboId ( )

inline

Definition at line 53 of file SLGLFrameBuffer.h.

{ return this->_fboId; }

generate()

void SLGLFrameBuffer::generate

(

)

Generates the framebuffer.

generate the frame buffer and the render buffer if wanted

Definition at line 55 of file SLGLFrameBuffer.cpp.

{
    if (_fboId == 0)
    {
        glGenFramebuffers(1, &_fboId);
        glGenRenderbuffers(1, &_rboId);
        bindAndSetBufferStorage(_rboWidth, _rboHeight);
        glFramebufferRenderbuffer(GL_FRAMEBUFFER,
                                  GL_DEPTH_ATTACHMENT,
                                  GL_RENDERBUFFER,
                                  _rboId);
 
        // test if the generated fbo is valid
        if ((glCheckFramebufferStatus(GL_FRAMEBUFFER)) != GL_FRAMEBUFFER_COMPLETE)
            SL_EXIT_MSG("Frame buffer creation failed!");
 
        unbind();
        GET_GL_ERROR;
 
        totalBufferCount++;
    }
}

rboHeight()

SLsizei SLGLFrameBuffer::rboHeight ( )

inline

Definition at line 56 of file SLGLFrameBuffer.h.

{ return this->_rboHeight; }

rboId()

SLuint SLGLFrameBuffer::rboId ( )

inline

Definition at line 54 of file SLGLFrameBuffer.h.

{ return this->_rboId; }

rboWidth()

SLsizei SLGLFrameBuffer::rboWidth ( )

inline

Definition at line 55 of file SLGLFrameBuffer.h.

{ return this->_rboWidth; }

unbind()

void SLGLFrameBuffer::unbind

(

)

Unbinds the framebuffer and renderbuffer.

Definition at line 94 of file SLGLFrameBuffer.cpp.

{
    // iOS does not allow binding to 0. That's why we keep the previous FB ID
    glBindFramebuffer(GL_FRAMEBUFFER, _prevFboId);
 
    glBindRenderbuffer(GL_RENDERBUFFER, 0);
}

Member Data Documentation

_fboId

SLuint SLGLFrameBuffer::_fboId

protected

static total size of all buffers in bytes

frame buffer identifier

Definition at line 63 of file SLGLFrameBuffer.h.

_prevFboId

SLuint SLGLFrameBuffer::_prevFboId

protected

previously active frame buffer identifier

Definition at line 64 of file SLGLFrameBuffer.h.

_rboHeight

SLsizei SLGLFrameBuffer::_rboHeight

protected

height of the render buffer

Definition at line 68 of file SLGLFrameBuffer.h.

_rboId

SLuint SLGLFrameBuffer::_rboId

protected

render buffer identifier

Definition at line 65 of file SLGLFrameBuffer.h.

_rboWidth

SLsizei SLGLFrameBuffer::_rboWidth

protected

width of the render buffer

Definition at line 67 of file SLGLFrameBuffer.h.

_sizeBytes

SLuint SLGLFrameBuffer::_sizeBytes

protected

size in bytes of this buffer

Definition at line 66 of file SLGLFrameBuffer.h.

totalBufferCount

SLuint SLGLFrameBuffer::totalBufferCount = 0

static

Definition at line 59 of file SLGLFrameBuffer.h.

totalBufferSize

SLuint SLGLFrameBuffer::totalBufferSize = 0

static

static total no. of buffers in use

Definition at line 60 of file SLGLFrameBuffer.h.

---

The documentation for this class was generated from the following files:

• SLGLFrameBuffer.h
• SLGLFrameBuffer.cpp