include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 16 May 2017 06:30:39 -0700
changeset 11006 40ff26e5a853
parent 10737 3406a0f8b041
child 11065 9e8d300d50da
permissions -rw-r--r--
SDL - add SDL_WINDOW_VULKAN and make Android_CreateWindow only create an EGLSurface when SDL_WINDOW_VULKAN is not present. This makes it so the ANativeWindow* can be used with vkCreateAndroidSurfaceKHR, otherwise it will fail because having both an EGLSurface and VkSurfaceKHR attached to a window is not allowed according to the Vulkan spec:

"In particular, only one VkSurfaceKHR can exist at a time for a given window. Similarly, a native window cannot be used by both a VkSurfaceKHR and EGLSurface simultaneously"

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