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