include/SDL_video.h

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