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