frameBufferObject.h

/* Copyright (c) 2008-2009, Cedric Stalder <cedric.stalder@gmail.com>
                 2009, 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 EQ_FRAMEBUFFEROBJECT_H 
#define EQ_FRAMEBUFFEROBJECT_H 

#include <eq/client/windowSystem.h> // for GL types
#include <eq/client/texture.h>      // member

#include <vector>

namespace eq
{
    class FrameBufferObject 
    {
    public: 
        FrameBufferObject( GLEWContext* const glewContext );

        ~FrameBufferObject();

        bool init( const int width, const int height, 
                   const int depthSize, const int stencilSize );

        void setColorFormat( const GLuint format );

        void exit();

        void bind();

        void unbind();

        /* Resize FBO, if needed. */
        bool resize( const int width, const int height );

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

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

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

        const Texture& getStencilTexture() const { return _stencil; }

        const std::string& getErrorMessage() { return _error; }

        PixelViewport getPixelViewport() const;

        bool addColorTexture( );

    private:
        GLuint _fboID;

        int _width;
        int _height;

        TextureVector _colors; 

        Texture _depth;
        Texture _stencil;

        GLEWContext* const _glewContext;

        std::string _error;

        bool _valid;

        union // placeholder for binary-compatible changes
        {
            char dummy[64];
        };

        CHECK_THREAD_DECLARE( _thread );

        bool _checkFBOStatus();
    };
}


#endif //EQ_FRAMEBUFFEROBJECT_H