include/SDL_video.h
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Fri, 20 May 2016 22:18:15 +0200
changeset 10175 fcf0d3ca1fa2
parent 10168 9e3144cb1032
child 10216 e8281b14970c
permissions -rw-r--r--
Updated documentation of SDL_IsScreenSaverEnabled().

The screensaver is deactivated by default since SDL 2.0.2.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2016 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 extern "C" {
    40 #endif
    41 
    42 /**
    43  *  \brief  The structure that defines a display mode
    44  *
    45  *  \sa SDL_GetNumDisplayModes()
    46  *  \sa SDL_GetDisplayMode()
    47  *  \sa SDL_GetDesktopDisplayMode()
    48  *  \sa SDL_GetCurrentDisplayMode()
    49  *  \sa SDL_GetClosestDisplayMode()
    50  *  \sa SDL_SetWindowDisplayMode()
    51  *  \sa SDL_GetWindowDisplayMode()
    52  */
    53 typedef struct
    54 {
    55     Uint32 format;              /**< pixel format */
    56     int w;                      /**< width, in screen coordinates */
    57     int h;                      /**< height, in screen coordinates */
    58     int refresh_rate;           /**< refresh rate (or zero for unspecified) */
    59     void *driverdata;           /**< driver-specific data, initialize to 0 */
    60 } SDL_DisplayMode;
    61 
    62 /**
    63  *  \brief The type used to identify a window
    64  *
    65  *  \sa SDL_CreateWindow()
    66  *  \sa SDL_CreateWindowFrom()
    67  *  \sa SDL_DestroyWindow()
    68  *  \sa SDL_GetWindowData()
    69  *  \sa SDL_GetWindowFlags()
    70  *  \sa SDL_GetWindowGrab()
    71  *  \sa SDL_GetWindowPosition()
    72  *  \sa SDL_GetWindowSize()
    73  *  \sa SDL_GetWindowTitle()
    74  *  \sa SDL_HideWindow()
    75  *  \sa SDL_MaximizeWindow()
    76  *  \sa SDL_MinimizeWindow()
    77  *  \sa SDL_RaiseWindow()
    78  *  \sa SDL_RestoreWindow()
    79  *  \sa SDL_SetWindowData()
    80  *  \sa SDL_SetWindowFullscreen()
    81  *  \sa SDL_SetWindowGrab()
    82  *  \sa SDL_SetWindowIcon()
    83  *  \sa SDL_SetWindowPosition()
    84  *  \sa SDL_SetWindowSize()
    85  *  \sa SDL_SetWindowBordered()
    86  *  \sa SDL_SetWindowTitle()
    87  *  \sa SDL_ShowWindow()
    88  */
    89 typedef struct SDL_Window SDL_Window;
    90 
    91 /**
    92  *  \brief The flags on a window
    93  *
    94  *  \sa SDL_GetWindowFlags()
    95  */
    96 typedef enum
    97 {
    98     /* !!! FIXME: change this to name = (1<<x). */
    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_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
   111     SDL_WINDOW_FOREIGN = 0x00000800,            /**< window not created by SDL */
   112     SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000,      /**< window should be created in high-DPI mode if supported */
   113     SDL_WINDOW_MOUSE_CAPTURE = 0x00004000,      /**< window has mouse captured (unrelated to INPUT_GRABBED) */
   114     SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000,      /**< window should always be above others */
   115     SDL_WINDOW_SKIP_TASKBAR  = 0x00010000,      /**< window should not be added to the taskbar */
   116     SDL_WINDOW_UTILITY       = 0x00020000,      /**< window should be treated as a utility window */
   117     SDL_WINDOW_TOOLTIP       = 0x00040000,      /**< window should be treated as a tooltip */
   118     SDL_WINDOW_POPUP_MENU    = 0x00080000       /**< window should be treated as a popup menu */
   119 } SDL_WindowFlags;
   120 
   121 /**
   122  *  \brief Used to indicate that you don't care what the window position is.
   123  */
   124 #define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000
   125 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
   126 #define SDL_WINDOWPOS_UNDEFINED         SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
   127 #define SDL_WINDOWPOS_ISUNDEFINED(X)    \
   128             (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
   129 
   130 /**
   131  *  \brief Used to indicate that the window position should be centered.
   132  */
   133 #define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000
   134 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))
   135 #define SDL_WINDOWPOS_CENTERED         SDL_WINDOWPOS_CENTERED_DISPLAY(0)
   136 #define SDL_WINDOWPOS_ISCENTERED(X)    \
   137             (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
   138 
   139 /**
   140  *  \brief Event subtype for window events
   141  */
   142 typedef enum
   143 {
   144     SDL_WINDOWEVENT_NONE,           /**< Never used */
   145     SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
   146     SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
   147     SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be
   148                                          redrawn */
   149     SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2
   150                                      */
   151     SDL_WINDOWEVENT_RESIZED,        /**< Window has been resized to data1xdata2 */
   152     SDL_WINDOWEVENT_SIZE_CHANGED,   /**< The window size has changed, either as
   153                                          a result of an API call or through the
   154                                          system or user changing the window size. */
   155     SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
   156     SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
   157     SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
   158                                          and position */
   159     SDL_WINDOWEVENT_ENTER,          /**< Window has gained mouse focus */
   160     SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
   161     SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
   162     SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
   163     SDL_WINDOWEVENT_CLOSE,          /**< The window manager requests that the window be closed */
   164     SDL_WINDOWEVENT_TAKE_FOCUS,     /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */
   165     SDL_WINDOWEVENT_HIT_TEST        /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */
   166 } SDL_WindowEventID;
   167 
   168 /**
   169  *  \brief An opaque handle to an OpenGL context.
   170  */
   171 typedef void *SDL_GLContext;
   172 
   173 /**
   174  *  \brief OpenGL configuration attributes
   175  */
   176 typedef enum
   177 {
   178     SDL_GL_RED_SIZE,
   179     SDL_GL_GREEN_SIZE,
   180     SDL_GL_BLUE_SIZE,
   181     SDL_GL_ALPHA_SIZE,
   182     SDL_GL_BUFFER_SIZE,
   183     SDL_GL_DOUBLEBUFFER,
   184     SDL_GL_DEPTH_SIZE,
   185     SDL_GL_STENCIL_SIZE,
   186     SDL_GL_ACCUM_RED_SIZE,
   187     SDL_GL_ACCUM_GREEN_SIZE,
   188     SDL_GL_ACCUM_BLUE_SIZE,
   189     SDL_GL_ACCUM_ALPHA_SIZE,
   190     SDL_GL_STEREO,
   191     SDL_GL_MULTISAMPLEBUFFERS,
   192     SDL_GL_MULTISAMPLESAMPLES,
   193     SDL_GL_ACCELERATED_VISUAL,
   194     SDL_GL_RETAINED_BACKING,
   195     SDL_GL_CONTEXT_MAJOR_VERSION,
   196     SDL_GL_CONTEXT_MINOR_VERSION,
   197     SDL_GL_CONTEXT_EGL,
   198     SDL_GL_CONTEXT_FLAGS,
   199     SDL_GL_CONTEXT_PROFILE_MASK,
   200     SDL_GL_SHARE_WITH_CURRENT_CONTEXT,
   201     SDL_GL_FRAMEBUFFER_SRGB_CAPABLE,
   202     SDL_GL_CONTEXT_RELEASE_BEHAVIOR
   203 } SDL_GLattr;
   204 
   205 typedef enum
   206 {
   207     SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
   208     SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
   209     SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 /* GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
   210 } SDL_GLprofile;
   211 
   212 typedef enum
   213 {
   214     SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
   215     SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
   216     SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,
   217     SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008
   218 } SDL_GLcontextFlag;
   219 
   220 typedef enum
   221 {
   222     SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE   = 0x0000,
   223     SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH  = 0x0001
   224 } SDL_GLcontextReleaseFlag;
   225 
   226 
   227 /* Function prototypes */
   228 
   229 /**
   230  *  \brief Get the number of video drivers compiled into SDL
   231  *
   232  *  \sa SDL_GetVideoDriver()
   233  */
   234 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
   235 
   236 /**
   237  *  \brief Get the name of a built in video driver.
   238  *
   239  *  \note The video drivers are presented in the order in which they are
   240  *        normally checked during initialization.
   241  *
   242  *  \sa SDL_GetNumVideoDrivers()
   243  */
   244 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
   245 
   246 /**
   247  *  \brief Initialize the video subsystem, optionally specifying a video driver.
   248  *
   249  *  \param driver_name Initialize a specific driver by name, or NULL for the
   250  *                     default video driver.
   251  *
   252  *  \return 0 on success, -1 on error
   253  *
   254  *  This function initializes the video subsystem; setting up a connection
   255  *  to the window manager, etc, and determines the available display modes
   256  *  and pixel formats, but does not initialize a window or graphics mode.
   257  *
   258  *  \sa SDL_VideoQuit()
   259  */
   260 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
   261 
   262 /**
   263  *  \brief Shuts down the video subsystem.
   264  *
   265  *  This function closes all windows, and restores the original video mode.
   266  *
   267  *  \sa SDL_VideoInit()
   268  */
   269 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   270 
   271 /**
   272  *  \brief Returns the name of the currently initialized video driver.
   273  *
   274  *  \return The name of the current video driver or NULL if no driver
   275  *          has been initialized
   276  *
   277  *  \sa SDL_GetNumVideoDrivers()
   278  *  \sa SDL_GetVideoDriver()
   279  */
   280 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
   281 
   282 /**
   283  *  \brief Returns the number of available video displays.
   284  *
   285  *  \sa SDL_GetDisplayBounds()
   286  */
   287 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   288 
   289 /**
   290  *  \brief Get the name of a display in UTF-8 encoding
   291  *
   292  *  \return The name of a display, or NULL for an invalid display index.
   293  *
   294  *  \sa SDL_GetNumVideoDisplays()
   295  */
   296 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
   297 
   298 /**
   299  *  \brief Get the desktop area represented by a display, with the primary
   300  *         display located at 0,0
   301  *
   302  *  \return 0 on success, or -1 if the index is out of range.
   303  *
   304  *  \sa SDL_GetNumVideoDisplays()
   305  */
   306 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
   307 
   308 /**
   309  *  \brief Get the dots/pixels-per-inch for a display
   310  *
   311  *  \note Diagonal, horizontal and vertical DPI can all be optionally
   312  *        returned if the parameter is non-NULL.
   313  *
   314  *  \return 0 on success, or -1 if no DPI information is available or the index is out of range.
   315  *
   316  *  \sa SDL_GetNumVideoDisplays()
   317  */
   318 extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi);
   319 
   320 /**
   321  *  \brief Get the usable desktop area represented by a display, with the
   322  *         primary display located at 0,0
   323  *
   324  *  This is the same area as SDL_GetDisplayBounds() reports, but with portions
   325  *  reserved by the system removed. For example, on Mac OS X, this subtracts
   326  *  the area occupied by the menu bar and dock.
   327  *
   328  *  Setting a window to be fullscreen generally bypasses these unusable areas,
   329  *  so these are good guidelines for the maximum space available to a
   330  *  non-fullscreen window.
   331  *
   332  *  \return 0 on success, or -1 if the index is out of range.
   333  *
   334  *  \sa SDL_GetDisplayBounds()
   335  *  \sa SDL_GetNumVideoDisplays()
   336  */
   337 extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect);
   338 
   339 /**
   340  *  \brief Returns the number of available display modes.
   341  *
   342  *  \sa SDL_GetDisplayMode()
   343  */
   344 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
   345 
   346 /**
   347  *  \brief Fill in information about a specific display mode.
   348  *
   349  *  \note The display modes are sorted in this priority:
   350  *        \li bits per pixel -> more colors to fewer colors
   351  *        \li width -> largest to smallest
   352  *        \li height -> largest to smallest
   353  *        \li refresh rate -> highest to lowest
   354  *
   355  *  \sa SDL_GetNumDisplayModes()
   356  */
   357 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
   358                                                SDL_DisplayMode * mode);
   359 
   360 /**
   361  *  \brief Fill in information about the desktop display mode.
   362  */
   363 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   364 
   365 /**
   366  *  \brief Fill in information about the current display mode.
   367  */
   368 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   369 
   370 
   371 /**
   372  *  \brief Get the closest match to the requested display mode.
   373  *
   374  *  \param displayIndex The index of display from which mode should be queried.
   375  *  \param mode The desired display mode
   376  *  \param closest A pointer to a display mode to be filled in with the closest
   377  *                 match of the available display modes.
   378  *
   379  *  \return The passed in value \c closest, or NULL if no matching video mode
   380  *          was available.
   381  *
   382  *  The available display modes are scanned, and \c closest is filled in with the
   383  *  closest mode matching the requested mode and returned.  The mode format and
   384  *  refresh_rate default to the desktop mode if they are 0.  The modes are
   385  *  scanned with size being first priority, format being second priority, and
   386  *  finally checking the refresh_rate.  If all the available modes are too
   387  *  small, then NULL is returned.
   388  *
   389  *  \sa SDL_GetNumDisplayModes()
   390  *  \sa SDL_GetDisplayMode()
   391  */
   392 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
   393 
   394 /**
   395  *  \brief Get the display index associated with a window.
   396  *
   397  *  \return the display index of the display containing the center of the
   398  *          window, or -1 on error.
   399  */
   400 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
   401 
   402 /**
   403  *  \brief Set the display mode used when a fullscreen window is visible.
   404  *
   405  *  By default the window's dimensions and the desktop format and refresh rate
   406  *  are used.
   407  *
   408  *  \param window The window for which the display mode should be set.
   409  *  \param mode The mode to use, or NULL for the default mode.
   410  *
   411  *  \return 0 on success, or -1 if setting the display mode failed.
   412  *
   413  *  \sa SDL_GetWindowDisplayMode()
   414  *  \sa SDL_SetWindowFullscreen()
   415  */
   416 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
   417                                                      const SDL_DisplayMode
   418                                                          * mode);
   419 
   420 /**
   421  *  \brief Fill in information about the display mode used when a fullscreen
   422  *         window is visible.
   423  *
   424  *  \sa SDL_SetWindowDisplayMode()
   425  *  \sa SDL_SetWindowFullscreen()
   426  */
   427 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
   428                                                      SDL_DisplayMode * mode);
   429 
   430 /**
   431  *  \brief Get the pixel format associated with the window.
   432  */
   433 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
   434 
   435 /**
   436  *  \brief Create a window with the specified position, dimensions, and flags.
   437  *
   438  *  \param title The title of the window, in UTF-8 encoding.
   439  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
   440  *               ::SDL_WINDOWPOS_UNDEFINED.
   441  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
   442  *               ::SDL_WINDOWPOS_UNDEFINED.
   443  *  \param w     The width of the window, in screen coordinates.
   444  *  \param h     The height of the window, in screen coordinates.
   445  *  \param flags The flags for the window, a mask of any of the following:
   446  *               ::SDL_WINDOW_FULLSCREEN,    ::SDL_WINDOW_OPENGL,
   447  *               ::SDL_WINDOW_HIDDEN,        ::SDL_WINDOW_BORDERLESS,
   448  *               ::SDL_WINDOW_RESIZABLE,     ::SDL_WINDOW_MAXIMIZED,
   449  *               ::SDL_WINDOW_MINIMIZED,     ::SDL_WINDOW_INPUT_GRABBED,
   450  *               ::SDL_WINDOW_ALLOW_HIGHDPI.
   451  *
   452  *  \return The created window, or NULL if window creation failed.
   453  *
   454  *  If the window is created with the SDL_WINDOW_ALLOW_HIGHDPI flag, its size
   455  *  in pixels may differ from its size in screen coordinates on platforms with
   456  *  high-DPI support (e.g. iOS and Mac OS X). Use SDL_GetWindowSize() to query
   457  *  the client area's size in screen coordinates, and SDL_GL_GetDrawableSize()
   458  *  or SDL_GetRendererOutputSize() to query the drawable size in pixels.
   459  *
   460  *  \sa SDL_DestroyWindow()
   461  */
   462 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
   463                                                       int x, int y, int w,
   464                                                       int h, Uint32 flags);
   465 
   466 /**
   467  *  \brief Create an SDL window from an existing native window.
   468  *
   469  *  \param data A pointer to driver-dependent window creation data
   470  *
   471  *  \return The created window, or NULL if window creation failed.
   472  *
   473  *  \sa SDL_DestroyWindow()
   474  */
   475 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
   476 
   477 /**
   478  *  \brief Get the numeric ID of a window, for logging purposes.
   479  */
   480 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
   481 
   482 /**
   483  *  \brief Get a window from a stored ID, or NULL if it doesn't exist.
   484  */
   485 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
   486 
   487 /**
   488  *  \brief Get the window flags.
   489  */
   490 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
   491 
   492 /**
   493  *  \brief Set the title of a window, in UTF-8 format.
   494  *
   495  *  \sa SDL_GetWindowTitle()
   496  */
   497 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
   498                                                 const char *title);
   499 
   500 /**
   501  *  \brief Get the title of a window, in UTF-8 format.
   502  *
   503  *  \sa SDL_SetWindowTitle()
   504  */
   505 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
   506 
   507 /**
   508  *  \brief Set the icon for a window.
   509  *
   510  *  \param window The window for which the icon should be set.
   511  *  \param icon The icon for the window.
   512  */
   513 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
   514                                                SDL_Surface * icon);
   515 
   516 /**
   517  *  \brief Associate an arbitrary named pointer with a window.
   518  *
   519  *  \param window   The window to associate with the pointer.
   520  *  \param name     The name of the pointer.
   521  *  \param userdata The associated pointer.
   522  *
   523  *  \return The previous value associated with 'name'
   524  *
   525  *  \note The name is case-sensitive.
   526  *
   527  *  \sa SDL_GetWindowData()
   528  */
   529 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
   530                                                 const char *name,
   531                                                 void *userdata);
   532 
   533 /**
   534  *  \brief Retrieve the data pointer associated with a window.
   535  *
   536  *  \param window   The window to query.
   537  *  \param name     The name of the pointer.
   538  *
   539  *  \return The value associated with 'name'
   540  *
   541  *  \sa SDL_SetWindowData()
   542  */
   543 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
   544                                                 const char *name);
   545 
   546 /**
   547  *  \brief Set the position of a window.
   548  *
   549  *  \param window   The window to reposition.
   550  *  \param x        The x coordinate of the window in screen coordinates, or
   551  *                  ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED.
   552  *  \param y        The y coordinate of the window in screen coordinates, or
   553  *                  ::SDL_WINDOWPOS_CENTERED or ::SDL_WINDOWPOS_UNDEFINED.
   554  *
   555  *  \note The window coordinate origin is the upper left of the display.
   556  *
   557  *  \sa SDL_GetWindowPosition()
   558  */
   559 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
   560                                                    int x, int y);
   561 
   562 /**
   563  *  \brief Get the position of a window.
   564  *
   565  *  \param window   The window to query.
   566  *  \param x        Pointer to variable for storing the x position, in screen
   567  *                  coordinates. May be NULL.
   568  *  \param y        Pointer to variable for storing the y position, in screen
   569  *                  coordinates. May be NULL.
   570  *
   571  *  \sa SDL_SetWindowPosition()
   572  */
   573 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
   574                                                    int *x, int *y);
   575 
   576 /**
   577  *  \brief Set the size of a window's client area.
   578  *
   579  *  \param window   The window to resize.
   580  *  \param w        The width of the window, in screen coordinates. Must be >0.
   581  *  \param h        The height of the window, in screen coordinates. Must be >0.
   582  *
   583  *  \note You can't change the size of a fullscreen window, it automatically
   584  *        matches the size of the display mode.
   585  *
   586  *  The window size in screen coordinates may differ from the size in pixels, if
   587  *  the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with
   588  *  high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or
   589  *  SDL_GetRendererOutputSize() to get the real client area size in pixels.
   590  *
   591  *  \sa SDL_GetWindowSize()
   592  */
   593 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
   594                                                int h);
   595 
   596 /**
   597  *  \brief Get the size of a window's client area.
   598  *
   599  *  \param window   The window to query.
   600  *  \param w        Pointer to variable for storing the width, in screen
   601  *                  coordinates. May be NULL.
   602  *  \param h        Pointer to variable for storing the height, in screen
   603  *                  coordinates. May be NULL.
   604  *
   605  *  The window size in screen coordinates may differ from the size in pixels, if
   606  *  the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with
   607  *  high-dpi support (e.g. iOS or OS X). Use SDL_GL_GetDrawableSize() or
   608  *  SDL_GetRendererOutputSize() to get the real client area size in pixels.
   609  *
   610  *  \sa SDL_SetWindowSize()
   611  */
   612 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
   613                                                int *h);
   614 
   615 /**
   616  *  \brief Get the size of a window's borders (decorations) around the client area.
   617  *
   618  *  \param window The window to query.
   619  *  \param top Pointer to variable for storing the size of the top border. NULL is permitted.
   620  *  \param left Pointer to variable for storing the size of the left border. NULL is permitted.
   621  *  \param bottom Pointer to variable for storing the size of the bottom border. NULL is permitted.
   622  *  \param right Pointer to variable for storing the size of the right border. NULL is permitted.
   623  *
   624  *  \return 0 on success, or -1 if getting this information is not supported.
   625  *
   626  *  \note if this function fails (returns -1), the size values will be
   627  *        initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as
   628  *        if the window in question was borderless.
   629  */
   630 extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window * window,
   631                                                      int *top, int *left,
   632                                                      int *bottom, int *right);
   633 
   634 /**
   635  *  \brief Set the minimum size of a window's client area.
   636  *
   637  *  \param window    The window to set a new minimum size.
   638  *  \param min_w     The minimum width of the window, must be >0
   639  *  \param min_h     The minimum height of the window, must be >0
   640  *
   641  *  \note You can't change the minimum size of a fullscreen window, it
   642  *        automatically matches the size of the display mode.
   643  *
   644  *  \sa SDL_GetWindowMinimumSize()
   645  *  \sa SDL_SetWindowMaximumSize()
   646  */
   647 extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
   648                                                       int min_w, int min_h);
   649 
   650 /**
   651  *  \brief Get the minimum size of a window's client area.
   652  *
   653  *  \param window   The window to query.
   654  *  \param w        Pointer to variable for storing the minimum width, may be NULL
   655  *  \param h        Pointer to variable for storing the minimum height, may be NULL
   656  *
   657  *  \sa SDL_GetWindowMaximumSize()
   658  *  \sa SDL_SetWindowMinimumSize()
   659  */
   660 extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
   661                                                       int *w, int *h);
   662 
   663 /**
   664  *  \brief Set the maximum size of a window's client area.
   665  *
   666  *  \param window    The window to set a new maximum size.
   667  *  \param max_w     The maximum width of the window, must be >0
   668  *  \param max_h     The maximum height of the window, must be >0
   669  *
   670  *  \note You can't change the maximum size of a fullscreen window, it
   671  *        automatically matches the size of the display mode.
   672  *
   673  *  \sa SDL_GetWindowMaximumSize()
   674  *  \sa SDL_SetWindowMinimumSize()
   675  */
   676 extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
   677                                                       int max_w, int max_h);
   678 
   679 /**
   680  *  \brief Get the maximum size of a window's client area.
   681  *
   682  *  \param window   The window to query.
   683  *  \param w        Pointer to variable for storing the maximum width, may be NULL
   684  *  \param h        Pointer to variable for storing the maximum height, may be NULL
   685  *
   686  *  \sa SDL_GetWindowMinimumSize()
   687  *  \sa SDL_SetWindowMaximumSize()
   688  */
   689 extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
   690                                                       int *w, int *h);
   691 
   692 /**
   693  *  \brief Set the border state of a window.
   694  *
   695  *  This will add or remove the window's SDL_WINDOW_BORDERLESS flag and
   696  *  add or remove the border from the actual window. This is a no-op if the
   697  *  window's border already matches the requested state.
   698  *
   699  *  \param window The window of which to change the border state.
   700  *  \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
   701  *
   702  *  \note You can't change the border state of a fullscreen window.
   703  *
   704  *  \sa SDL_GetWindowFlags()
   705  */
   706 extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
   707                                                    SDL_bool bordered);
   708 
   709 /**
   710  *  \brief Show a window.
   711  *
   712  *  \sa SDL_HideWindow()
   713  */
   714 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
   715 
   716 /**
   717  *  \brief Hide a window.
   718  *
   719  *  \sa SDL_ShowWindow()
   720  */
   721 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
   722 
   723 /**
   724  *  \brief Raise a window above other windows and set the input focus.
   725  */
   726 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
   727 
   728 /**
   729  *  \brief Make a window as large as possible.
   730  *
   731  *  \sa SDL_RestoreWindow()
   732  */
   733 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
   734 
   735 /**
   736  *  \brief Minimize a window to an iconic representation.
   737  *
   738  *  \sa SDL_RestoreWindow()
   739  */
   740 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
   741 
   742 /**
   743  *  \brief Restore the size and position of a minimized or maximized window.
   744  *
   745  *  \sa SDL_MaximizeWindow()
   746  *  \sa SDL_MinimizeWindow()
   747  */
   748 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
   749 
   750 /**
   751  *  \brief Set a window's fullscreen state.
   752  *
   753  *  \return 0 on success, or -1 if setting the display mode failed.
   754  *
   755  *  \sa SDL_SetWindowDisplayMode()
   756  *  \sa SDL_GetWindowDisplayMode()
   757  */
   758 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
   759                                                     Uint32 flags);
   760 
   761 /**
   762  *  \brief Get the SDL surface associated with the window.
   763  *
   764  *  \return The window's framebuffer surface, or NULL on error.
   765  *
   766  *  A new surface will be created with the optimal format for the window,
   767  *  if necessary. This surface will be freed when the window is destroyed.
   768  *
   769  *  \note You may not combine this with 3D or the rendering API on this window.
   770  *
   771  *  \sa SDL_UpdateWindowSurface()
   772  *  \sa SDL_UpdateWindowSurfaceRects()
   773  */
   774 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
   775 
   776 /**
   777  *  \brief Copy the window surface to the screen.
   778  *
   779  *  \return 0 on success, or -1 on error.
   780  *
   781  *  \sa SDL_GetWindowSurface()
   782  *  \sa SDL_UpdateWindowSurfaceRects()
   783  */
   784 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
   785 
   786 /**
   787  *  \brief Copy a number of rectangles on the window surface to the screen.
   788  *
   789  *  \return 0 on success, or -1 on error.
   790  *
   791  *  \sa SDL_GetWindowSurface()
   792  *  \sa SDL_UpdateWindowSurfaceRect()
   793  */
   794 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
   795                                                          const SDL_Rect * rects,
   796                                                          int numrects);
   797 
   798 /**
   799  *  \brief Set a window's input grab mode.
   800  *
   801  *  \param window The window for which the input grab mode should be set.
   802  *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
   803  *
   804  *  If the caller enables a grab while another window is currently grabbed,
   805  *  the other window loses its grab in favor of the caller's window.
   806  *
   807  *  \sa SDL_GetWindowGrab()
   808  */
   809 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
   810                                                SDL_bool grabbed);
   811 
   812 /**
   813  *  \brief Get a window's input grab mode.
   814  *
   815  *  \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
   816  *
   817  *  \sa SDL_SetWindowGrab()
   818  */
   819 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
   820 
   821 /**
   822  *  \brief Get the window that currently has an input grab enabled.
   823  *
   824  *  \return This returns the window if input is grabbed, and NULL otherwise.
   825  *
   826  *  \sa SDL_SetWindowGrab()
   827  */
   828 extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
   829 
   830 /**
   831  *  \brief Set the brightness (gamma correction) for a window.
   832  *
   833  *  \return 0 on success, or -1 if setting the brightness isn't supported.
   834  *
   835  *  \sa SDL_GetWindowBrightness()
   836  *  \sa SDL_SetWindowGammaRamp()
   837  */
   838 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
   839 
   840 /**
   841  *  \brief Get the brightness (gamma correction) for a window.
   842  *
   843  *  \return The last brightness value passed to SDL_SetWindowBrightness()
   844  *
   845  *  \sa SDL_SetWindowBrightness()
   846  */
   847 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
   848 
   849 /**
   850  *  \brief Set the opacity for a window
   851  *
   852  *  \param window The window which will be made transparent or opaque
   853  *  \param opacity Opacity (0.0f - transparent, 1.0f - opaque) This will be
   854  *                 clamped internally between 0.0f and 1.0f.
   855  * 
   856  *  \return 0 on success, or -1 if setting the opacity isn't supported.
   857  *
   858  *  \sa SDL_GetWindowOpacity()
   859  */
   860 extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window * window, float opacity);
   861 
   862 /**
   863  *  \brief Get the opacity of a window.
   864  *
   865  *  If transparency isn't supported on this platform, opacity will be reported
   866  *  as 1.0f without error.
   867  *
   868  *  \param window The window in question.
   869  *  \param out_opacity Opacity (0.0f - transparent, 1.0f - opaque)
   870  *
   871  *  \return 0 on success, or -1 on error (invalid window, etc).
   872  *
   873  *  \sa SDL_SetWindowOpacity()
   874  */
   875 extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window * window, float * out_opacity);
   876 
   877 /**
   878  *  \brief Sets the window as a modal for another window (TODO: reconsider this function and/or its name)
   879  *
   880  *  \param modal_window The window that should be modal
   881  *  \param parent_window The parent window
   882  * 
   883  *  \return 0 on success, or -1 otherwise.
   884  */
   885 extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL_Window * parent_window);
   886 
   887 /**
   888  *  \brief Explicitly sets input focus to the window.
   889  *
   890  *  You almost certainly want SDL_RaiseWindow() instead of this function. Use
   891  *  this with caution, as you might give focus to a window that's completely
   892  *  obscured by other windows.
   893  *
   894  *  \param window The window that should get the input focus
   895  * 
   896  *  \return 0 on success, or -1 otherwise.
   897  *  \sa SDL_RaiseWindow()
   898  */
   899 extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window * window);
   900 
   901 /**
   902  *  \brief Set the gamma ramp for a window.
   903  *
   904  *  \param window The window for which the gamma ramp should be set.
   905  *  \param red The translation table for the red channel, or NULL.
   906  *  \param green The translation table for the green channel, or NULL.
   907  *  \param blue The translation table for the blue channel, or NULL.
   908  *
   909  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   910  *
   911  *  Set the gamma translation table for the red, green, and blue channels
   912  *  of the video hardware.  Each table is an array of 256 16-bit quantities,
   913  *  representing a mapping between the input and output for that channel.
   914  *  The input is the index into the array, and the output is the 16-bit
   915  *  gamma value at that index, scaled to the output color precision.
   916  *
   917  *  \sa SDL_GetWindowGammaRamp()
   918  */
   919 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
   920                                                    const Uint16 * red,
   921                                                    const Uint16 * green,
   922                                                    const Uint16 * blue);
   923 
   924 /**
   925  *  \brief Get the gamma ramp for a window.
   926  *
   927  *  \param window The window from which the gamma ramp should be queried.
   928  *  \param red   A pointer to a 256 element array of 16-bit quantities to hold
   929  *               the translation table for the red channel, or NULL.
   930  *  \param green A pointer to a 256 element array of 16-bit quantities to hold
   931  *               the translation table for the green channel, or NULL.
   932  *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold
   933  *               the translation table for the blue channel, or NULL.
   934  *
   935  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   936  *
   937  *  \sa SDL_SetWindowGammaRamp()
   938  */
   939 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
   940                                                    Uint16 * red,
   941                                                    Uint16 * green,
   942                                                    Uint16 * blue);
   943 
   944 /**
   945  *  \brief Possible return values from the SDL_HitTest callback.
   946  *
   947  *  \sa SDL_HitTest
   948  */
   949 typedef enum
   950 {
   951     SDL_HITTEST_NORMAL,  /**< Region is normal. No special properties. */
   952     SDL_HITTEST_DRAGGABLE,  /**< Region can drag entire window. */
   953     SDL_HITTEST_RESIZE_TOPLEFT,
   954     SDL_HITTEST_RESIZE_TOP,
   955     SDL_HITTEST_RESIZE_TOPRIGHT,
   956     SDL_HITTEST_RESIZE_RIGHT,
   957     SDL_HITTEST_RESIZE_BOTTOMRIGHT,
   958     SDL_HITTEST_RESIZE_BOTTOM,
   959     SDL_HITTEST_RESIZE_BOTTOMLEFT,
   960     SDL_HITTEST_RESIZE_LEFT
   961 } SDL_HitTestResult;
   962 
   963 /**
   964  *  \brief Callback used for hit-testing.
   965  *
   966  *  \sa SDL_SetWindowHitTest
   967  */
   968 typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
   969                                                  const SDL_Point *area,
   970                                                  void *data);
   971 
   972 /**
   973  *  \brief Provide a callback that decides if a window region has special properties.
   974  *
   975  *  Normally windows are dragged and resized by decorations provided by the
   976  *  system window manager (a title bar, borders, etc), but for some apps, it
   977  *  makes sense to drag them from somewhere else inside the window itself; for
   978  *  example, one might have a borderless window that wants to be draggable
   979  *  from any part, or simulate its own title bar, etc.
   980  *
   981  *  This function lets the app provide a callback that designates pieces of
   982  *  a given window as special. This callback is run during event processing
   983  *  if we need to tell the OS to treat a region of the window specially; the
   984  *  use of this callback is known as "hit testing."
   985  *
   986  *  Mouse input may not be delivered to your application if it is within
   987  *  a special area; the OS will often apply that input to moving the window or
   988  *  resizing the window and not deliver it to the application.
   989  *
   990  *  Specifying NULL for a callback disables hit-testing. Hit-testing is
   991  *  disabled by default.
   992  *
   993  *  Platforms that don't support this functionality will return -1
   994  *  unconditionally, even if you're attempting to disable hit-testing.
   995  *
   996  *  Your callback may fire at any time, and its firing does not indicate any
   997  *  specific behavior (for example, on Windows, this certainly might fire
   998  *  when the OS is deciding whether to drag your window, but it fires for lots
   999  *  of other reasons, too, some unrelated to anything you probably care about
  1000  *  _and when the mouse isn't actually at the location it is testing_).
  1001  *  Since this can fire at any time, you should try to keep your callback
  1002  *  efficient, devoid of allocations, etc.
  1003  *
  1004  *  \param window The window to set hit-testing on.
  1005  *  \param callback The callback to call when doing a hit-test.
  1006  *  \param callback_data An app-defined void pointer passed to the callback.
  1007  *  \return 0 on success, -1 on error (including unsupported).
  1008  */
  1009 extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window,
  1010                                                  SDL_HitTest callback,
  1011                                                  void *callback_data);
  1012 
  1013 /**
  1014  *  \brief Destroy a window.
  1015  */
  1016 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
  1017 
  1018 
  1019 /**
  1020  *  \brief Returns whether the screensaver is currently enabled (default off).
  1021  *
  1022  *  \sa SDL_EnableScreenSaver()
  1023  *  \sa SDL_DisableScreenSaver()
  1024  */
  1025 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
  1026 
  1027 /**
  1028  *  \brief Allow the screen to be blanked by a screensaver
  1029  *
  1030  *  \sa SDL_IsScreenSaverEnabled()
  1031  *  \sa SDL_DisableScreenSaver()
  1032  */
  1033 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
  1034 
  1035 /**
  1036  *  \brief Prevent the screen from being blanked by a screensaver
  1037  *
  1038  *  \sa SDL_IsScreenSaverEnabled()
  1039  *  \sa SDL_EnableScreenSaver()
  1040  */
  1041 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
  1042 
  1043 
  1044 /**
  1045  *  \name OpenGL support functions
  1046  */
  1047 /* @{ */
  1048 
  1049 /**
  1050  *  \brief Dynamically load an OpenGL library.
  1051  *
  1052  *  \param path The platform dependent OpenGL library name, or NULL to open the
  1053  *              default OpenGL library.
  1054  *
  1055  *  \return 0 on success, or -1 if the library couldn't be loaded.
  1056  *
  1057  *  This should be done after initializing the video driver, but before
  1058  *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
  1059  *  library will be loaded upon creation of the first OpenGL window.
  1060  *
  1061  *  \note If you do this, you need to retrieve all of the GL functions used in
  1062  *        your program from the dynamic library using SDL_GL_GetProcAddress().
  1063  *
  1064  *  \sa SDL_GL_GetProcAddress()
  1065  *  \sa SDL_GL_UnloadLibrary()
  1066  */
  1067 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
  1068 
  1069 /**
  1070  *  \brief Get the address of an OpenGL function.
  1071  */
  1072 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
  1073 
  1074 /**
  1075  *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
  1076  *
  1077  *  \sa SDL_GL_LoadLibrary()
  1078  */
  1079 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
  1080 
  1081 /**
  1082  *  \brief Return true if an OpenGL extension is supported for the current
  1083  *         context.
  1084  */
  1085 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
  1086                                                            *extension);
  1087 
  1088 /**
  1089  *  \brief Reset all previously set OpenGL context attributes to their default values
  1090  */
  1091 extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
  1092 
  1093 /**
  1094  *  \brief Set an OpenGL window attribute before window creation.
  1095  */
  1096 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
  1097 
  1098 /**
  1099  *  \brief Get the actual value for an attribute from the current context.
  1100  */
  1101 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
  1102 
  1103 /**
  1104  *  \brief Create an OpenGL context for use with an OpenGL window, and make it
  1105  *         current.
  1106  *
  1107  *  \sa SDL_GL_DeleteContext()
  1108  */
  1109 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
  1110                                                            window);
  1111 
  1112 /**
  1113  *  \brief Set up an OpenGL context for rendering into an OpenGL window.
  1114  *
  1115  *  \note The context must have been created with a compatible window.
  1116  */
  1117 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
  1118                                                SDL_GLContext context);
  1119 
  1120 /**
  1121  *  \brief Get the currently active OpenGL window.
  1122  */
  1123 extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void);
  1124 
  1125 /**
  1126  *  \brief Get the currently active OpenGL context.
  1127  */
  1128 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
  1129 
  1130 /**
  1131  *  \brief Get the size of a window's underlying drawable in pixels (for use
  1132  *         with glViewport).
  1133  *
  1134  *  \param window   Window from which the drawable size should be queried
  1135  *  \param w        Pointer to variable for storing the width in pixels, may be NULL
  1136  *  \param h        Pointer to variable for storing the height in pixels, may be NULL
  1137  *
  1138  * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
  1139  * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a
  1140  * platform with high-DPI support (Apple calls this "Retina"), and not disabled
  1141  * by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.
  1142  *
  1143  *  \sa SDL_GetWindowSize()
  1144  *  \sa SDL_CreateWindow()
  1145  */
  1146 extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w,
  1147                                                     int *h);
  1148 
  1149 /**
  1150  *  \brief Set the swap interval for the current OpenGL context.
  1151  *
  1152  *  \param interval 0 for immediate updates, 1 for updates synchronized with the
  1153  *                  vertical retrace. If the system supports it, you may
  1154  *                  specify -1 to allow late swaps to happen immediately
  1155  *                  instead of waiting for the next retrace.
  1156  *
  1157  *  \return 0 on success, or -1 if setting the swap interval is not supported.
  1158  *
  1159  *  \sa SDL_GL_GetSwapInterval()
  1160  */
  1161 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
  1162 
  1163 /**
  1164  *  \brief Get the swap interval for the current OpenGL context.
  1165  *
  1166  *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer
  1167  *          swap is synchronized with the vertical retrace, and -1 if late
  1168  *          swaps happen immediately instead of waiting for the next retrace.
  1169  *          If the system can't determine the swap interval, or there isn't a
  1170  *          valid current context, this will return 0 as a safe default.
  1171  *
  1172  *  \sa SDL_GL_SetSwapInterval()
  1173  */
  1174 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
  1175 
  1176 /**
  1177  * \brief Swap the OpenGL buffers for a window, if double-buffering is
  1178  *        supported.
  1179  */
  1180 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
  1181 
  1182 /**
  1183  *  \brief Delete an OpenGL context.
  1184  *
  1185  *  \sa SDL_GL_CreateContext()
  1186  */
  1187 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
  1188 
  1189 /* @} *//* OpenGL support functions */
  1190 
  1191 
  1192 /* Ends C function definitions when using C++ */
  1193 #ifdef __cplusplus
  1194 }
  1195 #endif
  1196 #include "close_code.h"
  1197 
  1198 #endif /* _SDL_video_h */
  1199 
  1200 /* vi: set ts=4 sw=4 expandtab: */