include/SDL_video.h
author Ryan C. Gordon <icculus@icculus.org>
Thu, 24 Aug 2017 21:30:53 -0400
changeset 11346 4d2bf1b340cd
parent 11332 e3797888c6f1
child 11365 a9bd2625fa01
permissions -rw-r--r--
opengl: add support for GL_KHR_no_error.

This is completely untested!

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