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