doxygen: add newline after \file
[blender.git] / intern / ghost / intern / GHOST_ContextSDL.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
21  * \ingroup GHOST
22  */
23
24 #ifndef __GHOST_CONTEXTSDL_H__
25 #define __GHOST_CONTEXTSDL_H__
26
27 #include "GHOST_Context.h"
28
29 extern "C" {
30         #include "SDL.h"
31 }
32
33
34 #ifndef GHOST_OPENGL_SDL_CONTEXT_FLAGS
35 #  ifdef WITH_GPU_DEBUG
36 #    define GHOST_OPENGL_SDL_CONTEXT_FLAGS SDL_GL_CONTEXT_DEBUG_FLAG
37 #  else
38 #    define GHOST_OPENGL_SDL_CONTEXT_FLAGS 0
39 # endif
40 #endif
41
42 #ifndef GHOST_OPENGL_SDL_RESET_NOTIFICATION_STRATEGY
43 #define GHOST_OPENGL_SDL_RESET_NOTIFICATION_STRATEGY 0
44 #endif
45
46
47 class GHOST_ContextSDL : public GHOST_Context
48 {
49 public:
50         /**
51          * Constructor.
52          */
53         GHOST_ContextSDL(
54                 bool stereoVisual,
55                 GHOST_TUns16 numOfAASamples,
56                 SDL_Window *window,
57                 int contextProfileMask,
58                 int contextMajorVersion,
59                 int contextMinorVersion,
60                 int contextFlags,
61                 int contextResetNotificationStrategy);
62
63         /**
64          * Destructor.
65          */
66         ~GHOST_ContextSDL();
67
68         /**
69          * Swaps front and back buffers of a window.
70          * \return  A boolean success indicator.
71          */
72         GHOST_TSuccess swapBuffers();
73
74         /**
75          * Activates the drawing context of this window.
76          * \return  A boolean success indicator.
77          */
78         GHOST_TSuccess activateDrawingContext();
79
80         /**
81          * Release the drawing context of the calling thread.
82          * \return  A boolean success indicator.
83          */
84         GHOST_TSuccess releaseDrawingContext();
85
86         /**
87          * Call immediately after new to initialize.  If this fails then immediately delete the object.
88          * \return Indication as to whether initialization has succeeded.
89          */
90         GHOST_TSuccess initializeDrawingContext();
91
92         /**
93          * Removes references to native handles from this context and then returns
94          * \return GHOST_kSuccess if it is OK for the parent to release the handles and
95          * GHOST_kFailure if releasing the handles will interfere with sharing
96          */
97         GHOST_TSuccess releaseNativeHandles();
98
99         /**
100          * Sets the swap interval for swapBuffers.
101          * \param interval The swap interval to use.
102          * \return A boolean success indicator.
103          */
104         GHOST_TSuccess setSwapInterval(int interval);
105
106         /**
107          * Gets the current swap interval for swapBuffers.
108          * \param intervalOut Variable to store the swap interval if it can be read.
109          * \return Whether the swap interval can be read.
110          */
111         GHOST_TSuccess getSwapInterval(int &intervalOut);
112
113 private:
114         SDL_Window *m_window;
115         SDL_Window *m_hidden_window;
116
117         const int m_contextProfileMask;
118         const int m_contextMajorVersion;
119         const int m_contextMinorVersion;
120         const int m_contextFlags;
121         const int m_contextResetNotificationStrategy;
122
123         SDL_GLContext m_context; /* m_sdl_glcontext */
124
125         /** The first created OpenGL context (for sharing display lists) */
126         static SDL_GLContext s_sharedContext;
127         static int           s_sharedCount;
128 };
129
130 #endif // __GHOST_CONTEXTSDL_H__