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