Ghost Context Refactor
[blender-staging.git] / intern / ghost / intern / GHOST_ContextCGL.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2014 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Jason Wilkins
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_ContextCGL.h
29  *  \ingroup GHOST
30  */
31
32 #ifndef __GHOST_CONTEXTCGL_H__
33 #define __GHOST_CONTEXTCGL_H__
34
35 #include "GHOST_Context.h"
36
37 //#define cglewGetContext() cglewContext
38 //#include <GL/cglew.h>
39 //extern "C" CGLEWContext *cglewContext;
40
41 #ifndef GHOST_OPENGL_CGL_CONTEXT_FLAGS
42 #define GHOST_OPENGL_CGL_CONTEXT_FLAGS 0
43 #endif
44
45 #ifndef GHOST_OPENGL_CGL_RESET_NOTIFICATION_STRATEGY
46 #define GHOST_OPENGL_CGL_RESET_NOTIFICATION_STRATEGY 0
47 #endif
48
49
50 @class NSWindow;
51 @class NSOpenGLView;
52 @class NSOpenGLContext;
53
54
55 class GHOST_ContextCGL : public GHOST_Context
56 {
57 public:
58         /**
59          * Constructor.
60          */
61         GHOST_ContextCGL(
62                 bool stereoVisual,
63                 GHOST_TUns16 numOfAASamples,
64                 NSWindow *window,
65                 NSOpenGLView *openGLView,
66                 int contextProfileMask,
67                 int contextMajorVersion,
68                 int contextMinorVersion,
69                 int contextFlags,
70                 int contextResetNotificationStrategy);
71
72         /**
73          * Destructor.
74          */
75         virtual ~GHOST_ContextCGL();
76
77         /**
78          * Swaps front and back buffers of a window.
79          * \return  A boolean success indicator.
80          */
81         virtual GHOST_TSuccess swapBuffers();
82
83         /**
84          * Activates the drawing context of this window.
85          * \return  A boolean success indicator.
86          */
87         virtual GHOST_TSuccess activateDrawingContext();
88
89         /**
90          * Call immediately after new to initialize.  If this fails then immediately delete the object.
91          * \return Indication as to whether initialization has succeeded.
92          */
93         virtual GHOST_TSuccess initializeDrawingContext();
94
95         /**
96          * Removes references to native handles from this context and then returns
97          * \return GHOST_kSuccess if it is OK for the parent to release the handles and
98          * GHOST_kFailure if releasing the handles will interfere with sharing
99          */
100         virtual GHOST_TSuccess releaseNativeHandles();
101
102         /**
103          * Sets the swap interval for swapBuffers.
104          * \param interval The swap interval to use.
105          * \return A boolean success indicator.
106          */
107         virtual GHOST_TSuccess setSwapInterval(int interval);
108
109         /**
110          * Gets the current swap interval for swapBuffers.
111          * \param intervalOut Variable to store the swap interval if it can be read.
112          * \return Whether the swap interval can be read.
113          */
114         virtual GHOST_TSuccess getSwapInterval(int&);
115
116         /**
117          * Updates the drawing context of this window.
118          * Needed whenever the window is changed.
119          * \return Indication of success.
120          */
121         virtual GHOST_TSuccess updateDrawingContext();
122
123 //protected:
124 //      inline void activateCGLEW() const {
125 //              cglewContext = m_cglewContext;
126 //      }
127
128 private:
129         //void initContextCGLEW()
130
131         /** The window containing the OpenGL view */
132         NSWindow *m_window;
133
134         /** The openGL view */
135         NSOpenGLView *m_openGLView;
136
137         const int m_contextProfileMask;
138         const int m_contextMajorVersion;
139         const int m_contextMinorVersion;
140         const int m_contextFlags;
141         const int m_contextResetNotificationStrategy;
142
143         /** The opgnGL drawing context */
144         NSOpenGLContext *m_openGLContext;
145
146         //static CGLEWContext *s_cglewContext;
147
148         /** The first created OpenGL context (for sharing display lists) */
149         static NSOpenGLContext *s_sharedOpenGLContext;
150         static int              s_sharedCount;
151 };
152
153 #endif // __GHOST_CONTEXTCGL_H__