packages/sdl2.nuget.2.0.22/build/native/include/SDL_video.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2022 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_FlashWindow()
  69  *  \sa SDL_GetWindowData()
  70  *  \sa SDL_GetWindowFlags()
  71  *  \sa SDL_GetWindowGrab()
  72  *  \sa SDL_GetWindowKeyboardGrab()
  73  *  \sa SDL_GetWindowMouseGrab()
  74  *  \sa SDL_GetWindowPosition()
  75  *  \sa SDL_GetWindowSize()
  76  *  \sa SDL_GetWindowTitle()
  77  *  \sa SDL_HideWindow()
  78  *  \sa SDL_MaximizeWindow()
  79  *  \sa SDL_MinimizeWindow()
  80  *  \sa SDL_RaiseWindow()
  81  *  \sa SDL_RestoreWindow()
  82  *  \sa SDL_SetWindowData()
  83  *  \sa SDL_SetWindowFullscreen()
  84  *  \sa SDL_SetWindowGrab()
  85  *  \sa SDL_SetWindowKeyboardGrab()
  86  *  \sa SDL_SetWindowMouseGrab()
  87  *  \sa SDL_SetWindowIcon()
  88  *  \sa SDL_SetWindowPosition()
  89  *  \sa SDL_SetWindowSize()
  90  *  \sa SDL_SetWindowBordered()
  91  *  \sa SDL_SetWindowResizable()
  92  *  \sa SDL_SetWindowTitle()
  93  *  \sa SDL_ShowWindow()
  94  */
  95 typedef struct SDL_Window SDL_Window;
  96
  97 /**
  98  *  \brief The flags on a window
  99  *
 100  *  \sa SDL_GetWindowFlags()
 101  */
 102 typedef enum
 103 {
 104     SDL_WINDOW_FULLSCREEN = 0x00000001,         /**< fullscreen window */
 105     SDL_WINDOW_OPENGL = 0x00000002,             /**< window usable with OpenGL context */
 106     SDL_WINDOW_SHOWN = 0x00000004,              /**< window is visible */
 107     SDL_WINDOW_HIDDEN = 0x00000008,             /**< window is not visible */
 108     SDL_WINDOW_BORDERLESS = 0x00000010,         /**< no window decoration */
 109     SDL_WINDOW_RESIZABLE = 0x00000020,          /**< window can be resized */
 110     SDL_WINDOW_MINIMIZED = 0x00000040,          /**< window is minimized */
 111     SDL_WINDOW_MAXIMIZED = 0x00000080,          /**< window is maximized */
 112     SDL_WINDOW_MOUSE_GRABBED = 0x00000100,      /**< window has grabbed mouse input */
 113     SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */
 114     SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
 115     SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
 116     SDL_WINDOW_FOREIGN = 0x00000800,            /**< window not created by SDL */
 117     SDL_WINDOW_ALLOW_HIGHDPI = 0x00002000,      /**< window should be created in high-DPI mode if supported.
 118                                                      On macOS NSHighResolutionCapable must be set true in the
 119                                                      application's Info.plist for this to have any effect. */
 120     SDL_WINDOW_MOUSE_CAPTURE    = 0x00004000,   /**< window has mouse captured (unrelated to MOUSE_GRABBED) */
 121     SDL_WINDOW_ALWAYS_ON_TOP    = 0x00008000,   /**< window should always be above others */
 122     SDL_WINDOW_SKIP_TASKBAR     = 0x00010000,   /**< window should not be added to the taskbar */
 123     SDL_WINDOW_UTILITY          = 0x00020000,   /**< window should be treated as a utility window */
 124     SDL_WINDOW_TOOLTIP          = 0x00040000,   /**< window should be treated as a tooltip */
 125     SDL_WINDOW_POPUP_MENU       = 0x00080000,   /**< window should be treated as a popup menu */
 126     SDL_WINDOW_KEYBOARD_GRABBED = 0x00100000,   /**< window has grabbed keyboard input */
 127     SDL_WINDOW_VULKAN           = 0x10000000,   /**< window usable for Vulkan surface */
 128     SDL_WINDOW_METAL            = 0x20000000,   /**< window usable for Metal view */
 129
 130     SDL_WINDOW_INPUT_GRABBED = SDL_WINDOW_MOUSE_GRABBED /**< equivalent to SDL_WINDOW_MOUSE_GRABBED for compatibility */
 131 } SDL_WindowFlags;
 132
 133 /**
 134  *  \brief Used to indicate that you don't care what the window position is.
 135  */
 136 #define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000u
 137 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
 138 #define SDL_WINDOWPOS_UNDEFINED         SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
 139 #define SDL_WINDOWPOS_ISUNDEFINED(X)    \
 140             (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
 141
 142 /**
 143  *  \brief Used to indicate that the window position should be centered.
 144  */
 145 #define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000u
 146 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))
 147 #define SDL_WINDOWPOS_CENTERED         SDL_WINDOWPOS_CENTERED_DISPLAY(0)
 148 #define SDL_WINDOWPOS_ISCENTERED(X)    \
 149             (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
 150
 151 /**
 152  *  \brief Event subtype for window events
 153  */
 154 typedef enum
 155 {
 156     SDL_WINDOWEVENT_NONE,           /**< Never used */
 157     SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
 158     SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
 159     SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be
 160                                          redrawn */
 161     SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2
 162                                      */
 163     SDL_WINDOWEVENT_RESIZED,        /**< Window has been resized to data1xdata2 */
 164     SDL_WINDOWEVENT_SIZE_CHANGED,   /**< The window size has changed, either as
 165                                          a result of an API call or through the
 166                                          system or user changing the window size. */
 167     SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
 168     SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
 169     SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
 170                                          and position */
 171     SDL_WINDOWEVENT_ENTER,          /**< Window has gained mouse focus */
 172     SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
 173     SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
 174     SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
 175     SDL_WINDOWEVENT_CLOSE,          /**< The window manager requests that the window be closed */
 176     SDL_WINDOWEVENT_TAKE_FOCUS,     /**< Window is being offered a focus (should SetWindowInputFocus() on itself or a subwindow, or ignore) */
 177     SDL_WINDOWEVENT_HIT_TEST,       /**< Window had a hit test that wasn't SDL_HITTEST_NORMAL. */
 178     SDL_WINDOWEVENT_ICCPROF_CHANGED,/**< The ICC profile of the window's display has changed. */
 179     SDL_WINDOWEVENT_DISPLAY_CHANGED /**< Window has been moved to display data1. */
 180 } SDL_WindowEventID;
 181
 182 /**
 183  *  \brief Event subtype for display events
 184  */
 185 typedef enum
 186 {
 187     SDL_DISPLAYEVENT_NONE,          /**< Never used */
 188     SDL_DISPLAYEVENT_ORIENTATION,   /**< Display orientation has changed to data1 */
 189     SDL_DISPLAYEVENT_CONNECTED,     /**< Display has been added to the system */
 190     SDL_DISPLAYEVENT_DISCONNECTED   /**< Display has been removed from the system */
 191 } SDL_DisplayEventID;
 192
 193 /**
 194  *  \brief Display orientation
 195  */
 196 typedef enum
 197 {
 198     SDL_ORIENTATION_UNKNOWN,            /**< The display orientation can't be determined */
 199     SDL_ORIENTATION_LANDSCAPE,          /**< The display is in landscape mode, with the right side up, relative to portrait mode */
 200     SDL_ORIENTATION_LANDSCAPE_FLIPPED,  /**< The display is in landscape mode, with the left side up, relative to portrait mode */
 201     SDL_ORIENTATION_PORTRAIT,           /**< The display is in portrait mode */
 202     SDL_ORIENTATION_PORTRAIT_FLIPPED    /**< The display is in portrait mode, upside down */
 203 } SDL_DisplayOrientation;
 204
 205 /**
 206  *  \brief Window flash operation
 207  */
 208 typedef enum
 209 {
 210     SDL_FLASH_CANCEL,                   /**< Cancel any window flash state */
 211     SDL_FLASH_BRIEFLY,                  /**< Flash the window briefly to get attention */
 212     SDL_FLASH_UNTIL_FOCUSED             /**< Flash the window until it gets focus */
 213 } SDL_FlashOperation;
 214
 215 /**
 216  *  \brief An opaque handle to an OpenGL context.
 217  */
 218 typedef void *SDL_GLContext;
 219
 220 /**
 221  *  \brief OpenGL configuration attributes
 222  */
 223 typedef enum
 224 {
 225     SDL_GL_RED_SIZE,
 226     SDL_GL_GREEN_SIZE,
 227     SDL_GL_BLUE_SIZE,
 228     SDL_GL_ALPHA_SIZE,
 229     SDL_GL_BUFFER_SIZE,
 230     SDL_GL_DOUBLEBUFFER,
 231     SDL_GL_DEPTH_SIZE,
 232     SDL_GL_STENCIL_SIZE,
 233     SDL_GL_ACCUM_RED_SIZE,
 234     SDL_GL_ACCUM_GREEN_SIZE,
 235     SDL_GL_ACCUM_BLUE_SIZE,
 236     SDL_GL_ACCUM_ALPHA_SIZE,
 237     SDL_GL_STEREO,
 238     SDL_GL_MULTISAMPLEBUFFERS,
 239     SDL_GL_MULTISAMPLESAMPLES,
 240     SDL_GL_ACCELERATED_VISUAL,
 241     SDL_GL_RETAINED_BACKING,
 242     SDL_GL_CONTEXT_MAJOR_VERSION,
 243     SDL_GL_CONTEXT_MINOR_VERSION,
 244     SDL_GL_CONTEXT_EGL,
 245     SDL_GL_CONTEXT_FLAGS,
 246     SDL_GL_CONTEXT_PROFILE_MASK,
 247     SDL_GL_SHARE_WITH_CURRENT_CONTEXT,
 248     SDL_GL_FRAMEBUFFER_SRGB_CAPABLE,
 249     SDL_GL_CONTEXT_RELEASE_BEHAVIOR,
 250     SDL_GL_CONTEXT_RESET_NOTIFICATION,
 251     SDL_GL_CONTEXT_NO_ERROR
 252 } SDL_GLattr;
 253
 254 typedef enum
 255 {
 256     SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
 257     SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
 258     SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
 259 } SDL_GLprofile;
 260
 261 typedef enum
 262 {
 263     SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
 264     SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
 265     SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,
 266     SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008
 267 } SDL_GLcontextFlag;
 268
 269 typedef enum
 270 {
 271     SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE   = 0x0000,
 272     SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH  = 0x0001
 273 } SDL_GLcontextReleaseFlag;
 274
 275 typedef enum
 276 {
 277     SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000,
 278     SDL_GL_CONTEXT_RESET_LOSE_CONTEXT    = 0x0001
 279 } SDL_GLContextResetNotification;
 280
 281 /* Function prototypes */
 282
 283 /**
 284  * Get the number of video drivers compiled into SDL.
 285  *
 286  * \returns a number >= 1 on success or a negative error code on failure; call
 287  *          SDL_GetError() for more information.
 288  *
 289  * \since This function is available since SDL 2.0.0.
 290  *
 291  * \sa SDL_GetVideoDriver
 292  */
 293 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
 294
 295 /**
 296  * Get the name of a built in video driver.
 297  *
 298  * The video drivers are presented in the order in which they are normally
 299  * checked during initialization.
 300  *
 301  * \param index the index of a video driver
 302  * \returns the name of the video driver with the given **index**.
 303  *
 304  * \since This function is available since SDL 2.0.0.
 305  *
 306  * \sa SDL_GetNumVideoDrivers
 307  */
 308 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
 309
 310 /**
 311  * Initialize the video subsystem, optionally specifying a video driver.
 312  *
 313  * This function initializes the video subsystem, setting up a connection to
 314  * the window manager, etc, and determines the available display modes and
 315  * pixel formats, but does not initialize a window or graphics mode.
 316  *
 317  * If you use this function and you haven't used the SDL_INIT_VIDEO flag with
 318  * either SDL_Init() or SDL_InitSubSystem(), you should call SDL_VideoQuit()
 319  * before calling SDL_Quit().
 320  *
 321  * It is safe to call this function multiple times. SDL_VideoInit() will call
 322  * SDL_VideoQuit() itself if the video subsystem has already been initialized.
 323  *
 324  * You can use SDL_GetNumVideoDrivers() and SDL_GetVideoDriver() to find a
 325  * specific `driver_name`.
 326  *
 327  * \param driver_name the name of a video driver to initialize, or NULL for
 328  *                    the default driver
 329  * \returns 0 on success or a negative error code on failure; call
 330  *          SDL_GetError() for more information.
 331  *
 332  * \since This function is available since SDL 2.0.0.
 333  *
 334  * \sa SDL_GetNumVideoDrivers
 335  * \sa SDL_GetVideoDriver
 336  * \sa SDL_InitSubSystem
 337  * \sa SDL_VideoQuit
 338  */
 339 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
 340
 341 /**
 342  * Shut down the video subsystem, if initialized with SDL_VideoInit().
 343  *
 344  * This function closes all windows, and restores the original video mode.
 345  *
 346  * \since This function is available since SDL 2.0.0.
 347  *
 348  * \sa SDL_VideoInit
 349  */
 350 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
 351
 352 /**
 353  * Get the name of the currently initialized video driver.
 354  *
 355  * \returns the name of the current video driver or NULL if no driver has been
 356  *          initialized.
 357  *
 358  * \since This function is available since SDL 2.0.0.
 359  *
 360  * \sa SDL_GetNumVideoDrivers
 361  * \sa SDL_GetVideoDriver
 362  */
 363 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
 364
 365 /**
 366  * Get the number of available video displays.
 367  *
 368  * \returns a number >= 1 or a negative error code on failure; call
 369  *          SDL_GetError() for more information.
 370  *
 371  * \since This function is available since SDL 2.0.0.
 372  *
 373  * \sa SDL_GetDisplayBounds
 374  */
 375 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
 376
 377 /**
 378  * Get the name of a display in UTF-8 encoding.
 379  *
 380  * \param displayIndex the index of display from which the name should be
 381  *                     queried
 382  * \returns the name of a display or NULL for an invalid display index or
 383  *          failure; call SDL_GetError() for more information.
 384  *
 385  * \since This function is available since SDL 2.0.0.
 386  *
 387  * \sa SDL_GetNumVideoDisplays
 388  */
 389 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
 390
 391 /**
 392  * Get the desktop area represented by a display.
 393  *
 394  * The primary display (`displayIndex` zero) is always located at 0,0.
 395  *
 396  * \param displayIndex the index of the display to query
 397  * \param rect the SDL_Rect structure filled in with the display bounds
 398  * \returns 0 on success or a negative error code on failure; call
 399  *          SDL_GetError() for more information.
 400  *
 401  * \since This function is available since SDL 2.0.0.
 402  *
 403  * \sa SDL_GetNumVideoDisplays
 404  */
 405 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
 406
 407 /**
 408  * Get the usable desktop area represented by a display.
 409  *
 410  * The primary display (`displayIndex` zero) is always located at 0,0.
 411  *
 412  * This is the same area as SDL_GetDisplayBounds() reports, but with portions
 413  * reserved by the system removed. For example, on Apple's macOS, this
 414  * subtracts the area occupied by the menu bar and dock.
 415  *
 416  * Setting a window to be fullscreen generally bypasses these unusable areas,
 417  * so these are good guidelines for the maximum space available to a
 418  * non-fullscreen window.
 419  *
 420  * The parameter `rect` is ignored if it is NULL.
 421  *
 422  * This function also returns -1 if the parameter `displayIndex` is out of
 423  * range.
 424  *
 425  * \param displayIndex the index of the display to query the usable bounds
 426  *                     from
 427  * \param rect the SDL_Rect structure filled in with the display bounds
 428  * \returns 0 on success or a negative error code on failure; call
 429  *          SDL_GetError() for more information.
 430  *
 431  * \since This function is available since SDL 2.0.5.
 432  *
 433  * \sa SDL_GetDisplayBounds
 434  * \sa SDL_GetNumVideoDisplays
 435  */
 436 extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect);
 437
 438 /**
 439  * Get the dots/pixels-per-inch for a display.
 440  *
 441  * Diagonal, horizontal and vertical DPI can all be optionally returned if the
 442  * appropriate parameter is non-NULL.
 443  *
 444  * A failure of this function usually means that either no DPI information is
 445  * available or the `displayIndex` is out of range.
 446  *
 447  * \param displayIndex the index of the display from which DPI information
 448  *                     should be queried
 449  * \param ddpi a pointer filled in with the diagonal DPI of the display; may
 450  *             be NULL
 451  * \param hdpi a pointer filled in with the horizontal DPI of the display; may
 452  *             be NULL
 453  * \param vdpi a pointer filled in with the vertical DPI of the display; may
 454  *             be NULL
 455  * \returns 0 on success or a negative error code on failure; call
 456  *          SDL_GetError() for more information.
 457  *
 458  * \since This function is available since SDL 2.0.4.
 459  *
 460  * \sa SDL_GetNumVideoDisplays
 461  */
 462 extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, float * hdpi, float * vdpi);
 463
 464 /**
 465  * Get the orientation of a display.
 466  *
 467  * \param displayIndex the index of the display to query
 468  * \returns The SDL_DisplayOrientation enum value of the display, or
 469  *          `SDL_ORIENTATION_UNKNOWN` if it isn't available.
 470  *
 471  * \since This function is available since SDL 2.0.9.
 472  *
 473  * \sa SDL_GetNumVideoDisplays
 474  */
 475 extern DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetDisplayOrientation(int displayIndex);
 476
 477 /**
 478  * Get the number of available display modes.
 479  *
 480  * The `displayIndex` needs to be in the range from 0 to
 481  * SDL_GetNumVideoDisplays() - 1.
 482  *
 483  * \param displayIndex the index of the display to query
 484  * \returns a number >= 1 on success or a negative error code on failure; call
 485  *          SDL_GetError() for more information.
 486  *
 487  * \since This function is available since SDL 2.0.0.
 488  *
 489  * \sa SDL_GetDisplayMode
 490  * \sa SDL_GetNumVideoDisplays
 491  */
 492 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
 493
 494 /**
 495  * Get information about a specific display mode.
 496  *
 497  * The display modes are sorted in this priority:
 498  *
 499  * - width -> largest to smallest
 500  * - height -> largest to smallest
 501  * - bits per pixel -> more colors to fewer colors
 502  * - packed pixel layout -> largest to smallest
 503  * - refresh rate -> highest to lowest
 504  *
 505  * \param displayIndex the index of the display to query
 506  * \param modeIndex the index of the display mode to query
 507  * \param mode an SDL_DisplayMode structure filled in with the mode at
 508  *             `modeIndex`
 509  * \returns 0 on success or a negative error code on failure; call
 510  *          SDL_GetError() for more information.
 511  *
 512  * \since This function is available since SDL 2.0.0.
 513  *
 514  * \sa SDL_GetNumDisplayModes
 515  */
 516 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
 517                                                SDL_DisplayMode * mode);
 518
 519 /**
 520  * Get information about the desktop's display mode.
 521  *
 522  * There's a difference between this function and SDL_GetCurrentDisplayMode()
 523  * when SDL runs fullscreen and has changed the resolution. In that case this
 524  * function will return the previous native display mode, and not the current
 525  * display mode.
 526  *
 527  * \param displayIndex the index of the display to query
 528  * \param mode an SDL_DisplayMode structure filled in with the current display
 529  *             mode
 530  * \returns 0 on success or a negative error code on failure; call
 531  *          SDL_GetError() for more information.
 532  *
 533  * \since This function is available since SDL 2.0.0.
 534  *
 535  * \sa SDL_GetCurrentDisplayMode
 536  * \sa SDL_GetDisplayMode
 537  * \sa SDL_SetWindowDisplayMode
 538  */
 539 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
 540
 541 /**
 542  * Get information about the current display mode.
 543  *
 544  * There's a difference between this function and SDL_GetDesktopDisplayMode()
 545  * when SDL runs fullscreen and has changed the resolution. In that case this
 546  * function will return the current display mode, and not the previous native
 547  * display mode.
 548  *
 549  * \param displayIndex the index of the display to query
 550  * \param mode an SDL_DisplayMode structure filled in with the current display
 551  *             mode
 552  * \returns 0 on success or a negative error code on failure; call
 553  *          SDL_GetError() for more information.
 554  *
 555  * \since This function is available since SDL 2.0.0.
 556  *
 557  * \sa SDL_GetDesktopDisplayMode
 558  * \sa SDL_GetDisplayMode
 559  * \sa SDL_GetNumVideoDisplays
 560  * \sa SDL_SetWindowDisplayMode
 561  */
 562 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
 563
 564
 565 /**
 566  * Get the closest match to the requested display mode.
 567  *
 568  * The available display modes are scanned and `closest` is filled in with the
 569  * closest mode matching the requested mode and returned. The mode format and
 570  * refresh rate default to the desktop mode if they are set to 0. The modes
 571  * are scanned with size being first priority, format being second priority,
 572  * and finally checking the refresh rate. If all the available modes are too
 573  * small, then NULL is returned.
 574  *
 575  * \param displayIndex the index of the display to query
 576  * \param mode an SDL_DisplayMode structure containing the desired display
 577  *             mode
 578  * \param closest an SDL_DisplayMode structure filled in with the closest
 579  *                match of the available display modes
 580  * \returns the passed in value `closest` or NULL if no matching video mode
 581  *          was available; call SDL_GetError() for more information.
 582  *
 583  * \since This function is available since SDL 2.0.0.
 584  *
 585  * \sa SDL_GetDisplayMode
 586  * \sa SDL_GetNumDisplayModes
 587  */
 588 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
 589
 590 /**
 591  * Get the index of the display associated with a window.
 592  *
 593  * \param window the window to query
 594  * \returns the index of the display containing the center of the window on
 595  *          success or a negative error code on failure; call SDL_GetError()
 596  *          for more information.
 597  *
 598  * \since This function is available since SDL 2.0.0.
 599  *
 600  * \sa SDL_GetDisplayBounds
 601  * \sa SDL_GetNumVideoDisplays
 602  */
 603 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
 604
 605 /**
 606  * Set the display mode to use when a window is visible at fullscreen.
 607  *
 608  * This only affects the display mode used when the window is fullscreen. To
 609  * change the window size when the window is not fullscreen, use
 610  * SDL_SetWindowSize().
 611  *
 612  * \param window the window to affect
 613  * \param mode the SDL_DisplayMode structure representing the mode to use, or
 614  *             NULL to use the window's dimensions and the desktop's format
 615  *             and refresh rate
 616  * \returns 0 on success or a negative error code on failure; call
 617  *          SDL_GetError() for more information.
 618  *
 619  * \since This function is available since SDL 2.0.0.
 620  *
 621  * \sa SDL_GetWindowDisplayMode
 622  * \sa SDL_SetWindowFullscreen
 623  */
 624 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
 625                                                      const SDL_DisplayMode * mode);
 626
 627 /**
 628  * Query the display mode to use when a window is visible at fullscreen.
 629  *
 630  * \param window the window to query
 631  * \param mode an SDL_DisplayMode structure filled in with the fullscreen
 632  *             display mode
 633  * \returns 0 on success or a negative error code on failure; call
 634  *          SDL_GetError() for more information.
 635  *
 636  * \since This function is available since SDL 2.0.0.
 637  *
 638  * \sa SDL_SetWindowDisplayMode
 639  * \sa SDL_SetWindowFullscreen
 640  */
 641 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
 642                                                      SDL_DisplayMode * mode);
 643
 644 /**
 645  * Get the raw ICC profile data for the screen the window is currently on.
 646  *
 647  * Data returned should be freed with SDL_free.
 648  *
 649  * \param window the window to query
 650  * \param size the size of the ICC profile
 651  * \returns the raw ICC profile data on success or NULL on failure; call
 652  *          SDL_GetError() for more information.
 653  *
 654  * \since This function is available since SDL 2.0.18.
 655  */
 656 extern DECLSPEC void* SDLCALL SDL_GetWindowICCProfile(SDL_Window * window, size_t* size);
 657
 658 /**
 659  * Get the pixel format associated with the window.
 660  *
 661  * \param window the window to query
 662  * \returns the pixel format of the window on success or
 663  *          SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more
 664  *          information.
 665  *
 666  * \since This function is available since SDL 2.0.0.
 667  */
 668 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
 669
 670 /**
 671  * Create a window with the specified position, dimensions, and flags.
 672  *
 673  * `flags` may be any of the following OR'd together:
 674  *
 675  * - `SDL_WINDOW_FULLSCREEN`: fullscreen window
 676  * - `SDL_WINDOW_FULLSCREEN_DESKTOP`: fullscreen window at desktop resolution
 677  * - `SDL_WINDOW_OPENGL`: window usable with an OpenGL context
 678  * - `SDL_WINDOW_VULKAN`: window usable with a Vulkan instance
 679  * - `SDL_WINDOW_METAL`: window usable with a Metal instance
 680  * - `SDL_WINDOW_HIDDEN`: window is not visible
 681  * - `SDL_WINDOW_BORDERLESS`: no window decoration
 682  * - `SDL_WINDOW_RESIZABLE`: window can be resized
 683  * - `SDL_WINDOW_MINIMIZED`: window is minimized
 684  * - `SDL_WINDOW_MAXIMIZED`: window is maximized
 685  * - `SDL_WINDOW_INPUT_GRABBED`: window has grabbed input focus
 686  * - `SDL_WINDOW_ALLOW_HIGHDPI`: window should be created in high-DPI mode if
 687  *   supported (>= SDL 2.0.1)
 688  *
 689  * `SDL_WINDOW_SHOWN` is ignored by SDL_CreateWindow(). The SDL_Window is
 690  * implicitly shown if SDL_WINDOW_HIDDEN is not set. `SDL_WINDOW_SHOWN` may be
 691  * queried later using SDL_GetWindowFlags().
 692  *
 693  * On Apple's macOS, you **must** set the NSHighResolutionCapable Info.plist
 694  * property to YES, otherwise you will not receive a High-DPI OpenGL canvas.
 695  *
 696  * If the window is created with the `SDL_WINDOW_ALLOW_HIGHDPI` flag, its size
 697  * in pixels may differ from its size in screen coordinates on platforms with
 698  * high-DPI support (e.g. iOS and macOS). Use SDL_GetWindowSize() to query the
 699  * client area's size in screen coordinates, and SDL_GL_GetDrawableSize() or
 700  * SDL_GetRendererOutputSize() to query the drawable size in pixels.
 701  *
 702  * If the window is set fullscreen, the width and height parameters `w` and
 703  * `h` will not be used. However, invalid size parameters (e.g. too large) may
 704  * still fail. Window size is actually limited to 16384 x 16384 for all
 705  * platforms at window creation.
 706  *
 707  * If the window is created with any of the SDL_WINDOW_OPENGL or
 708  * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function
 709  * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the
 710  * corresponding UnloadLibrary function is called by SDL_DestroyWindow().
 711  *
 712  * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver,
 713  * SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.
 714  *
 715  * If SDL_WINDOW_METAL is specified on an OS that does not support Metal,
 716  * SDL_CreateWindow() will fail.
 717  *
 718  * On non-Apple devices, SDL requires you to either not link to the Vulkan
 719  * loader or link to a dynamic library version. This limitation may be removed
 720  * in a future version of SDL.
 721  *
 722  * \param title the title of the window, in UTF-8 encoding
 723  * \param x the x position of the window, `SDL_WINDOWPOS_CENTERED`, or
 724  *          `SDL_WINDOWPOS_UNDEFINED`
 725  * \param y the y position of the window, `SDL_WINDOWPOS_CENTERED`, or
 726  *          `SDL_WINDOWPOS_UNDEFINED`
 727  * \param w the width of the window, in screen coordinates
 728  * \param h the height of the window, in screen coordinates
 729  * \param flags 0, or one or more SDL_WindowFlags OR'd together
 730  * \returns the window that was created or NULL on failure; call
 731  *          SDL_GetError() for more information.
 732  *
 733  * \since This function is available since SDL 2.0.0.
 734  *
 735  * \sa SDL_CreateWindowFrom
 736  * \sa SDL_DestroyWindow
 737  */
 738 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
 739                                                       int x, int y, int w,
 740                                                       int h, Uint32 flags);
 741
 742 /**
 743  * Create an SDL window from an existing native window.
 744  *
 745  * In some cases (e.g. OpenGL) and on some platforms (e.g. Microsoft Windows)
 746  * the hint `SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT` needs to be configured
 747  * before using SDL_CreateWindowFrom().
 748  *
 749  * \param data a pointer to driver-dependent window creation data, typically
 750  *             your native window cast to a void*
 751  * \returns the window that was created or NULL on failure; call
 752  *          SDL_GetError() for more information.
 753  *
 754  * \since This function is available since SDL 2.0.0.
 755  *
 756  * \sa SDL_CreateWindow
 757  * \sa SDL_DestroyWindow
 758  */
 759 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
 760
 761 /**
 762  * Get the numeric ID of a window.
 763  *
 764  * The numeric ID is what SDL_WindowEvent references, and is necessary to map
 765  * these events to specific SDL_Window objects.
 766  *
 767  * \param window the window to query
 768  * \returns the ID of the window on success or 0 on failure; call
 769  *          SDL_GetError() for more information.
 770  *
 771  * \since This function is available since SDL 2.0.0.
 772  *
 773  * \sa SDL_GetWindowFromID
 774  */
 775 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
 776
 777 /**
 778  * Get a window from a stored ID.
 779  *
 780  * The numeric ID is what SDL_WindowEvent references, and is necessary to map
 781  * these events to specific SDL_Window objects.
 782  *
 783  * \param id the ID of the window
 784  * \returns the window associated with `id` or NULL if it doesn't exist; call
 785  *          SDL_GetError() for more information.
 786  *
 787  * \since This function is available since SDL 2.0.0.
 788  *
 789  * \sa SDL_GetWindowID
 790  */
 791 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
 792
 793 /**
 794  * Get the window flags.
 795  *
 796  * \param window the window to query
 797  * \returns a mask of the SDL_WindowFlags associated with `window`
 798  *
 799  * \since This function is available since SDL 2.0.0.
 800  *
 801  * \sa SDL_CreateWindow
 802  * \sa SDL_HideWindow
 803  * \sa SDL_MaximizeWindow
 804  * \sa SDL_MinimizeWindow
 805  * \sa SDL_SetWindowFullscreen
 806  * \sa SDL_SetWindowGrab
 807  * \sa SDL_ShowWindow
 808  */
 809 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
 810
 811 /**
 812  * Set the title of a window.
 813  *
 814  * This string is expected to be in UTF-8 encoding.
 815  *
 816  * \param window the window to change
 817  * \param title the desired window title in UTF-8 format
 818  *
 819  * \since This function is available since SDL 2.0.0.
 820  *
 821  * \sa SDL_GetWindowTitle
 822  */
 823 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
 824                                                 const char *title);
 825
 826 /**
 827  * Get the title of a window.
 828  *
 829  * \param window the window to query
 830  * \returns the title of the window in UTF-8 format or "" if there is no
 831  *          title.
 832  *
 833  * \since This function is available since SDL 2.0.0.
 834  *
 835  * \sa SDL_SetWindowTitle
 836  */
 837 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
 838
 839 /**
 840  * Set the icon for a window.
 841  *
 842  * \param window the window to change
 843  * \param icon an SDL_Surface structure containing the icon for the window
 844  *
 845  * \since This function is available since SDL 2.0.0.
 846  */
 847 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
 848                                                SDL_Surface * icon);
 849
 850 /**
 851  * Associate an arbitrary named pointer with a window.
 852  *
 853  * `name` is case-sensitive.
 854  *
 855  * \param window the window to associate with the pointer
 856  * \param name the name of the pointer
 857  * \param userdata the associated pointer
 858  * \returns the previous value associated with `name`.
 859  *
 860  * \since This function is available since SDL 2.0.0.
 861  *
 862  * \sa SDL_GetWindowData
 863  */
 864 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
 865                                                 const char *name,
 866                                                 void *userdata);
 867
 868 /**
 869  * Retrieve the data pointer associated with a window.
 870  *
 871  * \param window the window to query
 872  * \param name the name of the pointer
 873  * \returns the value associated with `name`.
 874  *
 875  * \since This function is available since SDL 2.0.0.
 876  *
 877  * \sa SDL_SetWindowData
 878  */
 879 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
 880                                                 const char *name);
 881
 882 /**
 883  * Set the position of a window.
 884  *
 885  * The window coordinate origin is the upper left of the display.
 886  *
 887  * \param window the window to reposition
 888  * \param x the x coordinate of the window in screen coordinates, or
 889  *          `SDL_WINDOWPOS_CENTERED` or `SDL_WINDOWPOS_UNDEFINED`
 890  * \param y the y coordinate of the window in screen coordinates, or
 891  *          `SDL_WINDOWPOS_CENTERED` or `SDL_WINDOWPOS_UNDEFINED`
 892  *
 893  * \since This function is available since SDL 2.0.0.
 894  *
 895  * \sa SDL_GetWindowPosition
 896  */
 897 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
 898                                                    int x, int y);
 899
 900 /**
 901  * Get the position of a window.
 902  *
 903  * If you do not need the value for one of the positions a NULL may be passed
 904  * in the `x` or `y` parameter.
 905  *
 906  * \param window the window to query
 907  * \param x a pointer filled in with the x position of the window, in screen
 908  *          coordinates, may be NULL
 909  * \param y a pointer filled in with the y position of the window, in screen
 910  *          coordinates, may be NULL
 911  *
 912  * \since This function is available since SDL 2.0.0.
 913  *
 914  * \sa SDL_SetWindowPosition
 915  */
 916 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
 917                                                    int *x, int *y);
 918
 919 /**
 920  * Set the size of a window's client area.
 921  *
 922  * The window size in screen coordinates may differ from the size in pixels,
 923  * if the window was created with `SDL_WINDOW_ALLOW_HIGHDPI` on a platform
 924  * with high-dpi support (e.g. iOS or macOS). Use SDL_GL_GetDrawableSize() or
 925  * SDL_GetRendererOutputSize() to get the real client area size in pixels.
 926  *
 927  * Fullscreen windows automatically match the size of the display mode, and
 928  * you should use SDL_SetWindowDisplayMode() to change their size.
 929  *
 930  * \param window the window to change
 931  * \param w the width of the window in pixels, in screen coordinates, must be
 932  *          > 0
 933  * \param h the height of the window in pixels, in screen coordinates, must be
 934  *          > 0
 935  *
 936  * \since This function is available since SDL 2.0.0.
 937  *
 938  * \sa SDL_GetWindowSize
 939  * \sa SDL_SetWindowDisplayMode
 940  */
 941 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
 942                                                int h);
 943
 944 /**
 945  * Get the size of a window's client area.
 946  *
 947  * NULL can safely be passed as the `w` or `h` parameter if the width or
 948  * height value is not desired.
 949  *
 950  * The window size in screen coordinates may differ from the size in pixels,
 951  * if the window was created with `SDL_WINDOW_ALLOW_HIGHDPI` on a platform
 952  * with high-dpi support (e.g. iOS or macOS). Use SDL_GL_GetDrawableSize(),
 953  * SDL_Vulkan_GetDrawableSize(), or SDL_GetRendererOutputSize() to get the
 954  * real client area size in pixels.
 955  *
 956  * \param window the window to query the width and height from
 957  * \param w a pointer filled in with the width of the window, in screen
 958  *          coordinates, may be NULL
 959  * \param h a pointer filled in with the height of the window, in screen
 960  *          coordinates, may be NULL
 961  *
 962  * \since This function is available since SDL 2.0.0.
 963  *
 964  * \sa SDL_GL_GetDrawableSize
 965  * \sa SDL_Vulkan_GetDrawableSize
 966  * \sa SDL_SetWindowSize
 967  */
 968 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
 969                                                int *h);
 970
 971 /**
 972  * Get the size of a window's borders (decorations) around the client area.
 973  *
 974  * Note: If this function fails (returns -1), the size values will be
 975  * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the
 976  * window in question was borderless.
 977  *
 978  * Note: This function may fail on systems where the window has not yet been
 979  * decorated by the display server (for example, immediately after calling
 980  * SDL_CreateWindow). It is recommended that you wait at least until the
 981  * window has been presented and composited, so that the window system has a
 982  * chance to decorate the window and provide the border dimensions to SDL.
 983  *
 984  * This function also returns -1 if getting the information is not supported.
 985  *
 986  * \param window the window to query the size values of the border
 987  *               (decorations) from
 988  * \param top pointer to variable for storing the size of the top border; NULL
 989  *            is permitted
 990  * \param left pointer to variable for storing the size of the left border;
 991  *             NULL is permitted
 992  * \param bottom pointer to variable for storing the size of the bottom
 993  *               border; NULL is permitted
 994  * \param right pointer to variable for storing the size of the right border;
 995  *              NULL is permitted
 996  * \returns 0 on success or a negative error code on failure; call
 997  *          SDL_GetError() for more information.
 998  *
 999  * \since This function is available since SDL 2.0.5.
1000  *
1001  * \sa SDL_GetWindowSize
1002  */
1003 extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window * window,
1004                                                      int *top, int *left,
1005                                                      int *bottom, int *right);
1006
1007 /**
1008  * Set the minimum size of a window's client area.
1009  *
1010  * \param window the window to change
1011  * \param min_w the minimum width of the window in pixels
1012  * \param min_h the minimum height of the window in pixels
1013  *
1014  * \since This function is available since SDL 2.0.0.
1015  *
1016  * \sa SDL_GetWindowMinimumSize
1017  * \sa SDL_SetWindowMaximumSize
1018  */
1019 extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
1020                                                       int min_w, int min_h);
1021
1022 /**
1023  * Get the minimum size of a window's client area.
1024  *
1025  * \param window the window to query
1026  * \param w a pointer filled in with the minimum width of the window, may be
1027  *          NULL
1028  * \param h a pointer filled in with the minimum height of the window, may be
1029  *          NULL
1030  *
1031  * \since This function is available since SDL 2.0.0.
1032  *
1033  * \sa SDL_GetWindowMaximumSize
1034  * \sa SDL_SetWindowMinimumSize
1035  */
1036 extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
1037                                                       int *w, int *h);
1038
1039 /**
1040  * Set the maximum size of a window's client area.
1041  *
1042  * \param window the window to change
1043  * \param max_w the maximum width of the window in pixels
1044  * \param max_h the maximum height of the window in pixels
1045  *
1046  * \since This function is available since SDL 2.0.0.
1047  *
1048  * \sa SDL_GetWindowMaximumSize
1049  * \sa SDL_SetWindowMinimumSize
1050  */
1051 extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
1052                                                       int max_w, int max_h);
1053
1054 /**
1055  * Get the maximum size of a window's client area.
1056  *
1057  * \param window the window to query
1058  * \param w a pointer filled in with the maximum width of the window, may be
1059  *          NULL
1060  * \param h a pointer filled in with the maximum height of the window, may be
1061  *          NULL
1062  *
1063  * \since This function is available since SDL 2.0.0.
1064  *
1065  * \sa SDL_GetWindowMinimumSize
1066  * \sa SDL_SetWindowMaximumSize
1067  */
1068 extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
1069                                                       int *w, int *h);
1070
1071 /**
1072  * Set the border state of a window.
1073  *
1074  * This will add or remove the window's `SDL_WINDOW_BORDERLESS` flag and add
1075  * or remove the border from the actual window. This is a no-op if the
1076  * window's border already matches the requested state.
1077  *
1078  * You can't change the border state of a fullscreen window.
1079  *
1080  * \param window the window of which to change the border state
1081  * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border
1082  *
1083  * \since This function is available since SDL 2.0.0.
1084  *
1085  * \sa SDL_GetWindowFlags
1086  */
1087 extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
1088                                                    SDL_bool bordered);
1089
1090 /**
1091  * Set the user-resizable state of a window.
1092  *
1093  * This will add or remove the window's `SDL_WINDOW_RESIZABLE` flag and
1094  * allow/disallow user resizing of the window. This is a no-op if the window's
1095  * resizable state already matches the requested state.
1096  *
1097  * You can't change the resizable state of a fullscreen window.
1098  *
1099  * \param window the window of which to change the resizable state
1100  * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow
1101  *
1102  * \since This function is available since SDL 2.0.5.
1103  *
1104  * \sa SDL_GetWindowFlags
1105  */
1106 extern DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window * window,
1107                                                     SDL_bool resizable);
1108
1109 /**
1110  * Set the window to always be above the others.
1111  *
1112  * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This
1113  * will bring the window to the front and keep the window above the rest.
1114  *
1115  * \param window The window of which to change the always on top state
1116  * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to
1117  *               disable
1118  *
1119  * \since This function is available since SDL 2.0.16.
1120  *
1121  * \sa SDL_GetWindowFlags
1122  */
1123 extern DECLSPEC void SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window * window,
1124                                                       SDL_bool on_top);
1125
1126 /**
1127  * Show a window.
1128  *
1129  * \param window the window to show
1130  *
1131  * \since This function is available since SDL 2.0.0.
1132  *
1133  * \sa SDL_HideWindow
1134  * \sa SDL_RaiseWindow
1135  */
1136 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
1137
1138 /**
1139  * Hide a window.
1140  *
1141  * \param window the window to hide
1142  *
1143  * \since This function is available since SDL 2.0.0.
1144  *
1145  * \sa SDL_ShowWindow
1146  */
1147 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
1148
1149 /**
1150  * Raise a window above other windows and set the input focus.
1151  *
1152  * \param window the window to raise
1153  *
1154  * \since This function is available since SDL 2.0.0.
1155  */
1156 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
1157
1158 /**
1159  * Make a window as large as possible.
1160  *
1161  * \param window the window to maximize
1162  *
1163  * \since This function is available since SDL 2.0.0.
1164  *
1165  * \sa SDL_MinimizeWindow
1166  * \sa SDL_RestoreWindow
1167  */
1168 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
1169
1170 /**
1171  * Minimize a window to an iconic representation.
1172  *
1173  * \param window the window to minimize
1174  *
1175  * \since This function is available since SDL 2.0.0.
1176  *
1177  * \sa SDL_MaximizeWindow
1178  * \sa SDL_RestoreWindow
1179  */
1180 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
1181
1182 /**
1183  * Restore the size and position of a minimized or maximized window.
1184  *
1185  * \param window the window to restore
1186  *
1187  * \since This function is available since SDL 2.0.0.
1188  *
1189  * \sa SDL_MaximizeWindow
1190  * \sa SDL_MinimizeWindow
1191  */
1192 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
1193
1194 /**
1195  * Set a window's fullscreen state.
1196  *
1197  * `flags` may be `SDL_WINDOW_FULLSCREEN`, for "real" fullscreen with a
1198  * videomode change; `SDL_WINDOW_FULLSCREEN_DESKTOP` for "fake" fullscreen
1199  * that takes the size of the desktop; and 0 for windowed mode.
1200  *
1201  * \param window the window to change
1202  * \param flags `SDL_WINDOW_FULLSCREEN`, `SDL_WINDOW_FULLSCREEN_DESKTOP` or 0
1203  * \returns 0 on success or a negative error code on failure; call
1204  *          SDL_GetError() for more information.
1205  *
1206  * \since This function is available since SDL 2.0.0.
1207  *
1208  * \sa SDL_GetWindowDisplayMode
1209  * \sa SDL_SetWindowDisplayMode
1210  */
1211 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
1212                                                     Uint32 flags);
1213
1214 /**
1215  * Get the SDL surface associated with the window.
1216  *
1217  * A new surface will be created with the optimal format for the window, if
1218  * necessary. This surface will be freed when the window is destroyed. Do not
1219  * free this surface.
1220  *
1221  * This surface will be invalidated if the window is resized. After resizing a
1222  * window this function must be called again to return a valid surface.
1223  *
1224  * You may not combine this with 3D or the rendering API on this window.
1225  *
1226  * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`.
1227  *
1228  * \param window the window to query
1229  * \returns the surface associated with the window, or NULL on failure; call
1230  *          SDL_GetError() for more information.
1231  *
1232  * \since This function is available since SDL 2.0.0.
1233  *
1234  * \sa SDL_UpdateWindowSurface
1235  * \sa SDL_UpdateWindowSurfaceRects
1236  */
1237 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
1238
1239 /**
1240  * Copy the window surface to the screen.
1241  *
1242  * This is the function you use to reflect any changes to the surface on the
1243  * screen.
1244  *
1245  * This function is equivalent to the SDL 1.2 API SDL_Flip().
1246  *
1247  * \param window the window to update
1248  * \returns 0 on success or a negative error code on failure; call
1249  *          SDL_GetError() for more information.
1250  *
1251  * \since This function is available since SDL 2.0.0.
1252  *
1253  * \sa SDL_GetWindowSurface
1254  * \sa SDL_UpdateWindowSurfaceRects
1255  */
1256 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
1257
1258 /**
1259  * Copy areas of the window surface to the screen.
1260  *
1261  * This is the function you use to reflect changes to portions of the surface
1262  * on the screen.
1263  *
1264  * This function is equivalent to the SDL 1.2 API SDL_UpdateRects().
1265  *
1266  * \param window the window to update
1267  * \param rects an array of SDL_Rect structures representing areas of the
1268  *              surface to copy
1269  * \param numrects the number of rectangles
1270  * \returns 0 on success or a negative error code on failure; call
1271  *          SDL_GetError() for more information.
1272  *
1273  * \since This function is available since SDL 2.0.0.
1274  *
1275  * \sa SDL_GetWindowSurface
1276  * \sa SDL_UpdateWindowSurface
1277  */
1278 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
1279                                                          const SDL_Rect * rects,
1280                                                          int numrects);
1281
1282 /**
1283  * Set a window's input grab mode.
1284  *
1285  * When input is grabbed, the mouse is confined to the window. This function
1286  * will also grab the keyboard if `SDL_HINT_GRAB_KEYBOARD` is set. To grab the
1287  * keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().
1288  *
1289  * If the caller enables a grab while another window is currently grabbed, the
1290  * other window loses its grab in favor of the caller's window.
1291  *
1292  * \param window the window for which the input grab mode should be set
1293  * \param grabbed SDL_TRUE to grab input or SDL_FALSE to release input
1294  *
1295  * \since This function is available since SDL 2.0.0.
1296  *
1297  * \sa SDL_GetGrabbedWindow
1298  * \sa SDL_GetWindowGrab
1299  */
1300 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
1301                                                SDL_bool grabbed);
1302
1303 /**
1304  * Set a window's keyboard grab mode.
1305  *
1306  * Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or
1307  * the Meta/Super key. Note that not all system keyboard shortcuts can be
1308  * captured by applications (one example is Ctrl+Alt+Del on Windows).
1309  *
1310  * This is primarily intended for specialized applications such as VNC clients
1311  * or VM frontends. Normal games should not use keyboard grab.
1312  *
1313  * When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the
1314  * window is full-screen to ensure the user is not trapped in your
1315  * application. If you have a custom keyboard shortcut to exit fullscreen
1316  * mode, you may suppress this behavior with
1317  * `SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED`.
1318  *
1319  * If the caller enables a grab while another window is currently grabbed, the
1320  * other window loses its grab in favor of the caller's window.
1321  *
1322  * \param window The window for which the keyboard grab mode should be set.
1323  * \param grabbed This is SDL_TRUE to grab keyboard, and SDL_FALSE to release.
1324  *
1325  * \since This function is available since SDL 2.0.16.
1326  *
1327  * \sa SDL_GetWindowKeyboardGrab
1328  * \sa SDL_SetWindowMouseGrab
1329  * \sa SDL_SetWindowGrab
1330  */
1331 extern DECLSPEC void SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window * window,
1332                                                        SDL_bool grabbed);
1333
1334 /**
1335  * Set a window's mouse grab mode.
1336  *
1337  * Mouse grab confines the mouse cursor to the window.
1338  *
1339  * \param window The window for which the mouse grab mode should be set.
1340  * \param grabbed This is SDL_TRUE to grab mouse, and SDL_FALSE to release.
1341  *
1342  * \since This function is available since SDL 2.0.16.
1343  *
1344  * \sa SDL_GetWindowMouseGrab
1345  * \sa SDL_SetWindowKeyboardGrab
1346  * \sa SDL_SetWindowGrab
1347  */
1348 extern DECLSPEC void SDLCALL SDL_SetWindowMouseGrab(SDL_Window * window,
1349                                                     SDL_bool grabbed);
1350
1351 /**
1352  * Get a window's input grab mode.
1353  *
1354  * \param window the window to query
1355  * \returns SDL_TRUE if input is grabbed, SDL_FALSE otherwise.
1356  *
1357  * \since This function is available since SDL 2.0.0.
1358  *
1359  * \sa SDL_SetWindowGrab
1360  */
1361 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
1362
1363 /**
1364  * Get a window's keyboard grab mode.
1365  *
1366  * \param window the window to query
1367  * \returns SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
1368  *
1369  * \since This function is available since SDL 2.0.16.
1370  *
1371  * \sa SDL_SetWindowKeyboardGrab
1372  * \sa SDL_GetWindowGrab
1373  */
1374 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window * window);
1375
1376 /**
1377  * Get a window's mouse grab mode.
1378  *
1379  * \param window the window to query
1380  * \returns SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.
1381  *
1382  * \since This function is available since SDL 2.0.16.
1383  *
1384  * \sa SDL_SetWindowKeyboardGrab
1385  * \sa SDL_GetWindowGrab
1386  */
1387 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window * window);
1388
1389 /**
1390  * Get the window that currently has an input grab enabled.
1391  *
1392  * \returns the window if input is grabbed or NULL otherwise.
1393  *
1394  * \since This function is available since SDL 2.0.4.
1395  *
1396  * \sa SDL_GetWindowGrab
1397  * \sa SDL_SetWindowGrab
1398  */
1399 extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
1400
1401 /**
1402  * Confines the cursor to the specified area of a window.
1403  *
1404  * Note that this does NOT grab the cursor, it only defines the area a cursor
1405  * is restricted to when the window has mouse focus.
1406  *
1407  * \param window The window that will be associated with the barrier.
1408  * \param rect A rectangle area in window-relative coordinates. If NULL the
1409  *             barrier for the specified window will be destroyed.
1410  * \returns 0 on success or a negative error code on failure; call
1411  *          SDL_GetError() for more information.
1412  *
1413  * \since This function is available since SDL 2.0.18.
1414  *
1415  * \sa SDL_GetWindowMouseRect
1416  * \sa SDL_SetWindowMouseGrab
1417  */
1418 extern DECLSPEC int SDLCALL SDL_SetWindowMouseRect(SDL_Window * window, const SDL_Rect * rect);
1419
1420 /**
1421  * Get the mouse confinement rectangle of a window.
1422  *
1423  * \param window The window to query
1424  * \returns A pointer to the mouse confinement rectangle of a window, or NULL
1425  *          if there isn't one.
1426  *
1427  * \since This function is available since SDL 2.0.18.
1428  *
1429  * \sa SDL_SetWindowMouseRect
1430  */
1431 extern DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window * window);
1432
1433 /**
1434  * Set the brightness (gamma multiplier) for a given window's display.
1435  *
1436  * Despite the name and signature, this method sets the brightness of the
1437  * entire display, not an individual window. A window is considered to be
1438  * owned by the display that contains the window's center pixel. (The index of
1439  * this display can be retrieved using SDL_GetWindowDisplayIndex().) The
1440  * brightness set will not follow the window if it is moved to another
1441  * display.
1442  *
1443  * Many platforms will refuse to set the display brightness in modern times.
1444  * You are better off using a shader to adjust gamma during rendering, or
1445  * something similar.
1446  *
1447  * \param window the window used to select the display whose brightness will
1448  *               be changed
1449  * \param brightness the brightness (gamma multiplier) value to set where 0.0
1450  *                   is completely dark and 1.0 is normal brightness
1451  * \returns 0 on success or a negative error code on failure; call
1452  *          SDL_GetError() for more information.
1453  *
1454  * \since This function is available since SDL 2.0.0.
1455  *
1456  * \sa SDL_GetWindowBrightness
1457  * \sa SDL_SetWindowGammaRamp
1458  */
1459 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
1460
1461 /**
1462  * Get the brightness (gamma multiplier) for a given window's display.
1463  *
1464  * Despite the name and signature, this method retrieves the brightness of the
1465  * entire display, not an individual window. A window is considered to be
1466  * owned by the display that contains the window's center pixel. (The index of
1467  * this display can be retrieved using SDL_GetWindowDisplayIndex().)
1468  *
1469  * \param window the window used to select the display whose brightness will
1470  *               be queried
1471  * \returns the brightness for the display where 0.0 is completely dark and
1472  *          1.0 is normal brightness.
1473  *
1474  * \since This function is available since SDL 2.0.0.
1475  *
1476  * \sa SDL_SetWindowBrightness
1477  */
1478 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
1479
1480 /**
1481  * Set the opacity for a window.
1482  *
1483  * The parameter `opacity` will be clamped internally between 0.0f
1484  * (transparent) and 1.0f (opaque).
1485  *
1486  * This function also returns -1 if setting the opacity isn't supported.
1487  *
1488  * \param window the window which will be made transparent or opaque
1489  * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque)
1490  * \returns 0 on success or a negative error code on failure; call
1491  *          SDL_GetError() for more information.
1492  *
1493  * \since This function is available since SDL 2.0.5.
1494  *
1495  * \sa SDL_GetWindowOpacity
1496  */
1497 extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window * window, float opacity);
1498
1499 /**
1500  * Get the opacity of a window.
1501  *
1502  * If transparency isn't supported on this platform, opacity will be reported
1503  * as 1.0f without error.
1504  *
1505  * The parameter `opacity` is ignored if it is NULL.
1506  *
1507  * This function also returns -1 if an invalid window was provided.
1508  *
1509  * \param window the window to get the current opacity value from
1510  * \param out_opacity the float filled in (0.0f - transparent, 1.0f - opaque)
1511  * \returns 0 on success or a negative error code on failure; call
1512  *          SDL_GetError() for more information.
1513  *
1514  * \since This function is available since SDL 2.0.5.
1515  *
1516  * \sa SDL_SetWindowOpacity
1517  */
1518 extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window * window, float * out_opacity);
1519
1520 /**
1521  * Set the window as a modal for another window.
1522  *
1523  * \param modal_window the window that should be set modal
1524  * \param parent_window the parent window for the modal window
1525  * \returns 0 on success or a negative error code on failure; call
1526  *          SDL_GetError() for more information.
1527  *
1528  * \since This function is available since SDL 2.0.5.
1529  */
1530 extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window * modal_window, SDL_Window * parent_window);
1531
1532 /**
1533  * Explicitly set input focus to the window.
1534  *
1535  * You almost certainly want SDL_RaiseWindow() instead of this function. Use
1536  * this with caution, as you might give focus to a window that is completely
1537  * obscured by other windows.
1538  *
1539  * \param window the window that should get the input focus
1540  * \returns 0 on success or a negative error code on failure; call
1541  *          SDL_GetError() for more information.
1542  *
1543  * \since This function is available since SDL 2.0.5.
1544  *
1545  * \sa SDL_RaiseWindow
1546  */
1547 extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window * window);
1548
1549 /**
1550  * Set the gamma ramp for the display that owns a given window.
1551  *
1552  * Set the gamma translation table for the red, green, and blue channels of
1553  * the video hardware. Each table is an array of 256 16-bit quantities,
1554  * representing a mapping between the input and output for that channel. The
1555  * input is the index into the array, and the output is the 16-bit gamma value
1556  * at that index, scaled to the output color precision.
1557  *
1558  * Despite the name and signature, this method sets the gamma ramp of the
1559  * entire display, not an individual window. A window is considered to be
1560  * owned by the display that contains the window's center pixel. (The index of
1561  * this display can be retrieved using SDL_GetWindowDisplayIndex().) The gamma
1562  * ramp set will not follow the window if it is moved to another display.
1563  *
1564  * \param window the window used to select the display whose gamma ramp will
1565  *               be changed
1566  * \param red a 256 element array of 16-bit quantities representing the
1567  *            translation table for the red channel, or NULL
1568  * \param green a 256 element array of 16-bit quantities representing the
1569  *              translation table for the green channel, or NULL
1570  * \param blue a 256 element array of 16-bit quantities representing the
1571  *             translation table for the blue channel, or NULL
1572  * \returns 0 on success or a negative error code on failure; call
1573  *          SDL_GetError() for more information.
1574  *
1575  * \since This function is available since SDL 2.0.0.
1576  *
1577  * \sa SDL_GetWindowGammaRamp
1578  */
1579 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
1580                                                    const Uint16 * red,
1581                                                    const Uint16 * green,
1582                                                    const Uint16 * blue);
1583
1584 /**
1585  * Get the gamma ramp for a given window's display.
1586  *
1587  * Despite the name and signature, this method retrieves the gamma ramp of the
1588  * entire display, not an individual window. A window is considered to be
1589  * owned by the display that contains the window's center pixel. (The index of
1590  * this display can be retrieved using SDL_GetWindowDisplayIndex().)
1591  *
1592  * \param window the window used to select the display whose gamma ramp will
1593  *               be queried
1594  * \param red a 256 element array of 16-bit quantities filled in with the
1595  *            translation table for the red channel, or NULL
1596  * \param green a 256 element array of 16-bit quantities filled in with the
1597  *              translation table for the green channel, or NULL
1598  * \param blue a 256 element array of 16-bit quantities filled in with the
1599  *             translation table for the blue channel, or NULL
1600  * \returns 0 on success or a negative error code on failure; call
1601  *          SDL_GetError() for more information.
1602  *
1603  * \since This function is available since SDL 2.0.0.
1604  *
1605  * \sa SDL_SetWindowGammaRamp
1606  */
1607 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
1608                                                    Uint16 * red,
1609                                                    Uint16 * green,
1610                                                    Uint16 * blue);
1611
1612 /**
1613  * Possible return values from the SDL_HitTest callback.
1614  *
1615  * \sa SDL_HitTest
1616  */
1617 typedef enum
1618 {
1619     SDL_HITTEST_NORMAL,  /**< Region is normal. No special properties. */
1620     SDL_HITTEST_DRAGGABLE,  /**< Region can drag entire window. */
1621     SDL_HITTEST_RESIZE_TOPLEFT,
1622     SDL_HITTEST_RESIZE_TOP,
1623     SDL_HITTEST_RESIZE_TOPRIGHT,
1624     SDL_HITTEST_RESIZE_RIGHT,
1625     SDL_HITTEST_RESIZE_BOTTOMRIGHT,
1626     SDL_HITTEST_RESIZE_BOTTOM,
1627     SDL_HITTEST_RESIZE_BOTTOMLEFT,
1628     SDL_HITTEST_RESIZE_LEFT
1629 } SDL_HitTestResult;
1630
1631 /**
1632  * Callback used for hit-testing.
1633  *
1634  * \param win the SDL_Window where hit-testing was set on
1635  * \param area an SDL_Point which should be hit-tested
1636  * \param data what was passed as `callback_data` to SDL_SetWindowHitTest()
1637  * \return an SDL_HitTestResult value.
1638  *
1639  * \sa SDL_SetWindowHitTest
1640  */
1641 typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
1642                                                  const SDL_Point *area,
1643                                                  void *data);
1644
1645 /**
1646  * Provide a callback that decides if a window region has special properties.
1647  *
1648  * Normally windows are dragged and resized by decorations provided by the
1649  * system window manager (a title bar, borders, etc), but for some apps, it
1650  * makes sense to drag them from somewhere else inside the window itself; for
1651  * example, one might have a borderless window that wants to be draggable from
1652  * any part, or simulate its own title bar, etc.
1653  *
1654  * This function lets the app provide a callback that designates pieces of a
1655  * given window as special. This callback is run during event processing if we
1656  * need to tell the OS to treat a region of the window specially; the use of
1657  * this callback is known as "hit testing."
1658  *
1659  * Mouse input may not be delivered to your application if it is within a
1660  * special area; the OS will often apply that input to moving the window or
1661  * resizing the window and not deliver it to the application.
1662  *
1663  * Specifying NULL for a callback disables hit-testing. Hit-testing is
1664  * disabled by default.
1665  *
1666  * Platforms that don't support this functionality will return -1
1667  * unconditionally, even if you're attempting to disable hit-testing.
1668  *
1669  * Your callback may fire at any time, and its firing does not indicate any
1670  * specific behavior (for example, on Windows, this certainly might fire when
1671  * the OS is deciding whether to drag your window, but it fires for lots of
1672  * other reasons, too, some unrelated to anything you probably care about _and
1673  * when the mouse isn't actually at the location it is testing_). Since this
1674  * can fire at any time, you should try to keep your callback efficient,
1675  * devoid of allocations, etc.
1676  *
1677  * \param window the window to set hit-testing on
1678  * \param callback the function to call when doing a hit-test
1679  * \param callback_data an app-defined void pointer passed to **callback**
1680  * \returns 0 on success or -1 on error (including unsupported); call
1681  *          SDL_GetError() for more information.
1682  *
1683  * \since This function is available since SDL 2.0.4.
1684  */
1685 extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window * window,
1686                                                  SDL_HitTest callback,
1687                                                  void *callback_data);
1688
1689 /**
1690  * Request a window to demand attention from the user.
1691  *
1692  * \param window the window to be flashed
1693  * \param operation the flash operation
1694  * \returns 0 on success or a negative error code on failure; call
1695  *          SDL_GetError() for more information.
1696  *
1697  * \since This function is available since SDL 2.0.16.
1698  */
1699 extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window * window, SDL_FlashOperation operation);
1700
1701 /**
1702  * Destroy a window.
1703  *
1704  * If `window` is NULL, this function will return immediately after setting
1705  * the SDL error message to "Invalid window". See SDL_GetError().
1706  *
1707  * \param window the window to destroy
1708  *
1709  * \since This function is available since SDL 2.0.0.
1710  *
1711  * \sa SDL_CreateWindow
1712  * \sa SDL_CreateWindowFrom
1713  */
1714 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
1715
1716
1717 /**
1718  * Check whether the screensaver is currently enabled.
1719  *
1720  * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2
1721  * the screensaver was enabled by default.
1722  *
1723  * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`.
1724  *
1725  * \returns SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is
1726  *          disabled.
1727  *
1728  * \since This function is available since SDL 2.0.0.
1729  *
1730  * \sa SDL_DisableScreenSaver
1731  * \sa SDL_EnableScreenSaver
1732  */
1733 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
1734
1735 /**
1736  * Allow the screen to be blanked by a screen saver.
1737  *
1738  * \since This function is available since SDL 2.0.0.
1739  *
1740  * \sa SDL_DisableScreenSaver
1741  * \sa SDL_IsScreenSaverEnabled
1742  */
1743 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
1744
1745 /**
1746  * Prevent the screen from being blanked by a screen saver.
1747  *
1748  * If you disable the screensaver, it is automatically re-enabled when SDL
1749  * quits.
1750  *
1751  * \since This function is available since SDL 2.0.0.
1752  *
1753  * \sa SDL_EnableScreenSaver
1754  * \sa SDL_IsScreenSaverEnabled
1755  */
1756 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
1757
1758
1759 /**
1760  *  \name OpenGL support functions
1761  */
1762 /* @{ */
1763
1764 /**
1765  * Dynamically load an OpenGL library.
1766  *
1767  * This should be done after initializing the video driver, but before
1768  * creating any OpenGL windows. If no OpenGL library is loaded, the default
1769  * library will be loaded upon creation of the first OpenGL window.
1770  *
1771  * If you do this, you need to retrieve all of the GL functions used in your
1772  * program from the dynamic library using SDL_GL_GetProcAddress().
1773  *
1774  * \param path the platform dependent OpenGL library name, or NULL to open the
1775  *             default OpenGL library
1776  * \returns 0 on success or a negative error code on failure; call
1777  *          SDL_GetError() for more information.
1778  *
1779  * \since This function is available since SDL 2.0.0.
1780  *
1781  * \sa SDL_GL_GetProcAddress
1782  * \sa SDL_GL_UnloadLibrary
1783  */
1784 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
1785
1786 /**
1787  * Get an OpenGL function by name.
1788  *
1789  * If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all
1790  * GL functions must be retrieved this way. Usually this is used to retrieve
1791  * function pointers to OpenGL extensions.
1792  *
1793  * There are some quirks to looking up OpenGL functions that require some
1794  * extra care from the application. If you code carefully, you can handle
1795  * these quirks without any platform-specific code, though:
1796  *
1797  * - On Windows, function pointers are specific to the current GL context;
1798  *   this means you need to have created a GL context and made it current
1799  *   before calling SDL_GL_GetProcAddress(). If you recreate your context or
1800  *   create a second context, you should assume that any existing function
1801  *   pointers aren't valid to use with it. This is (currently) a
1802  *   Windows-specific limitation, and in practice lots of drivers don't suffer
1803  *   this limitation, but it is still the way the wgl API is documented to
1804  *   work and you should expect crashes if you don't respect it. Store a copy
1805  *   of the function pointers that comes and goes with context lifespan.
1806  * - On X11, function pointers returned by this function are valid for any
1807  *   context, and can even be looked up before a context is created at all.
1808  *   This means that, for at least some common OpenGL implementations, if you
1809  *   look up a function that doesn't exist, you'll get a non-NULL result that
1810  *   is _NOT_ safe to call. You must always make sure the function is actually
1811  *   available for a given GL context before calling it, by checking for the
1812  *   existence of the appropriate extension with SDL_GL_ExtensionSupported(),
1813  *   or verifying that the version of OpenGL you're using offers the function
1814  *   as core functionality.
1815  * - Some OpenGL drivers, on all platforms, *will* return NULL if a function
1816  *   isn't supported, but you can't count on this behavior. Check for
1817  *   extensions you use, and if you get a NULL anyway, act as if that
1818  *   extension wasn't available. This is probably a bug in the driver, but you
1819  *   can code defensively for this scenario anyhow.
1820  * - Just because you're on Linux/Unix, don't assume you'll be using X11.
1821  *   Next-gen display servers are waiting to replace it, and may or may not
1822  *   make the same promises about function pointers.
1823  * - OpenGL function pointers must be declared `APIENTRY` as in the example
1824  *   code. This will ensure the proper calling convention is followed on
1825  *   platforms where this matters (Win32) thereby avoiding stack corruption.
1826  *
1827  * \param proc the name of an OpenGL function
1828  * \returns a pointer to the named OpenGL function. The returned pointer
1829  *          should be cast to the appropriate function signature.
1830  *
1831  * \since This function is available since SDL 2.0.0.
1832  *
1833  * \sa SDL_GL_ExtensionSupported
1834  * \sa SDL_GL_LoadLibrary
1835  * \sa SDL_GL_UnloadLibrary
1836  */
1837 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
1838
1839 /**
1840  * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
1841  *
1842  * \since This function is available since SDL 2.0.0.
1843  *
1844  * \sa SDL_GL_LoadLibrary
1845  */
1846 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
1847
1848 /**
1849  * Check if an OpenGL extension is supported for the current context.
1850  *
1851  * This function operates on the current GL context; you must have created a
1852  * context and it must be current before calling this function. Do not assume
1853  * that all contexts you create will have the same set of extensions
1854  * available, or that recreating an existing context will offer the same
1855  * extensions again.
1856  *
1857  * While it's probably not a massive overhead, this function is not an O(1)
1858  * operation. Check the extensions you care about after creating the GL
1859  * context and save that information somewhere instead of calling the function
1860  * every time you need to know.
1861  *
1862  * \param extension the name of the extension to check
1863  * \returns SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
1864  *
1865  * \since This function is available since SDL 2.0.0.
1866  */
1867 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
1868                                                            *extension);
1869
1870 /**
1871  * Reset all previously set OpenGL context attributes to their default values.
1872  *
1873  * \since This function is available since SDL 2.0.2.
1874  *
1875  * \sa SDL_GL_GetAttribute
1876  * \sa SDL_GL_SetAttribute
1877  */
1878 extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
1879
1880 /**
1881  * Set an OpenGL window attribute before window creation.
1882  *
1883  * This function sets the OpenGL attribute `attr` to `value`. The requested
1884  * attributes should be set before creating an OpenGL window. You should use
1885  * SDL_GL_GetAttribute() to check the values after creating the OpenGL
1886  * context, since the values obtained can differ from the requested ones.
1887  *
1888  * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to set
1889  * \param value the desired value for the attribute
1890  * \returns 0 on success or a negative error code on failure; call
1891  *          SDL_GetError() for more information.
1892  *
1893  * \since This function is available since SDL 2.0.0.
1894  *
1895  * \sa SDL_GL_GetAttribute
1896  * \sa SDL_GL_ResetAttributes
1897  */
1898 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
1899
1900 /**
1901  * Get the actual value for an attribute from the current context.
1902  *
1903  * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to get
1904  * \param value a pointer filled in with the current value of `attr`
1905  * \returns 0 on success or a negative error code on failure; call
1906  *          SDL_GetError() for more information.
1907  *
1908  * \since This function is available since SDL 2.0.0.
1909  *
1910  * \sa SDL_GL_ResetAttributes
1911  * \sa SDL_GL_SetAttribute
1912  */
1913 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
1914
1915 /**
1916  * Create an OpenGL context for an OpenGL window, and make it current.
1917  *
1918  * Windows users new to OpenGL should note that, for historical reasons, GL
1919  * functions added after OpenGL version 1.1 are not available by default.
1920  * Those functions must be loaded at run-time, either with an OpenGL
1921  * extension-handling library or with SDL_GL_GetProcAddress() and its related
1922  * functions.
1923  *
1924  * SDL_GLContext is an alias for `void *`. It's opaque to the application.
1925  *
1926  * \param window the window to associate with the context
1927  * \returns the OpenGL context associated with `window` or NULL on error; call
1928  *          SDL_GetError() for more details.
1929  *
1930  * \since This function is available since SDL 2.0.0.
1931  *
1932  * \sa SDL_GL_DeleteContext
1933  * \sa SDL_GL_MakeCurrent
1934  */
1935 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
1936                                                            window);
1937
1938 /**
1939  * Set up an OpenGL context for rendering into an OpenGL window.
1940  *
1941  * The context must have been created with a compatible window.
1942  *
1943  * \param window the window to associate with the context
1944  * \param context the OpenGL context to associate with the window
1945  * \returns 0 on success or a negative error code on failure; call
1946  *          SDL_GetError() for more information.
1947  *
1948  * \since This function is available since SDL 2.0.0.
1949  *
1950  * \sa SDL_GL_CreateContext
1951  */
1952 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
1953                                                SDL_GLContext context);
1954
1955 /**
1956  * Get the currently active OpenGL window.
1957  *
1958  * \returns the currently active OpenGL window on success or NULL on failure;
1959  *          call SDL_GetError() for more information.
1960  *
1961  * \since This function is available since SDL 2.0.0.
1962  */
1963 extern DECLSPEC SDL_Window* SDLCALL SDL_GL_GetCurrentWindow(void);
1964
1965 /**
1966  * Get the currently active OpenGL context.
1967  *
1968  * \returns the currently active OpenGL context or NULL on failure; call
1969  *          SDL_GetError() for more information.
1970  *
1971  * \since This function is available since SDL 2.0.0.
1972  *
1973  * \sa SDL_GL_MakeCurrent
1974  */
1975 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
1976
1977 /**
1978  * Get the size of a window's underlying drawable in pixels.
1979  *
1980  * This returns info useful for calling glViewport().
1981  *
1982  * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
1983  * drawable, i.e. the window was created with `SDL_WINDOW_ALLOW_HIGHDPI` on a
1984  * platform with high-DPI support (Apple calls this "Retina"), and not
1985  * disabled by the `SDL_HINT_VIDEO_HIGHDPI_DISABLED` hint.
1986  *
1987  * \param window the window from which the drawable size should be queried
1988  * \param w a pointer to variable for storing the width in pixels, may be NULL
1989  * \param h a pointer to variable for storing the height in pixels, may be
1990  *          NULL
1991  *
1992  * \since This function is available since SDL 2.0.1.
1993  *
1994  * \sa SDL_CreateWindow
1995  * \sa SDL_GetWindowSize
1996  */
1997 extern DECLSPEC void SDLCALL SDL_GL_GetDrawableSize(SDL_Window * window, int *w,
1998                                                     int *h);
1999
2000 /**
2001  * Set the swap interval for the current OpenGL context.
2002  *
2003  * Some systems allow specifying -1 for the interval, to enable adaptive
2004  * vsync. Adaptive vsync works the same as vsync, but if you've already missed
2005  * the vertical retrace for a given frame, it swaps buffers immediately, which
2006  * might be less jarring for the user during occasional framerate drops. If an
2007  * application requests adaptive vsync and the system does not support it,
2008  * this function will fail and return -1. In such a case, you should probably
2009  * retry the call with 1 for the interval.
2010  *
2011  * Adaptive vsync is implemented for some glX drivers with
2012  * GLX_EXT_swap_control_tear:
2013  *
2014  * https://www.opengl.org/registry/specs/EXT/glx_swap_control_tear.txt
2015  *
2016  * and for some Windows drivers with WGL_EXT_swap_control_tear:
2017  *
2018  * https://www.opengl.org/registry/specs/EXT/wgl_swap_control_tear.txt
2019  *
2020  * Read more on the Khronos wiki:
2021  * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
2022  *
2023  * \param interval 0 for immediate updates, 1 for updates synchronized with
2024  *                 the vertical retrace, -1 for adaptive vsync
2025  * \returns 0 on success or -1 if setting the swap interval is not supported;
2026  *          call SDL_GetError() for more information.
2027  *
2028  * \since This function is available since SDL 2.0.0.
2029  *
2030  * \sa SDL_GL_GetSwapInterval
2031  */
2032 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
2033
2034 /**
2035  * Get the swap interval for the current OpenGL context.
2036  *
2037  * If the system can't determine the swap interval, or there isn't a valid
2038  * current context, this function will return 0 as a safe default.
2039  *
2040  * \returns 0 if there is no vertical retrace synchronization, 1 if the buffer
2041  *          swap is synchronized with the vertical retrace, and -1 if late
2042  *          swaps happen immediately instead of waiting for the next retrace;
2043  *          call SDL_GetError() for more information.
2044  *
2045  * \since This function is available since SDL 2.0.0.
2046  *
2047  * \sa SDL_GL_SetSwapInterval
2048  */
2049 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
2050
2051 /**
2052  * Update a window with OpenGL rendering.
2053  *
2054  * This is used with double-buffered OpenGL contexts, which are the default.
2055  *
2056  * On macOS, make sure you bind 0 to the draw framebuffer before swapping the
2057  * window, otherwise nothing will happen. If you aren't using
2058  * glBindFramebuffer(), this is the default and you won't have to do anything
2059  * extra.
2060  *
2061  * \param window the window to change
2062  *
2063  * \since This function is available since SDL 2.0.0.
2064  */
2065 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
2066
2067 /**
2068  * Delete an OpenGL context.
2069  *
2070  * \param context the OpenGL context to be deleted
2071  *
2072  * \since This function is available since SDL 2.0.0.
2073  *
2074  * \sa SDL_GL_CreateContext
2075  */
2076 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
2077
2078 /* @} *//* OpenGL support functions */
2079
2080
2081 /* Ends C function definitions when using C++ */
2082 #ifdef __cplusplus
2083 }
2084 #endif
2085 #include "close_code.h"
2086
2087 #endif /* SDL_video_h_ */
2088
2089 /* vi: set ts=4 sw=4 expandtab: */