include/SDL_video.h
author Ryan C. Gordon <icculus@icculus.org>
Wed, 01 Aug 2012 20:29:36 -0400
changeset 6382 64d54101773a
parent 6370 93187f7f7d5d
child 6393 a773384edf20
permissions -rw-r--r--
Add support for (GLX|WGL)_EXT_swap_control_tear.

This required a small public API change: SDL_GL_SetSwapInterval() now accepts
negative values, and SDL_GL_GetSwapInterval() doesn't report errors anymore
(if it can't work, it'll return zero as a reasonable default).

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