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