frameBufferObject.h

/* Copyright (c) 2008-2009, Cedric Stalder <cedric.stalder@gmail.com>
                 2009-2011, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQUTIL_FRAMEBUFFEROBJECT_H 
#define EQUTIL_FRAMEBUFFEROBJECT_H 

#include <eq/util/texture.h> // member
#include <eq/util/types.h>

#include <eq/gl.h>           // for GLEW
#include <co/base/error.h>

#include <vector>

namespace eq
{
namespace util
{
    class FrameBufferObject 
    {
    public: 
        EQ_API FrameBufferObject( const GLEWContext* const glewContext, 
                  const GLenum textureTarget = GL_TEXTURE_RECTANGLE_ARB );

        EQ_API ~FrameBufferObject();

        EQ_API bool addColorTexture();

        EQ_API bool init( const int32_t width, const int32_t height, 
                             const GLuint colorFormat,
                             const int32_t depthSize,
                             const int32_t stencilSize );

        EQ_API void exit();

        EQ_API void bind();

        EQ_API void unbind();

        EQ_API bool resize( const int32_t width, const int32_t height );

        int32_t getWidth() const
            { EQASSERT( !_colors.empty( )); return _colors.front()->getWidth();}

        int32_t getHeight() const
            { EQASSERT( !_colors.empty()); return _colors.front()->getHeight();}

        const Textures& getColorTextures() const { return _colors; }

        const Texture& getDepthTexture() const { return _depth; }

        const co::base::Error& getError() { return _error; }

        const GLEWContext* glewGetContext() const { return _glewContext; }

        bool isValid() const { return _valid; }

    private:
        GLuint _fboID; 

        Textures _colors; 
        Texture _depth;

        const GLEWContext* const _glewContext;

        co::base::Error _error;

        bool _valid;

        struct Private;
        Private* _private; // placeholder for binary-compatible changes

        EQ_TS_VAR( _thread );

        bool _checkStatus();

        void _setError( const int32_t error );
    };
}
}

#endif // EQUTIL_FRAMEBUFFEROBJECT_H