misc/builddeps/win64/sdl/include/SDL2/SDL_video.h

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