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