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