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