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