SLGLFrameBuffer.h

Go to the documentation of this file.

/**
 * \file      SLGLFrameBuffer.h
 * \brief     Wrapper class around OpenGL Frame Buffer Objects (FBO)
 * \date      April 2018
 * \authors   Carlos Arauz, Marcus Hudritsch
 * \copyright http://opensource.org/licenses/GPL-3.0
 * \remarks   Please use clangformat to format the code. See more code style on
 *            https://github.com/cpvrlab/SLProject4/wiki/SLProject-Coding-Style
*/
 
#ifndef SLGLFRAMEBUFFER_H
#define SLGLFRAMEBUFFER_H
 
#include <SLGLTexture.h>
 
//-----------------------------------------------------------------------------
/*!
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.
*/
class SLGLFrameBuffer
{
public:
    SLGLFrameBuffer(SLsizei rboWidth, SLsizei rboHeight);
    virtual ~SLGLFrameBuffer() { clear(); }
 
    //! Calls delete and clears data
    void clear();
 
    //! Deletes this buffers
    void deleteGL();
 
    //! Generates the framebuffer
    void generate();
 
    //! Binds the framebuffer and renderbuffer
    void bind();
 
    //! Unbinds the framebuffer and renderbuffer
    void unbind();
 
    //! Sets the size of the buffer storage
    void bindAndSetBufferStorage(SLsizei width,
                                 SLsizei height);
 
    //! Attaches texture image to framebuffer
    void attachTexture2D(SLenum       attachment,
                         SLenum       target,
                         SLGLTexture* texture,
                         SLint        level = 0);
 
    // Getters
    SLuint  fboId() { return this->_fboId; }
    SLuint  rboId() { return this->_rboId; }
    SLsizei rboWidth() { return this->_rboWidth; }
    SLsizei rboHeight() { return this->_rboHeight; }
 
    // Some statistics
    static SLuint totalBufferCount; //! static total no. of buffers in use
    static SLuint totalBufferSize;  //! static total size of all buffers in bytes
 
protected:
    SLuint  _fboId;     //!< frame buffer identifier
    SLuint  _prevFboId; //!< previously active frame buffer identifier
    SLuint  _rboId;     //!< render buffer identifier
    SLuint  _sizeBytes; //!< size in bytes of this buffer
    SLsizei _rboWidth;  //!< width of the render buffer
    SLsizei _rboHeight; //!< height of the render buffer
};
//-----------------------------------------------------------------------------
#endif