include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 12 Aug 2012 11:16:24 -0700
changeset 6393 a773384edf20
parent 6382 64d54101773a
child 6394 9612bcd79130
permissions -rw-r--r--
Fixed bug 1565 - some small GL context creation enhancements

Matthias Bentrup 2012-08-09 12:53:17 PDT

With OpenGL 4.3 the ARB added a new context flag for context reset isolation
and renamed the existing ES2 profile bit to ES profile bit, as it can be used
to request GLES 3 compatible contexts, too.

This patch adds these changes to SDL on Linux and Windows.

Also SDL lacks the ability to create shared contexts. This patch also adds a
new GL attribute to enable context sharing. As casting a GL context to int is
not portable, I added only a boolean attribute
SDL_GL_SHARE_WITH_CURRENT_CONTEXT, which makes the new context share resources
with the context current on the creating thread.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_video.h
    24  *  
    25  *  Header file for SDL video functions.
    26  */
    27 
    28 #ifndef _SDL_video_h
    29 #define _SDL_video_h
    30 
    31 #include "SDL_stdinc.h"
    32 #include "SDL_pixels.h"
    33 #include "SDL_rect.h"
    34 #include "SDL_surface.h"
    35 
    36 #include "begin_code.h"
    37 /* Set up for C function definitions, even when using C++ */
    38 #ifdef __cplusplus
    39 /* *INDENT-OFF* */
    40 extern "C" {
    41 /* *INDENT-ON* */
    42 #endif
    43 
    44 /**
    45  *  \brief  The structure that defines a display mode
    46  *  
    47  *  \sa SDL_GetNumDisplayModes()
    48  *  \sa SDL_GetDisplayMode()
    49  *  \sa SDL_GetDesktopDisplayMode()
    50  *  \sa SDL_GetCurrentDisplayMode()
    51  *  \sa SDL_GetClosestDisplayMode()
    52  *  \sa SDL_SetWindowDisplayMode()
    53  *  \sa SDL_GetWindowDisplayMode()
    54  */
    55 typedef struct
    56 {
    57     Uint32 format;              /**< pixel format */
    58     int w;                      /**< width */
    59     int h;                      /**< height */
    60     int refresh_rate;           /**< refresh rate (or zero for unspecified) */
    61     void *driverdata;           /**< driver-specific data, initialize to 0 */
    62 } SDL_DisplayMode;
    63 
    64 /**
    65  *  \brief The type used to identify a window
    66  *  
    67  *  \sa SDL_CreateWindow()
    68  *  \sa SDL_CreateWindowFrom()
    69  *  \sa SDL_DestroyWindow()
    70  *  \sa SDL_GetWindowData()
    71  *  \sa SDL_GetWindowFlags()
    72  *  \sa SDL_GetWindowGrab()
    73  *  \sa SDL_GetWindowPosition()
    74  *  \sa SDL_GetWindowSize()
    75  *  \sa SDL_GetWindowTitle()
    76  *  \sa SDL_HideWindow()
    77  *  \sa SDL_MaximizeWindow()
    78  *  \sa SDL_MinimizeWindow()
    79  *  \sa SDL_RaiseWindow()
    80  *  \sa SDL_RestoreWindow()
    81  *  \sa SDL_SetWindowData()
    82  *  \sa SDL_SetWindowFullscreen()
    83  *  \sa SDL_SetWindowGrab()
    84  *  \sa SDL_SetWindowIcon()
    85  *  \sa SDL_SetWindowPosition()
    86  *  \sa SDL_SetWindowSize()
    87  *  \sa SDL_SetWindowTitle()
    88  *  \sa SDL_ShowWindow()
    89  */
    90 typedef struct SDL_Window SDL_Window;
    91 
    92 /**
    93  *  \brief The flags on a window
    94  *  
    95  *  \sa SDL_GetWindowFlags()
    96  */
    97 typedef enum
    98 {
    99     SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window */
   100     SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */
   101     SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
   102     SDL_WINDOW_HIDDEN = 0x00000008,             /**< window is not visible */
   103     SDL_WINDOW_BORDERLESS = 0x00000010,         /**< no window decoration */
   104     SDL_WINDOW_RESIZABLE = 0x00000020,          /**< window can be resized */
   105     SDL_WINDOW_MINIMIZED = 0x00000040,          /**< window is minimized */
   106     SDL_WINDOW_MAXIMIZED = 0x00000080,          /**< window is maximized */
   107     SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */
   108     SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */
   109     SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
   110     SDL_WINDOW_FOREIGN = 0x00000800             /**< window not created by SDL */
   111 } SDL_WindowFlags;
   112 
   113 /**
   114  *  \brief Used to indicate that you don't care what the window position is.
   115  */
   116 #define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000
   117 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
   118 #define SDL_WINDOWPOS_UNDEFINED         SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
   119 #define SDL_WINDOWPOS_ISUNDEFINED(X)    \
   120             (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
   121 
   122 /**
   123  *  \brief Used to indicate that the window position should be centered.
   124  */
   125 #define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000
   126 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))
   127 #define SDL_WINDOWPOS_CENTERED         SDL_WINDOWPOS_CENTERED_DISPLAY(0)
   128 #define SDL_WINDOWPOS_ISCENTERED(X)    \
   129             (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
   130 
   131 /**
   132  *  \brief Event subtype for window events
   133  */
   134 typedef enum
   135 {
   136     SDL_WINDOWEVENT_NONE,           /**< Never used */
   137     SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
   138     SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
   139     SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be 
   140                                          redrawn */
   141     SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2 
   142                                      */
   143     SDL_WINDOWEVENT_RESIZED,        /**< Window has been resized to data1xdata2 */
   144     SDL_WINDOWEVENT_SIZE_CHANGED,   /**< The window size has changed, either as a result of an API call or through the system or user changing the window size. */
   145     SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
   146     SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
   147     SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
   148                                          and position */
   149     SDL_WINDOWEVENT_ENTER,          /**< Window has gained mouse focus */
   150     SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
   151     SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
   152     SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
   153     SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the 
   154                                          window be closed */
   155 } SDL_WindowEventID;
   156 
   157 /**
   158  *  \brief An opaque handle to an OpenGL context.
   159  */
   160 typedef void *SDL_GLContext;
   161 
   162 /**
   163  *  \brief OpenGL configuration attributes
   164  */
   165 typedef enum
   166 {
   167     SDL_GL_RED_SIZE,
   168     SDL_GL_GREEN_SIZE,
   169     SDL_GL_BLUE_SIZE,
   170     SDL_GL_ALPHA_SIZE,
   171     SDL_GL_BUFFER_SIZE,
   172     SDL_GL_DOUBLEBUFFER,
   173     SDL_GL_DEPTH_SIZE,
   174     SDL_GL_STENCIL_SIZE,
   175     SDL_GL_ACCUM_RED_SIZE,
   176     SDL_GL_ACCUM_GREEN_SIZE,
   177     SDL_GL_ACCUM_BLUE_SIZE,
   178     SDL_GL_ACCUM_ALPHA_SIZE,
   179     SDL_GL_STEREO,
   180     SDL_GL_MULTISAMPLEBUFFERS,
   181     SDL_GL_MULTISAMPLESAMPLES,
   182     SDL_GL_ACCELERATED_VISUAL,
   183     SDL_GL_RETAINED_BACKING,
   184     SDL_GL_CONTEXT_MAJOR_VERSION,
   185     SDL_GL_CONTEXT_MINOR_VERSION,
   186     SDL_GL_CONTEXT_EGL,
   187     SDL_GL_CONTEXT_FLAGS,
   188     SDL_GL_CONTEXT_PROFILE_MASK,
   189     SDL_GL_SHARE_WITH_CURRENT_CONTEXT
   190 } SDL_GLattr;
   191 
   192 typedef enum
   193 {
   194     SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
   195     SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
   196     SDL_GL_CONTEXT_PROFILE_ES             = 0x0004,
   197     SDL_GL_CONTEXT_PROFILE_ES2            = 0x0004
   198 } SDL_GLprofile;
   199 
   200 typedef enum
   201 {
   202     SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
   203     SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
   204     SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,
   205     SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008
   206 } SDL_GLcontextFlag;
   207 
   208 
   209 /* Function prototypes */
   210 
   211 /**
   212  *  \brief Get the number of video drivers compiled into SDL
   213  *  
   214  *  \sa SDL_GetVideoDriver()
   215  */
   216 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
   217 
   218 /**
   219  *  \brief Get the name of a built in video driver.
   220  *  
   221  *  \note The video drivers are presented in the order in which they are
   222  *        normally checked during initialization.
   223  *  
   224  *  \sa SDL_GetNumVideoDrivers()
   225  */
   226 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
   227 
   228 /**
   229  *  \brief Initialize the video subsystem, optionally specifying a video driver.
   230  *  
   231  *  \param driver_name Initialize a specific driver by name, or NULL for the 
   232  *                     default video driver.
   233  *  
   234  *  \return 0 on success, -1 on error
   235  *  
   236  *  This function initializes the video subsystem; setting up a connection
   237  *  to the window manager, etc, and determines the available display modes
   238  *  and pixel formats, but does not initialize a window or graphics mode.
   239  *  
   240  *  \sa SDL_VideoQuit()
   241  */
   242 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
   243 
   244 /**
   245  *  \brief Shuts down the video subsystem.
   246  *  
   247  *  This function closes all windows, and restores the original video mode.
   248  *  
   249  *  \sa SDL_VideoInit()
   250  */
   251 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   252 
   253 /**
   254  *  \brief Returns the name of the currently initialized video driver.
   255  *  
   256  *  \return The name of the current video driver or NULL if no driver
   257  *          has been initialized
   258  *  
   259  *  \sa SDL_GetNumVideoDrivers()
   260  *  \sa SDL_GetVideoDriver()
   261  */
   262 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
   263 
   264 /**
   265  *  \brief Returns the number of available video displays.
   266  *  
   267  *  \sa SDL_GetDisplayBounds()
   268  */
   269 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   270 
   271 /**
   272  *  \brief Get the desktop area represented by a display, with the primary
   273  *         display located at 0,0
   274  *  
   275  *  \return 0 on success, or -1 if the index is out of range.
   276  *  
   277  *  \sa SDL_GetNumVideoDisplays()
   278  */
   279 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
   280 
   281 /**
   282  *  \brief Returns the number of available display modes.
   283  *  
   284  *  \sa SDL_GetDisplayMode()
   285  */
   286 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
   287 
   288 /**
   289  *  \brief Fill in information about a specific display mode.
   290  *  
   291  *  \note The display modes are sorted in this priority:
   292  *        \li bits per pixel -> more colors to fewer colors
   293  *        \li width -> largest to smallest
   294  *        \li height -> largest to smallest
   295  *        \li refresh rate -> highest to lowest
   296  *  
   297  *  \sa SDL_GetNumDisplayModes()
   298  */
   299 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
   300                                                SDL_DisplayMode * mode);
   301 
   302 /**
   303  *  \brief Fill in information about the desktop display mode.
   304  */
   305 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   306 
   307 /**
   308  *  \brief Fill in information about the current display mode.
   309  */
   310 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   311 
   312 
   313 /**
   314  *  \brief Get the closest match to the requested display mode.
   315  *  
   316  *  \param mode The desired display mode
   317  *  \param closest A pointer to a display mode to be filled in with the closest 
   318  *                 match of the available display modes.
   319  *  
   320  *  \return The passed in value \c closest, or NULL if no matching video mode 
   321  *          was available.
   322  *  
   323  *  The available display modes are scanned, and \c closest is filled in with the
   324  *  closest mode matching the requested mode and returned.  The mode format and 
   325  *  refresh_rate default to the desktop mode if they are 0.  The modes are 
   326  *  scanned with size being first priority, format being second priority, and 
   327  *  finally checking the refresh_rate.  If all the available modes are too 
   328  *  small, then NULL is returned.
   329  *  
   330  *  \sa SDL_GetNumDisplayModes()
   331  *  \sa SDL_GetDisplayMode()
   332  */
   333 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
   334 
   335 /**
   336  *  \brief Get the display index associated with a window.
   337  *  
   338  *  \return the display index of the display containing the center of the
   339  *          window, or -1 on error.
   340  */
   341 extern DECLSPEC int SDLCALL SDL_GetWindowDisplay(SDL_Window * window);
   342 
   343 /**
   344  *  \brief Set the display mode used when a fullscreen window is visible.
   345  *
   346  *  By default the window's dimensions and the desktop format and refresh rate
   347  *  are used.
   348  *  
   349  *  \param mode The mode to use, or NULL for the default mode.
   350  *  
   351  *  \return 0 on success, or -1 if setting the display mode failed.
   352  *  
   353  *  \sa SDL_GetWindowDisplayMode()
   354  *  \sa SDL_SetWindowFullscreen()
   355  */
   356 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
   357                                                      const SDL_DisplayMode
   358                                                          * mode);
   359 
   360 /**
   361  *  \brief Fill in information about the display mode used when a fullscreen
   362  *         window is visible.
   363  *
   364  *  \sa SDL_SetWindowDisplayMode()
   365  *  \sa SDL_SetWindowFullscreen()
   366  */
   367 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
   368                                                      SDL_DisplayMode * mode);
   369 
   370 /**
   371  *  \brief Get the pixel format associated with the window.
   372  */
   373 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
   374 
   375 /**
   376  *  \brief Create a window with the specified position, dimensions, and flags.
   377  *  
   378  *  \param title The title of the window, in UTF-8 encoding.
   379  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   380  *               ::SDL_WINDOWPOS_UNDEFINED.
   381  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   382  *               ::SDL_WINDOWPOS_UNDEFINED.
   383  *  \param w     The width of the window.
   384  *  \param h     The height of the window.
   385  *  \param flags The flags for the window, a mask of any of the following: 
   386  *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL, 
   387  *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS, 
   388  *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED, 
   389  *               ::SDL_WINDOW_MINIMIZED,  ::SDL_WINDOW_INPUT_GRABBED.
   390  *  
   391  *  \return The id of the window created, or zero if window creation failed.
   392  *  
   393  *  \sa SDL_DestroyWindow()
   394  */
   395 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
   396                                                       int x, int y, int w,
   397                                                       int h, Uint32 flags);
   398 
   399 /**
   400  *  \brief Create an SDL window from an existing native window.
   401  *  
   402  *  \param data A pointer to driver-dependent window creation data
   403  *  
   404  *  \return The id of the window created, or zero if window creation failed.
   405  *  
   406  *  \sa SDL_DestroyWindow()
   407  */
   408 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
   409 
   410 /**
   411  *  \brief Get the numeric ID of a window, for logging purposes.
   412  */
   413 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
   414 
   415 /**
   416  *  \brief Get a window from a stored ID, or NULL if it doesn't exist.
   417  */
   418 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
   419 
   420 /**
   421  *  \brief Get the window flags.
   422  */
   423 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
   424 
   425 /**
   426  *  \brief Set the title of a window, in UTF-8 format.
   427  *  
   428  *  \sa SDL_GetWindowTitle()
   429  */
   430 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
   431                                                 const char *title);
   432 
   433 /**
   434  *  \brief Get the title of a window, in UTF-8 format.
   435  *  
   436  *  \sa SDL_SetWindowTitle()
   437  */
   438 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
   439 
   440 /**
   441  *  \brief Set the icon for a window.
   442  *  
   443  *  \param icon The icon for the window.
   444  */
   445 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
   446                                                SDL_Surface * icon);
   447 
   448 /**
   449  *  \brief Associate an arbitrary named pointer with a window.
   450  *  
   451  *  \param window   The window to associate with the pointer.
   452  *  \param name     The name of the pointer.
   453  *  \param userdata The associated pointer.
   454  *
   455  *  \return The previous value associated with 'name'
   456  *
   457  *  \note The name is case-sensitive.
   458  *
   459  *  \sa SDL_GetWindowData()
   460  */
   461 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
   462                                                 const char *name,
   463                                                 void *userdata);
   464 
   465 /**
   466  *  \brief Retrieve the data pointer associated with a window.
   467  *  
   468  *  \param window   The window to query.
   469  *  \param name     The name of the pointer.
   470  *
   471  *  \return The value associated with 'name'
   472  *  
   473  *  \sa SDL_SetWindowData()
   474  */
   475 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
   476                                                 const char *name);
   477 
   478 /**
   479  *  \brief Set the position of a window.
   480  *  
   481  *  \param window   The window to reposition.
   482  *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   483                     ::SDL_WINDOWPOS_UNDEFINED.
   484  *  \param y        The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   485                     ::SDL_WINDOWPOS_UNDEFINED.
   486  *  
   487  *  \note The window coordinate origin is the upper left of the display.
   488  *  
   489  *  \sa SDL_GetWindowPosition()
   490  */
   491 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
   492                                                    int x, int y);
   493 
   494 /**
   495  *  \brief Get the position of a window.
   496  *  
   497  *  \sa SDL_SetWindowPosition()
   498  */
   499 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
   500                                                    int *x, int *y);
   501 
   502 /**
   503  *  \brief Set the size of a window's client area.
   504  *  
   505  *  \note You can't change the size of a fullscreen window, it automatically
   506  *        matches the size of the display mode.
   507  *  
   508  *  \sa SDL_GetWindowSize()
   509  */
   510 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
   511                                                int h);
   512 
   513 /**
   514  *  \brief Get the size of a window's client area.
   515  *  
   516  *  \sa SDL_SetWindowSize()
   517  */
   518 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
   519                                                int *h);
   520 
   521 /**
   522  *  \brief Show a window.
   523  *  
   524  *  \sa SDL_HideWindow()
   525  */
   526 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
   527 
   528 /**
   529  *  \brief Hide a window.
   530  *  
   531  *  \sa SDL_ShowWindow()
   532  */
   533 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
   534 
   535 /**
   536  *  \brief Raise a window above other windows and set the input focus.
   537  */
   538 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
   539 
   540 /**
   541  *  \brief Make a window as large as possible.
   542  *  
   543  *  \sa SDL_RestoreWindow()
   544  */
   545 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
   546 
   547 /**
   548  *  \brief Minimize a window to an iconic representation.
   549  *  
   550  *  \sa SDL_RestoreWindow()
   551  */
   552 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
   553 
   554 /**
   555  *  \brief Restore the size and position of a minimized or maximized window.
   556  *  
   557  *  \sa SDL_MaximizeWindow()
   558  *  \sa SDL_MinimizeWindow()
   559  */
   560 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
   561 
   562 /**
   563  *  \brief Set a window's fullscreen state.
   564  *  
   565  *  \return 0 on success, or -1 if setting the display mode failed.
   566  *  
   567  *  \sa SDL_SetWindowDisplayMode()
   568  *  \sa SDL_GetWindowDisplayMode()
   569  */
   570 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
   571                                                     SDL_bool fullscreen);
   572 
   573 /**
   574  *  \brief Get the SDL surface associated with the window.
   575  *
   576  *  \return The window's framebuffer surface, or NULL on error. 
   577  *
   578  *  A new surface will be created with the optimal format for the window,
   579  *  if necessary. This surface will be freed when the window is destroyed.
   580  *
   581  *  \note You may not combine this with 3D or the rendering API on this window.
   582  *
   583  *  \sa SDL_UpdateWindowSurface()
   584  *  \sa SDL_UpdateWindowSurfaceRects()
   585  */
   586 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
   587 
   588 /**
   589  *  \brief Copy the window surface to the screen.
   590  *
   591  *  \return 0 on success, or -1 on error.
   592  *
   593  *  \sa SDL_GetWindowSurface()
   594  *  \sa SDL_UpdateWindowSurfaceRects()
   595  */
   596 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
   597 
   598 /**
   599  *  \brief Copy a number of rectangles on the window surface to the screen.
   600  *
   601  *  \return 0 on success, or -1 on error.
   602  *
   603  *  \sa SDL_GetWindowSurface()
   604  *  \sa SDL_UpdateWindowSurfaceRect()
   605  */
   606 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
   607                                                          SDL_Rect * rects,
   608                                                          int numrects);
   609 
   610 /**
   611  *  \brief Set a window's input grab mode.
   612  *  
   613  *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
   614  *  
   615  *  \sa SDL_GetWindowGrab()
   616  */
   617 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
   618                                                SDL_bool grabbed);
   619 
   620 /**
   621  *  \brief Get a window's input grab mode.
   622  *  
   623  *  \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
   624  *  
   625  *  \sa SDL_SetWindowGrab()
   626  */
   627 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
   628 
   629 /**
   630  *  \brief Set the brightness (gamma correction) for a window.
   631  *  
   632  *  \return 0 on success, or -1 if setting the brightness isn't supported.
   633  *  
   634  *  \sa SDL_GetWindowBrightness()
   635  *  \sa SDL_SetWindowGammaRamp()
   636  */
   637 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
   638 
   639 /**
   640  *  \brief Get the brightness (gamma correction) for a window.
   641  *  
   642  *  \return The last brightness value passed to SDL_SetWindowBrightness()
   643  *  
   644  *  \sa SDL_SetWindowBrightness()
   645  */
   646 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
   647 
   648 /**
   649  *  \brief Set the gamma ramp for a window.
   650  *  
   651  *  \param red The translation table for the red channel, or NULL.
   652  *  \param green The translation table for the green channel, or NULL.
   653  *  \param blue The translation table for the blue channel, or NULL.
   654  *  
   655  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   656  *  
   657  *  Set the gamma translation table for the red, green, and blue channels
   658  *  of the video hardware.  Each table is an array of 256 16-bit quantities,
   659  *  representing a mapping between the input and output for that channel.
   660  *  The input is the index into the array, and the output is the 16-bit
   661  *  gamma value at that index, scaled to the output color precision.
   662  *
   663  *  \sa SDL_GetWindowGammaRamp()
   664  */
   665 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
   666                                                    const Uint16 * red,
   667                                                    const Uint16 * green,
   668                                                    const Uint16 * blue);
   669 
   670 /**
   671  *  \brief Get the gamma ramp for a window.
   672  *  
   673  *  \param red   A pointer to a 256 element array of 16-bit quantities to hold 
   674  *               the translation table for the red channel, or NULL.
   675  *  \param green A pointer to a 256 element array of 16-bit quantities to hold 
   676  *               the translation table for the green channel, or NULL.
   677  *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold 
   678  *               the translation table for the blue channel, or NULL.
   679  *   
   680  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   681  *  
   682  *  \sa SDL_SetWindowGammaRamp()
   683  */
   684 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
   685                                                    Uint16 * red,
   686                                                    Uint16 * green,
   687                                                    Uint16 * blue);
   688 
   689 /**
   690  *  \brief Destroy a window.
   691  */
   692 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
   693 
   694 
   695 /**
   696  *  \brief Returns whether the screensaver is currently enabled (default on).
   697  *  
   698  *  \sa SDL_EnableScreenSaver()
   699  *  \sa SDL_DisableScreenSaver()
   700  */
   701 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
   702 
   703 /**
   704  *  \brief Allow the screen to be blanked by a screensaver
   705  *  
   706  *  \sa SDL_IsScreenSaverEnabled()
   707  *  \sa SDL_DisableScreenSaver()
   708  */
   709 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
   710 
   711 /**
   712  *  \brief Prevent the screen from being blanked by a screensaver
   713  *  
   714  *  \sa SDL_IsScreenSaverEnabled()
   715  *  \sa SDL_EnableScreenSaver()
   716  */
   717 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
   718 
   719 
   720 /**
   721  *  \name OpenGL support functions
   722  */
   723 /*@{*/
   724 
   725 /**
   726  *  \brief Dynamically load an OpenGL library.
   727  *  
   728  *  \param path The platform dependent OpenGL library name, or NULL to open the 
   729  *              default OpenGL library.
   730  *  
   731  *  \return 0 on success, or -1 if the library couldn't be loaded.
   732  *  
   733  *  This should be done after initializing the video driver, but before
   734  *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
   735  *  library will be loaded upon creation of the first OpenGL window.
   736  *  
   737  *  \note If you do this, you need to retrieve all of the GL functions used in
   738  *        your program from the dynamic library using SDL_GL_GetProcAddress().
   739  *  
   740  *  \sa SDL_GL_GetProcAddress()
   741  *  \sa SDL_GL_UnloadLibrary()
   742  */
   743 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
   744 
   745 /**
   746  *  \brief Get the address of an OpenGL function.
   747  */
   748 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
   749 
   750 /**
   751  *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
   752  *  
   753  *  \sa SDL_GL_LoadLibrary()
   754  */
   755 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
   756 
   757 /**
   758  *  \brief Return true if an OpenGL extension is supported for the current 
   759  *         context.
   760  */
   761 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
   762                                                            *extension);
   763 
   764 /**
   765  *  \brief Set an OpenGL window attribute before window creation.
   766  */
   767 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
   768 
   769 /**
   770  *  \brief Get the actual value for an attribute from the current context.
   771  */
   772 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
   773 
   774 /**
   775  *  \brief Create an OpenGL context for use with an OpenGL window, and make it 
   776  *         current.
   777  *  
   778  *  \sa SDL_GL_DeleteContext()
   779  */
   780 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
   781                                                            window);
   782 
   783 /**
   784  *  \brief Set up an OpenGL context for rendering into an OpenGL window.
   785  *  
   786  *  \note The context must have been created with a compatible window.
   787  */
   788 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
   789                                                SDL_GLContext context);
   790 
   791 /**
   792  *  \brief Set the swap interval for the current OpenGL context.
   793  *  
   794  *  \param interval 0 for immediate updates, 1 for updates synchronized with the
   795  *                  vertical retrace. If the system supports it, you may
   796  *                  specify -1 to allow late swaps to happen immediately
   797  *                  instead of waiting for the next retrace.
   798  *  
   799  *  \return 0 on success, or -1 if setting the swap interval is not supported.
   800  *  
   801  *  \sa SDL_GL_GetSwapInterval()
   802  */
   803 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
   804 
   805 /**
   806  *  \brief Get the swap interval for the current OpenGL context.
   807  *  
   808  *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer 
   809  *          swap is synchronized with the vertical retrace, and -1 if late
   810  *          swaps happen immediately instead of waiting for the next retrace.
   811  *          If the system can't determine the swap interval, or there isn't a
   812  *          valid current context, this will return 0 as a safe default.
   813  *  
   814  *  \sa SDL_GL_SetSwapInterval()
   815  */
   816 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
   817 
   818 /**
   819  * \brief Swap the OpenGL buffers for a window, if double-buffering is 
   820  *        supported.
   821  */
   822 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
   823 
   824 /**
   825  *  \brief Delete an OpenGL context.
   826  *  
   827  *  \sa SDL_GL_CreateContext()
   828  */
   829 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
   830 
   831 /*@}*//*OpenGL support functions*/
   832 
   833 
   834 /* Ends C function definitions when using C++ */
   835 #ifdef __cplusplus
   836 /* *INDENT-OFF* */
   837 }
   838 /* *INDENT-ON* */
   839 #endif
   840 #include "close_code.h"
   841 
   842 #endif /* _SDL_video_h */
   843 
   844 /* vi: set ts=4 sw=4 expandtab: */