include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 15 Feb 2011 13:59:59 -0800
changeset 5297 1800dc39b74c
parent 5276 8e421890cdb8
child 5380 2de85077eb0b
permissions -rw-r--r--
Changed the concept of a render clip rect to a render viewport.
The render viewport is automatically re-centered when the window changes size, so applications that don't care will not have to handle recalculating their rendering coordinates.

Fixed API for drawing and filling multiple rectangles - the parameter should be an array of rects, not an array of pointers to rects.

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