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

Copyright (c) 2000-2014 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 __OgreGLContext_H__
#define __OgreGLContext_H__

#include "OgreGLSupportPrerequisites.h"
#include "OgreGLStateCacheManagerCommon.h"
#include "OgreSharedPtr.h"

namespace Ogre {

    /**
     * Class that encapsulates an GL context. (IE a window/pbuffer). This is a 
     * virtual base class which should be implemented in a GLSupport.
     * This object can also be used to cache renderstate if we decide to do so
     * in the future.
     */
    class _OgreGLExport GLContext
    {
    public:
        GLContext() : initialized(false) {}
        virtual ~GLContext() {}

        /**
         * Enable the context. All subsequent rendering commands will go here.
         */
        virtual void setCurrent() = 0;
        /**
         * This is called before another context is made current. By default,
         * nothing is done here.
         */
        virtual void endCurrent() = 0;

        bool getInitialized() { return initialized; };
        void setInitialized() { initialized = true; };

        /** Create a new context based on the same window/pbuffer as this
            context - mostly useful for additional threads.
        @note The caller is responsible for deleting the returned context.
        */
        virtual GLContext* clone() const = 0;

        /**
        * Release the render context.
        */
        virtual void releaseContext() {}

        /**
        * Get the state cache manager, creating it on demand
        */
        template<class StateCacheManager>
        StateCacheManager* createOrRetrieveStateCacheManager() {
            if(!mStateCacheManager) {
                StateCacheManager* stateCache = OGRE_NEW StateCacheManager;
                stateCache->initializeCache();
                mStateCacheManager = SharedPtr<GLStateCacheManagerCommon>(stateCache);
            }
            return static_cast<StateCacheManager*>(mStateCacheManager.get());
        }

        /// VAOs deferred for destruction in proper GL context
        vector<uint32>::type& _getVaoDeferredForDestruction() { return mVaoDeferredForDestruction; }
        /// FBOs deferred for destruction in proper GL context
        vector<uint32>::type& _getFboDeferredForDestruction() { return mFboDeferredForDestruction; }
        
    protected:
        bool initialized;
        SharedPtr<GLStateCacheManagerCommon> mStateCacheManager;
        vector<uint32>::type mVaoDeferredForDestruction;
        vector<uint32>::type mFboDeferredForDestruction;
    };
}

#endif
