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