1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4     (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __OgreGLContext_H__
29 #define __OgreGLContext_H__
30 
31 #include "OgreGLSupportPrerequisites.h"
32 #include "OgreGLStateCacheManagerCommon.h"
33 #include "OgreSharedPtr.h"
34 
35 namespace Ogre {
36 
37     /**
38      * Class that encapsulates an GL context. (IE a window/pbuffer). This is a
39      * virtual base class which should be implemented in a GLSupport.
40      * This object can also be used to cache renderstate if we decide to do so
41      * in the future.
42      */
43     class _OgreGLExport GLContext
44     {
45     public:
GLContext()46         GLContext() : initialized(false) {}
~GLContext()47         virtual ~GLContext() {}
48 
49         /**
50          * Enable the context. All subsequent rendering commands will go here.
51          */
52         virtual void setCurrent() = 0;
53         /**
54          * This is called before another context is made current. By default,
55          * nothing is done here.
56          */
57         virtual void endCurrent() = 0;
58 
getInitialized()59         bool getInitialized() { return initialized; };
setInitialized()60         void setInitialized() { initialized = true; };
61 
62         /** Create a new context based on the same window/pbuffer as this
63             context - mostly useful for additional threads.
64         @note The caller is responsible for deleting the returned context.
65         */
66         virtual GLContext* clone() const OGRE_NODISCARD = 0;
67 
68         /**
69         * Release the render context.
70         */
releaseContext()71         virtual void releaseContext() {}
72 
73         /**
74         * Get the state cache manager, creating it on demand
75         */
76         template<class StateCacheManager>
createOrRetrieveStateCacheManager()77         StateCacheManager* createOrRetrieveStateCacheManager() {
78             if(!mStateCacheManager) {
79                 StateCacheManager* stateCache = OGRE_NEW StateCacheManager;
80                 stateCache->initializeCache();
81                 mStateCacheManager = SharedPtr<GLStateCacheManagerCommon>(stateCache);
82             }
83             return static_cast<StateCacheManager*>(mStateCacheManager.get());
84         }
85 
86         /// VAOs deferred for destruction in proper GL context
_getVaoDeferredForDestruction()87         std::vector<uint32>& _getVaoDeferredForDestruction() { return mVaoDeferredForDestruction; }
88         /// FBOs deferred for destruction in proper GL context
_getFboDeferredForDestruction()89         std::vector<uint32>& _getFboDeferredForDestruction() { return mFboDeferredForDestruction; }
90 
91     protected:
92         bool initialized;
93         SharedPtr<GLStateCacheManagerCommon> mStateCacheManager;
94         std::vector<uint32> mVaoDeferredForDestruction;
95         std::vector<uint32> mFboDeferredForDestruction;
96     };
97 }
98 
99 #endif
100