OgreGL3PlusFrameBufferObject.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __OgreGL3PlusFBO_H__
#define __OgreGL3PlusFBO_H__

#include "OgreGL3PlusRenderTexture.h"
#include "OgreGL3PlusContext.h"

namespace Ogre {
    
    class GL3PlusFBOManager;
    struct GL3PlusSurfaceDesc;

    class _OgreGL3PlusExport GL3PlusFrameBufferObject
    {
    public:
        GL3PlusFrameBufferObject(GL3PlusFBOManager *manager, uint fsaa);
        ~GL3PlusFrameBufferObject();

        void bindSurface(size_t attachment, const GL3PlusSurfaceDesc &target);
        void unbindSurface(size_t attachment);
        
        void bind();

        void swapBuffers();

        void attachDepthBuffer( DepthBuffer *depthBuffer );
        void detachDepthBuffer();

        GLuint getGLFBOID() const { return mFB; }
        GLuint getGLMultisampleFBOID() const { return mMultisampleFB; }
        
        uint32 getWidth();
        uint32 getHeight();
        PixelFormat getFormat();
        GLsizei getFSAA();
        
        GL3PlusFBOManager *getManager() { return mManager; }
        const GL3PlusSurfaceDesc &getSurface(size_t attachment) { return mColour[attachment]; }
    private:
        GL3PlusFBOManager *mManager;
        GLsizei mNumSamples;
        GLuint mFB;
        GLuint mMultisampleFB;
        GL3PlusSurfaceDesc mMultisampleColourBuffer;
        GL3PlusSurfaceDesc mDepth;
        GL3PlusSurfaceDesc mStencil;
        // Arbitrary number of texture surfaces
        GL3PlusSurfaceDesc mColour[OGRE_MAX_MULTIPLE_RENDER_TARGETS];


        void initialise();
    };

}

#endif