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