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