include/SDL_video.h
author Ryan C. Gordon <icculus@icculus.org>
Sat, 28 Mar 2015 00:48:03 -0400
changeset 9447 728a4bf8e02f
parent 9412 8b1436ce1028
child 9619 b94b6d0bff0f
permissions -rw-r--r--
Minor input grab clarifications.

Clarify that grabbing the mouse only works with one window at a time; this was
always true at the system level, though SDL could previously get confused
by multiple simultaneous grabs, so now we explicitly break any existing
grab before starting a new one and document it as such.

Also track the window that is currently grabbed, and provide an API to query
for that window. This makes it easy to automate mouse ungrabbing at
breakpoints with gdb7's scripting, since the scripts can now know which window
to ungrab.

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