include/SDL_video.h
author Ryan C. Gordon <icculus@icculus.org>
Tue, 21 Apr 2015 09:45:58 -0400
changeset 10027 f7ab0613164a
parent 10026 5f73f513b9f5
child 10028 da668b612d10
permissions -rw-r--r--
Added SDL_SetWindowModalFor().

This is currently only implemented for X11.

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