include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 11 Mar 2011 08:49:20 -0800
changeset 5466 006883d5fa51
parent 5403 424f036f7c68
child 5504 469da3d31cbd
permissions -rw-r--r--
Gamma support is back!

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