include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 20 Feb 2012 23:37:57 -0500
changeset 6296 b42657486c0d
parent 6138 4c64952a58fb
child 6370 93187f7f7d5d
permissions -rw-r--r--
Add OpenGL 3.X context creation support

Matthias Bentrup 2011-10-30 03:58:24 PDT

I've updated the context creation patch to include the bugfixes by Martin
Schreiber and also included a profile bit to request a ES2 compatible profile.

The wgl context creation may use 2 call to wglChoosePixelFormat if no
acceleration attribute is selected, this should work around a bug with buggy
AMD drivers (see #1254).
     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_FLAGS,
   187     SDL_GL_CONTEXT_PROFILE_MASK
   188 } SDL_GLattr;
   189 
   190 typedef enum
   191 {
   192     SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
   193     SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
   194     SDL_GL_CONTEXT_PROFILE_ES2            = 0x0004
   195 } SDL_GLprofile;
   196 
   197 typedef enum
   198 {
   199     SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
   200     SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
   201     SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004
   202 } SDL_GLcontextFlag;
   203 
   204 
   205 /* Function prototypes */
   206 
   207 /**
   208  *  \brief Get the number of video drivers compiled into SDL
   209  *  
   210  *  \sa SDL_GetVideoDriver()
   211  */
   212 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
   213 
   214 /**
   215  *  \brief Get the name of a built in video driver.
   216  *  
   217  *  \note The video drivers are presented in the order in which they are
   218  *        normally checked during initialization.
   219  *  
   220  *  \sa SDL_GetNumVideoDrivers()
   221  */
   222 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
   223 
   224 /**
   225  *  \brief Initialize the video subsystem, optionally specifying a video driver.
   226  *  
   227  *  \param driver_name Initialize a specific driver by name, or NULL for the 
   228  *                     default video driver.
   229  *  
   230  *  \return 0 on success, -1 on error
   231  *  
   232  *  This function initializes the video subsystem; setting up a connection
   233  *  to the window manager, etc, and determines the available display modes
   234  *  and pixel formats, but does not initialize a window or graphics mode.
   235  *  
   236  *  \sa SDL_VideoQuit()
   237  */
   238 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
   239 
   240 /**
   241  *  \brief Shuts down the video subsystem.
   242  *  
   243  *  This function closes all windows, and restores the original video mode.
   244  *  
   245  *  \sa SDL_VideoInit()
   246  */
   247 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   248 
   249 /**
   250  *  \brief Returns the name of the currently initialized video driver.
   251  *  
   252  *  \return The name of the current video driver or NULL if no driver
   253  *          has been initialized
   254  *  
   255  *  \sa SDL_GetNumVideoDrivers()
   256  *  \sa SDL_GetVideoDriver()
   257  */
   258 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
   259 
   260 /**
   261  *  \brief Returns the number of available video displays.
   262  *  
   263  *  \sa SDL_GetDisplayBounds()
   264  */
   265 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   266 
   267 /**
   268  *  \brief Get the desktop area represented by a display, with the primary
   269  *         display located at 0,0
   270  *  
   271  *  \return 0 on success, or -1 if the index is out of range.
   272  *  
   273  *  \sa SDL_GetNumVideoDisplays()
   274  */
   275 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
   276 
   277 /**
   278  *  \brief Returns the number of available display modes.
   279  *  
   280  *  \sa SDL_GetDisplayMode()
   281  */
   282 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
   283 
   284 /**
   285  *  \brief Fill in information about a specific display mode.
   286  *  
   287  *  \note The display modes are sorted in this priority:
   288  *        \li bits per pixel -> more colors to fewer colors
   289  *        \li width -> largest to smallest
   290  *        \li height -> largest to smallest
   291  *        \li refresh rate -> highest to lowest
   292  *  
   293  *  \sa SDL_GetNumDisplayModes()
   294  */
   295 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
   296                                                SDL_DisplayMode * mode);
   297 
   298 /**
   299  *  \brief Fill in information about the desktop display mode.
   300  */
   301 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   302 
   303 /**
   304  *  \brief Fill in information about the current display mode.
   305  */
   306 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   307 
   308 
   309 /**
   310  *  \brief Get the closest match to the requested display mode.
   311  *  
   312  *  \param mode The desired display mode
   313  *  \param closest A pointer to a display mode to be filled in with the closest 
   314  *                 match of the available display modes.
   315  *  
   316  *  \return The passed in value \c closest, or NULL if no matching video mode 
   317  *          was available.
   318  *  
   319  *  The available display modes are scanned, and \c closest is filled in with the
   320  *  closest mode matching the requested mode and returned.  The mode format and 
   321  *  refresh_rate default to the desktop mode if they are 0.  The modes are 
   322  *  scanned with size being first priority, format being second priority, and 
   323  *  finally checking the refresh_rate.  If all the available modes are too 
   324  *  small, then NULL is returned.
   325  *  
   326  *  \sa SDL_GetNumDisplayModes()
   327  *  \sa SDL_GetDisplayMode()
   328  */
   329 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
   330 
   331 /**
   332  *  \brief Get the display index associated with a window.
   333  *  
   334  *  \return the display index of the display containing the center of the
   335  *          window, or -1 on error.
   336  */
   337 extern DECLSPEC int SDLCALL SDL_GetWindowDisplay(SDL_Window * window);
   338 
   339 /**
   340  *  \brief Set the display mode used when a fullscreen window is visible.
   341  *
   342  *  By default the window's dimensions and the desktop format and refresh rate
   343  *  are used.
   344  *  
   345  *  \param mode The mode to use, or NULL for the default mode.
   346  *  
   347  *  \return 0 on success, or -1 if setting the display mode failed.
   348  *  
   349  *  \sa SDL_GetWindowDisplayMode()
   350  *  \sa SDL_SetWindowFullscreen()
   351  */
   352 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
   353                                                      const SDL_DisplayMode
   354                                                          * mode);
   355 
   356 /**
   357  *  \brief Fill in information about the display mode used when a fullscreen
   358  *         window is visible.
   359  *
   360  *  \sa SDL_SetWindowDisplayMode()
   361  *  \sa SDL_SetWindowFullscreen()
   362  */
   363 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
   364                                                      SDL_DisplayMode * mode);
   365 
   366 /**
   367  *  \brief Get the pixel format associated with the window.
   368  */
   369 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
   370 
   371 /**
   372  *  \brief Create a window with the specified position, dimensions, and flags.
   373  *  
   374  *  \param title The title of the window, in UTF-8 encoding.
   375  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   376  *               ::SDL_WINDOWPOS_UNDEFINED.
   377  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   378  *               ::SDL_WINDOWPOS_UNDEFINED.
   379  *  \param w     The width of the window.
   380  *  \param h     The height of the window.
   381  *  \param flags The flags for the window, a mask of any of the following: 
   382  *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL, 
   383  *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS, 
   384  *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED, 
   385  *               ::SDL_WINDOW_MINIMIZED,  ::SDL_WINDOW_INPUT_GRABBED.
   386  *  
   387  *  \return The id of the window created, or zero if window creation failed.
   388  *  
   389  *  \sa SDL_DestroyWindow()
   390  */
   391 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
   392                                                       int x, int y, int w,
   393                                                       int h, Uint32 flags);
   394 
   395 /**
   396  *  \brief Create an SDL window from an existing native window.
   397  *  
   398  *  \param data A pointer to driver-dependent window creation data
   399  *  
   400  *  \return The id of the window created, or zero if window creation failed.
   401  *  
   402  *  \sa SDL_DestroyWindow()
   403  */
   404 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
   405 
   406 /**
   407  *  \brief Get the numeric ID of a window, for logging purposes.
   408  */
   409 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
   410 
   411 /**
   412  *  \brief Get a window from a stored ID, or NULL if it doesn't exist.
   413  */
   414 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
   415 
   416 /**
   417  *  \brief Get the window flags.
   418  */
   419 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
   420 
   421 /**
   422  *  \brief Set the title of a window, in UTF-8 format.
   423  *  
   424  *  \sa SDL_GetWindowTitle()
   425  */
   426 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
   427                                                 const char *title);
   428 
   429 /**
   430  *  \brief Get the title of a window, in UTF-8 format.
   431  *  
   432  *  \sa SDL_SetWindowTitle()
   433  */
   434 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
   435 
   436 /**
   437  *  \brief Set the icon for a window.
   438  *  
   439  *  \param icon The icon for the window.
   440  */
   441 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
   442                                                SDL_Surface * icon);
   443 
   444 /**
   445  *  \brief Associate an arbitrary named pointer with a window.
   446  *  
   447  *  \param window   The window to associate with the pointer.
   448  *  \param name     The name of the pointer.
   449  *  \param userdata The associated pointer.
   450  *
   451  *  \return The previous value associated with 'name'
   452  *
   453  *  \note The name is case-sensitive.
   454  *
   455  *  \sa SDL_GetWindowData()
   456  */
   457 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
   458                                                 const char *name,
   459                                                 void *userdata);
   460 
   461 /**
   462  *  \brief Retrieve the data pointer associated with a window.
   463  *  
   464  *  \param window   The window to query.
   465  *  \param name     The name of the pointer.
   466  *
   467  *  \return The value associated with 'name'
   468  *  
   469  *  \sa SDL_SetWindowData()
   470  */
   471 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
   472                                                 const char *name);
   473 
   474 /**
   475  *  \brief Set the position of a window.
   476  *  
   477  *  \param window   The window to reposition.
   478  *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   479                     ::SDL_WINDOWPOS_UNDEFINED.
   480  *  \param y        The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   481                     ::SDL_WINDOWPOS_UNDEFINED.
   482  *  
   483  *  \note The window coordinate origin is the upper left of the display.
   484  *  
   485  *  \sa SDL_GetWindowPosition()
   486  */
   487 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
   488                                                    int x, int y);
   489 
   490 /**
   491  *  \brief Get the position of a window.
   492  *  
   493  *  \sa SDL_SetWindowPosition()
   494  */
   495 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
   496                                                    int *x, int *y);
   497 
   498 /**
   499  *  \brief Set the size of a window's client area.
   500  *  
   501  *  \note You can't change the size of a fullscreen window, it automatically
   502  *        matches the size of the display mode.
   503  *  
   504  *  \sa SDL_GetWindowSize()
   505  */
   506 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
   507                                                int h);
   508 
   509 /**
   510  *  \brief Get the size of a window's client area.
   511  *  
   512  *  \sa SDL_SetWindowSize()
   513  */
   514 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
   515                                                int *h);
   516 
   517 /**
   518  *  \brief Show a window.
   519  *  
   520  *  \sa SDL_HideWindow()
   521  */
   522 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
   523 
   524 /**
   525  *  \brief Hide a window.
   526  *  
   527  *  \sa SDL_ShowWindow()
   528  */
   529 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
   530 
   531 /**
   532  *  \brief Raise a window above other windows and set the input focus.
   533  */
   534 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
   535 
   536 /**
   537  *  \brief Make a window as large as possible.
   538  *  
   539  *  \sa SDL_RestoreWindow()
   540  */
   541 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
   542 
   543 /**
   544  *  \brief Minimize a window to an iconic representation.
   545  *  
   546  *  \sa SDL_RestoreWindow()
   547  */
   548 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
   549 
   550 /**
   551  *  \brief Restore the size and position of a minimized or maximized window.
   552  *  
   553  *  \sa SDL_MaximizeWindow()
   554  *  \sa SDL_MinimizeWindow()
   555  */
   556 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
   557 
   558 /**
   559  *  \brief Set a window's fullscreen state.
   560  *  
   561  *  \return 0 on success, or -1 if setting the display mode failed.
   562  *  
   563  *  \sa SDL_SetWindowDisplayMode()
   564  *  \sa SDL_GetWindowDisplayMode()
   565  */
   566 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
   567                                                     SDL_bool fullscreen);
   568 
   569 /**
   570  *  \brief Get the SDL surface associated with the window.
   571  *
   572  *  \return The window's framebuffer surface, or NULL on error. 
   573  *
   574  *  A new surface will be created with the optimal format for the window,
   575  *  if necessary. This surface will be freed when the window is destroyed.
   576  *
   577  *  \note You may not combine this with 3D or the rendering API on this window.
   578  *
   579  *  \sa SDL_UpdateWindowSurface()
   580  *  \sa SDL_UpdateWindowSurfaceRects()
   581  */
   582 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
   583 
   584 /**
   585  *  \brief Copy the window surface to the screen.
   586  *
   587  *  \return 0 on success, or -1 on error.
   588  *
   589  *  \sa SDL_GetWindowSurface()
   590  *  \sa SDL_UpdateWindowSurfaceRects()
   591  */
   592 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
   593 
   594 /**
   595  *  \brief Copy a number of rectangles on the window surface to the screen.
   596  *
   597  *  \return 0 on success, or -1 on error.
   598  *
   599  *  \sa SDL_GetWindowSurface()
   600  *  \sa SDL_UpdateWindowSurfaceRect()
   601  */
   602 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
   603                                                          SDL_Rect * rects,
   604                                                          int numrects);
   605 
   606 /**
   607  *  \brief Set a window's input grab mode.
   608  *  
   609  *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
   610  *  
   611  *  \sa SDL_GetWindowGrab()
   612  */
   613 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
   614                                                SDL_bool grabbed);
   615 
   616 /**
   617  *  \brief Get a window's input grab mode.
   618  *  
   619  *  \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
   620  *  
   621  *  \sa SDL_SetWindowGrab()
   622  */
   623 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
   624 
   625 /**
   626  *  \brief Set the brightness (gamma correction) for a window.
   627  *  
   628  *  \return 0 on success, or -1 if setting the brightness isn't supported.
   629  *  
   630  *  \sa SDL_GetWindowBrightness()
   631  *  \sa SDL_SetWindowGammaRamp()
   632  */
   633 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
   634 
   635 /**
   636  *  \brief Get the brightness (gamma correction) for a window.
   637  *  
   638  *  \return The last brightness value passed to SDL_SetWindowBrightness()
   639  *  
   640  *  \sa SDL_SetWindowBrightness()
   641  */
   642 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
   643 
   644 /**
   645  *  \brief Set the gamma ramp for a window.
   646  *  
   647  *  \param red The translation table for the red channel, or NULL.
   648  *  \param green The translation table for the green channel, or NULL.
   649  *  \param blue The translation table for the blue channel, or NULL.
   650  *  
   651  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   652  *  
   653  *  Set the gamma translation table for the red, green, and blue channels
   654  *  of the video hardware.  Each table is an array of 256 16-bit quantities,
   655  *  representing a mapping between the input and output for that channel.
   656  *  The input is the index into the array, and the output is the 16-bit
   657  *  gamma value at that index, scaled to the output color precision.
   658  *
   659  *  \sa SDL_GetWindowGammaRamp()
   660  */
   661 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
   662                                                    const Uint16 * red,
   663                                                    const Uint16 * green,
   664                                                    const Uint16 * blue);
   665 
   666 /**
   667  *  \brief Get the gamma ramp for a window.
   668  *  
   669  *  \param red   A pointer to a 256 element array of 16-bit quantities to hold 
   670  *               the translation table for the red channel, or NULL.
   671  *  \param green A pointer to a 256 element array of 16-bit quantities to hold 
   672  *               the translation table for the green channel, or NULL.
   673  *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold 
   674  *               the translation table for the blue channel, or NULL.
   675  *   
   676  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   677  *  
   678  *  \sa SDL_SetWindowGammaRamp()
   679  */
   680 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
   681                                                    Uint16 * red,
   682                                                    Uint16 * green,
   683                                                    Uint16 * blue);
   684 
   685 /**
   686  *  \brief Destroy a window.
   687  */
   688 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
   689 
   690 
   691 /**
   692  *  \brief Returns whether the screensaver is currently enabled (default on).
   693  *  
   694  *  \sa SDL_EnableScreenSaver()
   695  *  \sa SDL_DisableScreenSaver()
   696  */
   697 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
   698 
   699 /**
   700  *  \brief Allow the screen to be blanked by a screensaver
   701  *  
   702  *  \sa SDL_IsScreenSaverEnabled()
   703  *  \sa SDL_DisableScreenSaver()
   704  */
   705 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
   706 
   707 /**
   708  *  \brief Prevent the screen from being blanked by a screensaver
   709  *  
   710  *  \sa SDL_IsScreenSaverEnabled()
   711  *  \sa SDL_EnableScreenSaver()
   712  */
   713 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
   714 
   715 
   716 /**
   717  *  \name OpenGL support functions
   718  */
   719 /*@{*/
   720 
   721 /**
   722  *  \brief Dynamically load an OpenGL library.
   723  *  
   724  *  \param path The platform dependent OpenGL library name, or NULL to open the 
   725  *              default OpenGL library.
   726  *  
   727  *  \return 0 on success, or -1 if the library couldn't be loaded.
   728  *  
   729  *  This should be done after initializing the video driver, but before
   730  *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
   731  *  library will be loaded upon creation of the first OpenGL window.
   732  *  
   733  *  \note If you do this, you need to retrieve all of the GL functions used in
   734  *        your program from the dynamic library using SDL_GL_GetProcAddress().
   735  *  
   736  *  \sa SDL_GL_GetProcAddress()
   737  *  \sa SDL_GL_UnloadLibrary()
   738  */
   739 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
   740 
   741 /**
   742  *  \brief Get the address of an OpenGL function.
   743  */
   744 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
   745 
   746 /**
   747  *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
   748  *  
   749  *  \sa SDL_GL_LoadLibrary()
   750  */
   751 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
   752 
   753 /**
   754  *  \brief Return true if an OpenGL extension is supported for the current 
   755  *         context.
   756  */
   757 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
   758                                                            *extension);
   759 
   760 /**
   761  *  \brief Set an OpenGL window attribute before window creation.
   762  */
   763 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
   764 
   765 /**
   766  *  \brief Get the actual value for an attribute from the current context.
   767  */
   768 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
   769 
   770 /**
   771  *  \brief Create an OpenGL context for use with an OpenGL window, and make it 
   772  *         current.
   773  *  
   774  *  \sa SDL_GL_DeleteContext()
   775  */
   776 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
   777                                                            window);
   778 
   779 /**
   780  *  \brief Set up an OpenGL context for rendering into an OpenGL window.
   781  *  
   782  *  \note The context must have been created with a compatible window.
   783  */
   784 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
   785                                                SDL_GLContext context);
   786 
   787 /**
   788  *  \brief Set the swap interval for the current OpenGL context.
   789  *  
   790  *  \param interval 0 for immediate updates, 1 for updates synchronized with the
   791  *                  vertical retrace.
   792  *  
   793  *  \return 0 on success, or -1 if setting the swap interval is not supported.
   794  *  
   795  *  \sa SDL_GL_GetSwapInterval()
   796  */
   797 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
   798 
   799 /**
   800  *  \brief Get the swap interval for the current OpenGL context.
   801  *  
   802  *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer 
   803  *          swap is synchronized with the vertical retrace, and -1 if getting 
   804  *          the swap interval is not supported.
   805  *  
   806  *  \sa SDL_GL_SetSwapInterval()
   807  */
   808 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
   809 
   810 /**
   811  * \brief Swap the OpenGL buffers for a window, if double-buffering is 
   812  *        supported.
   813  */
   814 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
   815 
   816 /**
   817  *  \brief Delete an OpenGL context.
   818  *  
   819  *  \sa SDL_GL_CreateContext()
   820  */
   821 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
   822 
   823 /*@}*//*OpenGL support functions*/
   824 
   825 
   826 /* Ends C function definitions when using C++ */
   827 #ifdef __cplusplus
   828 /* *INDENT-OFF* */
   829 }
   830 /* *INDENT-ON* */
   831 #endif
   832 #include "close_code.h"
   833 
   834 #endif /* _SDL_video_h */
   835 
   836 /* vi: set ts=4 sw=4 expandtab: */