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