include/SDL_video.h
author Jørgen P. Tjernø <jorgen@valvesoftware.com>
Wed, 05 Jun 2013 12:48:44 -0700
changeset 7277 1290cd7f34af
parent 7191 75360622e65f
child 7412 50211a1fd557
permissions -rw-r--r--
Mac: Fix invalid PS3 controller mapping.

PS3 controller had swapped D-Pad down & left buttons, as well as X & Y buttons.
Thanks to Alex Szpakowski for the bug report and fix.

Fixes http://bugzilla.libsdl.org/show_bug.cgi?id=1891
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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_WindowFlags;
   112 
   113 /**
   114  *  \brief Used to indicate that you don't care what the window position is.
   115  */
   116 #define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000
   117 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
   118 #define SDL_WINDOWPOS_UNDEFINED         SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
   119 #define SDL_WINDOWPOS_ISUNDEFINED(X)    \
   120             (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
   121 
   122 /**
   123  *  \brief Used to indicate that the window position should be centered.
   124  */
   125 #define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000
   126 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))
   127 #define SDL_WINDOWPOS_CENTERED         SDL_WINDOWPOS_CENTERED_DISPLAY(0)
   128 #define SDL_WINDOWPOS_ISCENTERED(X)    \
   129             (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
   130 
   131 /**
   132  *  \brief Event subtype for window events
   133  */
   134 typedef enum
   135 {
   136     SDL_WINDOWEVENT_NONE,           /**< Never used */
   137     SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
   138     SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
   139     SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be
   140                                          redrawn */
   141     SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2
   142                                      */
   143     SDL_WINDOWEVENT_RESIZED,        /**< Window has been resized to data1xdata2 */
   144     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. */
   145     SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
   146     SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
   147     SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
   148                                          and position */
   149     SDL_WINDOWEVENT_ENTER,          /**< Window has gained mouse focus */
   150     SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
   151     SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
   152     SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
   153     SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the
   154                                          window be closed */
   155 } SDL_WindowEventID;
   156 
   157 /**
   158  *  \brief An opaque handle to an OpenGL context.
   159  */
   160 typedef void *SDL_GLContext;
   161 
   162 /**
   163  *  \brief OpenGL configuration attributes
   164  */
   165 typedef enum
   166 {
   167     SDL_GL_RED_SIZE,
   168     SDL_GL_GREEN_SIZE,
   169     SDL_GL_BLUE_SIZE,
   170     SDL_GL_ALPHA_SIZE,
   171     SDL_GL_BUFFER_SIZE,
   172     SDL_GL_DOUBLEBUFFER,
   173     SDL_GL_DEPTH_SIZE,
   174     SDL_GL_STENCIL_SIZE,
   175     SDL_GL_ACCUM_RED_SIZE,
   176     SDL_GL_ACCUM_GREEN_SIZE,
   177     SDL_GL_ACCUM_BLUE_SIZE,
   178     SDL_GL_ACCUM_ALPHA_SIZE,
   179     SDL_GL_STEREO,
   180     SDL_GL_MULTISAMPLEBUFFERS,
   181     SDL_GL_MULTISAMPLESAMPLES,
   182     SDL_GL_ACCELERATED_VISUAL,
   183     SDL_GL_RETAINED_BACKING,
   184     SDL_GL_CONTEXT_MAJOR_VERSION,
   185     SDL_GL_CONTEXT_MINOR_VERSION,
   186     SDL_GL_CONTEXT_EGL,
   187     SDL_GL_CONTEXT_FLAGS,
   188     SDL_GL_CONTEXT_PROFILE_MASK,
   189     SDL_GL_SHARE_WITH_CURRENT_CONTEXT
   190 } SDL_GLattr;
   191 
   192 typedef enum
   193 {
   194     SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
   195     SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
   196     SDL_GL_CONTEXT_PROFILE_ES             = 0x0004
   197 } SDL_GLprofile;
   198 
   199 typedef enum
   200 {
   201     SDL_GL_CONTEXT_DEBUG_FLAG              = 0x0001,
   202     SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
   203     SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG      = 0x0004,
   204     SDL_GL_CONTEXT_RESET_ISOLATION_FLAG    = 0x0008
   205 } SDL_GLcontextFlag;
   206 
   207 
   208 /* Function prototypes */
   209 
   210 /**
   211  *  \brief Get the number of video drivers compiled into SDL
   212  *
   213  *  \sa SDL_GetVideoDriver()
   214  */
   215 extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
   216 
   217 /**
   218  *  \brief Get the name of a built in video driver.
   219  *
   220  *  \note The video drivers are presented in the order in which they are
   221  *        normally checked during initialization.
   222  *
   223  *  \sa SDL_GetNumVideoDrivers()
   224  */
   225 extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
   226 
   227 /**
   228  *  \brief Initialize the video subsystem, optionally specifying a video driver.
   229  *
   230  *  \param driver_name Initialize a specific driver by name, or NULL for the
   231  *                     default video driver.
   232  *
   233  *  \return 0 on success, -1 on error
   234  *
   235  *  This function initializes the video subsystem; setting up a connection
   236  *  to the window manager, etc, and determines the available display modes
   237  *  and pixel formats, but does not initialize a window or graphics mode.
   238  *
   239  *  \sa SDL_VideoQuit()
   240  */
   241 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
   242 
   243 /**
   244  *  \brief Shuts down the video subsystem.
   245  *
   246  *  This function closes all windows, and restores the original video mode.
   247  *
   248  *  \sa SDL_VideoInit()
   249  */
   250 extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   251 
   252 /**
   253  *  \brief Returns the name of the currently initialized video driver.
   254  *
   255  *  \return The name of the current video driver or NULL if no driver
   256  *          has been initialized
   257  *
   258  *  \sa SDL_GetNumVideoDrivers()
   259  *  \sa SDL_GetVideoDriver()
   260  */
   261 extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
   262 
   263 /**
   264  *  \brief Returns the number of available video displays.
   265  *
   266  *  \sa SDL_GetDisplayBounds()
   267  */
   268 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   269 
   270 /**
   271  *  \brief Get the name of a display in UTF-8 encoding
   272  *
   273  *  \return The name of a display, or NULL for an invalid display index.
   274  *
   275  *  \sa SDL_GetNumVideoDisplays()
   276  */
   277 extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
   278 
   279 /**
   280  *  \brief Get the desktop area represented by a display, with the primary
   281  *         display located at 0,0
   282  *
   283  *  \return 0 on success, or -1 if the index is out of range.
   284  *
   285  *  \sa SDL_GetNumVideoDisplays()
   286  */
   287 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
   288 
   289 /**
   290  *  \brief Returns the number of available display modes.
   291  *
   292  *  \sa SDL_GetDisplayMode()
   293  */
   294 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
   295 
   296 /**
   297  *  \brief Fill in information about a specific display mode.
   298  *
   299  *  \note The display modes are sorted in this priority:
   300  *        \li bits per pixel -> more colors to fewer colors
   301  *        \li width -> largest to smallest
   302  *        \li height -> largest to smallest
   303  *        \li refresh rate -> highest to lowest
   304  *
   305  *  \sa SDL_GetNumDisplayModes()
   306  */
   307 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
   308                                                SDL_DisplayMode * mode);
   309 
   310 /**
   311  *  \brief Fill in information about the desktop display mode.
   312  */
   313 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   314 
   315 /**
   316  *  \brief Fill in information about the current display mode.
   317  */
   318 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
   319 
   320 
   321 /**
   322  *  \brief Get the closest match to the requested display mode.
   323  *
   324  *  \param displayIndex The index of display from which mode should be queried.
   325  *  \param mode The desired display mode
   326  *  \param closest A pointer to a display mode to be filled in with the closest
   327  *                 match of the available display modes.
   328  *
   329  *  \return The passed in value \c closest, or NULL if no matching video mode
   330  *          was available.
   331  *
   332  *  The available display modes are scanned, and \c closest is filled in with the
   333  *  closest mode matching the requested mode and returned.  The mode format and
   334  *  refresh_rate default to the desktop mode if they are 0.  The modes are
   335  *  scanned with size being first priority, format being second priority, and
   336  *  finally checking the refresh_rate.  If all the available modes are too
   337  *  small, then NULL is returned.
   338  *
   339  *  \sa SDL_GetNumDisplayModes()
   340  *  \sa SDL_GetDisplayMode()
   341  */
   342 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
   343 
   344 /**
   345  *  \brief Get the display index associated with a window.
   346  *
   347  *  \return the display index of the display containing the center of the
   348  *          window, or -1 on error.
   349  */
   350 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayIndex(SDL_Window * window);
   351 
   352 /**
   353  *  \brief Set the display mode used when a fullscreen window is visible.
   354  *
   355  *  By default the window's dimensions and the desktop format and refresh rate
   356  *  are used.
   357  *
   358  *  \param window The window for which the display mode should be set.
   359  *  \param mode The mode to use, or NULL for the default mode.
   360  *
   361  *  \return 0 on success, or -1 if setting the display mode failed.
   362  *
   363  *  \sa SDL_GetWindowDisplayMode()
   364  *  \sa SDL_SetWindowFullscreen()
   365  */
   366 extern DECLSPEC int SDLCALL SDL_SetWindowDisplayMode(SDL_Window * window,
   367                                                      const SDL_DisplayMode
   368                                                          * mode);
   369 
   370 /**
   371  *  \brief Fill in information about the display mode used when a fullscreen
   372  *         window is visible.
   373  *
   374  *  \sa SDL_SetWindowDisplayMode()
   375  *  \sa SDL_SetWindowFullscreen()
   376  */
   377 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
   378                                                      SDL_DisplayMode * mode);
   379 
   380 /**
   381  *  \brief Get the pixel format associated with the window.
   382  */
   383 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window);
   384 
   385 /**
   386  *  \brief Create a window with the specified position, dimensions, and flags.
   387  *
   388  *  \param title The title of the window, in UTF-8 encoding.
   389  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
   390  *               ::SDL_WINDOWPOS_UNDEFINED.
   391  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
   392  *               ::SDL_WINDOWPOS_UNDEFINED.
   393  *  \param w     The width of the window.
   394  *  \param h     The height of the window.
   395  *  \param flags The flags for the window, a mask of any of the following:
   396  *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
   397  *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS,
   398  *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED,
   399  *               ::SDL_WINDOW_MINIMIZED,  ::SDL_WINDOW_INPUT_GRABBED.
   400  *
   401  *  \return The id of the window created, or zero if window creation failed.
   402  *
   403  *  \sa SDL_DestroyWindow()
   404  */
   405 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
   406                                                       int x, int y, int w,
   407                                                       int h, Uint32 flags);
   408 
   409 /**
   410  *  \brief Create an SDL window from an existing native window.
   411  *
   412  *  \param data A pointer to driver-dependent window creation data
   413  *
   414  *  \return The id of the window created, or zero if window creation failed.
   415  *
   416  *  \sa SDL_DestroyWindow()
   417  */
   418 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
   419 
   420 /**
   421  *  \brief Get the numeric ID of a window, for logging purposes.
   422  */
   423 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
   424 
   425 /**
   426  *  \brief Get a window from a stored ID, or NULL if it doesn't exist.
   427  */
   428 extern DECLSPEC SDL_Window * SDLCALL SDL_GetWindowFromID(Uint32 id);
   429 
   430 /**
   431  *  \brief Get the window flags.
   432  */
   433 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
   434 
   435 /**
   436  *  \brief Set the title of a window, in UTF-8 format.
   437  *
   438  *  \sa SDL_GetWindowTitle()
   439  */
   440 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
   441                                                 const char *title);
   442 
   443 /**
   444  *  \brief Get the title of a window, in UTF-8 format.
   445  *
   446  *  \sa SDL_SetWindowTitle()
   447  */
   448 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
   449 
   450 /**
   451  *  \brief Set the icon for a window.
   452  *
   453  *  \param window The window for which the icon should be set.
   454  *  \param icon The icon for the window.
   455  */
   456 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
   457                                                SDL_Surface * icon);
   458 
   459 /**
   460  *  \brief Associate an arbitrary named pointer with a window.
   461  *
   462  *  \param window   The window to associate with the pointer.
   463  *  \param name     The name of the pointer.
   464  *  \param userdata The associated pointer.
   465  *
   466  *  \return The previous value associated with 'name'
   467  *
   468  *  \note The name is case-sensitive.
   469  *
   470  *  \sa SDL_GetWindowData()
   471  */
   472 extern DECLSPEC void* SDLCALL SDL_SetWindowData(SDL_Window * window,
   473                                                 const char *name,
   474                                                 void *userdata);
   475 
   476 /**
   477  *  \brief Retrieve the data pointer associated with a window.
   478  *
   479  *  \param window   The window to query.
   480  *  \param name     The name of the pointer.
   481  *
   482  *  \return The value associated with 'name'
   483  *
   484  *  \sa SDL_SetWindowData()
   485  */
   486 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
   487                                                 const char *name);
   488 
   489 /**
   490  *  \brief Set the position of a window.
   491  *
   492  *  \param window   The window to reposition.
   493  *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   494                     ::SDL_WINDOWPOS_UNDEFINED.
   495  *  \param y        The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   496                     ::SDL_WINDOWPOS_UNDEFINED.
   497  *
   498  *  \note The window coordinate origin is the upper left of the display.
   499  *
   500  *  \sa SDL_GetWindowPosition()
   501  */
   502 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
   503                                                    int x, int y);
   504 
   505 /**
   506  *  \brief Get the position of a window.
   507  *
   508  *  \param window   The window to query.
   509  *  \param x        Pointer to variable for storing the x position, may be NULL
   510  *  \param y        Pointer to variable for storing the y position, may be NULL
   511  *
   512  *  \sa SDL_SetWindowPosition()
   513  */
   514 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
   515                                                    int *x, int *y);
   516 
   517 /**
   518  *  \brief Set the size of a window's client area.
   519  *
   520  *  \param window   The window to resize.
   521  *  \param w        The width of the window, must be >0
   522  *  \param h        The height of the window, must be >0
   523  *
   524  *  \note You can't change the size of a fullscreen window, it automatically
   525  *        matches the size of the display mode.
   526  *
   527  *  \sa SDL_GetWindowSize()
   528  */
   529 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
   530                                                int h);
   531 
   532 /**
   533  *  \brief Get the size of a window's client area.
   534  *
   535  *  \param window   The window to query.
   536  *  \param w        Pointer to variable for storing the width, may be NULL
   537  *  \param h        Pointer to variable for storing the height, may be NULL
   538  *
   539  *  \sa SDL_SetWindowSize()
   540  */
   541 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
   542                                                int *h);
   543 
   544 /**
   545  *  \brief Set the minimum size of a window's client area.
   546  *
   547  *  \param window    The window to set a new minimum size.
   548  *  \param min_w     The minimum width of the window, must be >0
   549  *  \param min_h     The minimum height of the window, must be >0
   550  *
   551  *  \note You can't change the minimum size of a fullscreen window, it
   552  *        automatically matches the size of the display mode.
   553  *
   554  *  \sa SDL_GetWindowMinimumSize()
   555  *  \sa SDL_SetWindowMaximumSize()
   556  */
   557 extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
   558                                                       int min_w, int min_h);
   559 
   560 /**
   561  *  \brief Get the minimum size of a window's client area.
   562  *
   563  *  \param window   The window to query.
   564  *  \param w        Pointer to variable for storing the minimum width, may be NULL
   565  *  \param h        Pointer to variable for storing the minimum height, may be NULL
   566  *
   567  *  \sa SDL_GetWindowMaximumSize()
   568  *  \sa SDL_SetWindowMinimumSize()
   569  */
   570 extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window * window,
   571                                                       int *w, int *h);
   572 
   573 /**
   574  *  \brief Set the maximum size of a window's client area.
   575  *
   576  *  \param window    The window to set a new maximum size.
   577  *  \param max_w     The maximum width of the window, must be >0
   578  *  \param max_h     The maximum height of the window, must be >0
   579  *
   580  *  \note You can't change the maximum size of a fullscreen window, it
   581  *        automatically matches the size of the display mode.
   582  *
   583  *  \sa SDL_GetWindowMaximumSize()
   584  *  \sa SDL_SetWindowMinimumSize()
   585  */
   586 extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
   587                                                       int max_w, int max_h);
   588 
   589 /**
   590  *  \brief Get the maximum size of a window's client area.
   591  *
   592  *  \param window   The window to query.
   593  *  \param w        Pointer to variable for storing the maximum width, may be NULL
   594  *  \param h        Pointer to variable for storing the maximum height, may be NULL
   595  *
   596  *  \sa SDL_GetWindowMinimumSize()
   597  *  \sa SDL_SetWindowMaximumSize()
   598  */
   599 extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window * window,
   600                                                       int *w, int *h);
   601 
   602 /**
   603  *  \brief Set the border state of a window.
   604  *
   605  *  This will add or remove the window's SDL_WINDOW_BORDERLESS flag and
   606  *  add or remove the border from the actual window. This is a no-op if the
   607  *  window's border already matches the requested state.
   608  *
   609  *  \param window The window of which to change the border state.
   610  *  \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
   611  *
   612  *  \note You can't change the border state of a fullscreen window.
   613  *
   614  *  \sa SDL_GetWindowFlags()
   615  */
   616 extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
   617                                                    SDL_bool bordered);
   618 
   619 /**
   620  *  \brief Show a window.
   621  *
   622  *  \sa SDL_HideWindow()
   623  */
   624 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
   625 
   626 /**
   627  *  \brief Hide a window.
   628  *
   629  *  \sa SDL_ShowWindow()
   630  */
   631 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
   632 
   633 /**
   634  *  \brief Raise a window above other windows and set the input focus.
   635  */
   636 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
   637 
   638 /**
   639  *  \brief Make a window as large as possible.
   640  *
   641  *  \sa SDL_RestoreWindow()
   642  */
   643 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
   644 
   645 /**
   646  *  \brief Minimize a window to an iconic representation.
   647  *
   648  *  \sa SDL_RestoreWindow()
   649  */
   650 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
   651 
   652 /**
   653  *  \brief Restore the size and position of a minimized or maximized window.
   654  *
   655  *  \sa SDL_MaximizeWindow()
   656  *  \sa SDL_MinimizeWindow()
   657  */
   658 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
   659 
   660 /**
   661  *  \brief Set a window's fullscreen state.
   662  *
   663  *  \return 0 on success, or -1 if setting the display mode failed.
   664  *
   665  *  \sa SDL_SetWindowDisplayMode()
   666  *  \sa SDL_GetWindowDisplayMode()
   667  */
   668 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
   669                                                     Uint32 flags);
   670 
   671 /**
   672  *  \brief Get the SDL surface associated with the window.
   673  *
   674  *  \return The window's framebuffer surface, or NULL on error.
   675  *
   676  *  A new surface will be created with the optimal format for the window,
   677  *  if necessary. This surface will be freed when the window is destroyed.
   678  *
   679  *  \note You may not combine this with 3D or the rendering API on this window.
   680  *
   681  *  \sa SDL_UpdateWindowSurface()
   682  *  \sa SDL_UpdateWindowSurfaceRects()
   683  */
   684 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window * window);
   685 
   686 /**
   687  *  \brief Copy the window surface to the screen.
   688  *
   689  *  \return 0 on success, or -1 on error.
   690  *
   691  *  \sa SDL_GetWindowSurface()
   692  *  \sa SDL_UpdateWindowSurfaceRects()
   693  */
   694 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window * window);
   695 
   696 /**
   697  *  \brief Copy a number of rectangles on the window surface to the screen.
   698  *
   699  *  \return 0 on success, or -1 on error.
   700  *
   701  *  \sa SDL_GetWindowSurface()
   702  *  \sa SDL_UpdateWindowSurfaceRect()
   703  */
   704 extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window * window,
   705                                                          const SDL_Rect * rects,
   706                                                          int numrects);
   707 
   708 /**
   709  *  \brief Set a window's input grab mode.
   710  *
   711  *  \param window The window for which the input grab mode should be set.
   712  *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
   713  *
   714  *  \sa SDL_GetWindowGrab()
   715  */
   716 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
   717                                                SDL_bool grabbed);
   718 
   719 /**
   720  *  \brief Get a window's input grab mode.
   721  *
   722  *  \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
   723  *
   724  *  \sa SDL_SetWindowGrab()
   725  */
   726 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
   727 
   728 /**
   729  *  \brief Set the brightness (gamma correction) for a window.
   730  *
   731  *  \return 0 on success, or -1 if setting the brightness isn't supported.
   732  *
   733  *  \sa SDL_GetWindowBrightness()
   734  *  \sa SDL_SetWindowGammaRamp()
   735  */
   736 extern DECLSPEC int SDLCALL SDL_SetWindowBrightness(SDL_Window * window, float brightness);
   737 
   738 /**
   739  *  \brief Get the brightness (gamma correction) for a window.
   740  *
   741  *  \return The last brightness value passed to SDL_SetWindowBrightness()
   742  *
   743  *  \sa SDL_SetWindowBrightness()
   744  */
   745 extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
   746 
   747 /**
   748  *  \brief Set the gamma ramp for a window.
   749  *
   750  *  \param window The window for which the gamma ramp should be set.
   751  *  \param red The translation table for the red channel, or NULL.
   752  *  \param green The translation table for the green channel, or NULL.
   753  *  \param blue The translation table for the blue channel, or NULL.
   754  *
   755  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   756  *
   757  *  Set the gamma translation table for the red, green, and blue channels
   758  *  of the video hardware.  Each table is an array of 256 16-bit quantities,
   759  *  representing a mapping between the input and output for that channel.
   760  *  The input is the index into the array, and the output is the 16-bit
   761  *  gamma value at that index, scaled to the output color precision.
   762  *
   763  *  \sa SDL_GetWindowGammaRamp()
   764  */
   765 extern DECLSPEC int SDLCALL SDL_SetWindowGammaRamp(SDL_Window * window,
   766                                                    const Uint16 * red,
   767                                                    const Uint16 * green,
   768                                                    const Uint16 * blue);
   769 
   770 /**
   771  *  \brief Get the gamma ramp for a window.
   772  *
   773  *  \param window The window from which the gamma ramp should be queried.
   774  *  \param red   A pointer to a 256 element array of 16-bit quantities to hold
   775  *               the translation table for the red channel, or NULL.
   776  *  \param green A pointer to a 256 element array of 16-bit quantities to hold
   777  *               the translation table for the green channel, or NULL.
   778  *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold
   779  *               the translation table for the blue channel, or NULL.
   780  *
   781  *  \return 0 on success, or -1 if gamma ramps are unsupported.
   782  *
   783  *  \sa SDL_SetWindowGammaRamp()
   784  */
   785 extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
   786                                                    Uint16 * red,
   787                                                    Uint16 * green,
   788                                                    Uint16 * blue);
   789 
   790 /**
   791  *  \brief Destroy a window.
   792  */
   793 extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window * window);
   794 
   795 
   796 /**
   797  *  \brief Returns whether the screensaver is currently enabled (default on).
   798  *
   799  *  \sa SDL_EnableScreenSaver()
   800  *  \sa SDL_DisableScreenSaver()
   801  */
   802 extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
   803 
   804 /**
   805  *  \brief Allow the screen to be blanked by a screensaver
   806  *
   807  *  \sa SDL_IsScreenSaverEnabled()
   808  *  \sa SDL_DisableScreenSaver()
   809  */
   810 extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
   811 
   812 /**
   813  *  \brief Prevent the screen from being blanked by a screensaver
   814  *
   815  *  \sa SDL_IsScreenSaverEnabled()
   816  *  \sa SDL_EnableScreenSaver()
   817  */
   818 extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
   819 
   820 
   821 /**
   822  *  \name OpenGL support functions
   823  */
   824 /*@{*/
   825 
   826 /**
   827  *  \brief Dynamically load an OpenGL library.
   828  *
   829  *  \param path The platform dependent OpenGL library name, or NULL to open the
   830  *              default OpenGL library.
   831  *
   832  *  \return 0 on success, or -1 if the library couldn't be loaded.
   833  *
   834  *  This should be done after initializing the video driver, but before
   835  *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
   836  *  library will be loaded upon creation of the first OpenGL window.
   837  *
   838  *  \note If you do this, you need to retrieve all of the GL functions used in
   839  *        your program from the dynamic library using SDL_GL_GetProcAddress().
   840  *
   841  *  \sa SDL_GL_GetProcAddress()
   842  *  \sa SDL_GL_UnloadLibrary()
   843  */
   844 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
   845 
   846 /**
   847  *  \brief Get the address of an OpenGL function.
   848  */
   849 extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
   850 
   851 /**
   852  *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
   853  *
   854  *  \sa SDL_GL_LoadLibrary()
   855  */
   856 extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
   857 
   858 /**
   859  *  \brief Return true if an OpenGL extension is supported for the current
   860  *         context.
   861  */
   862 extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
   863                                                            *extension);
   864 
   865 /**
   866  *  \brief Set an OpenGL window attribute before window creation.
   867  */
   868 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
   869 
   870 /**
   871  *  \brief Get the actual value for an attribute from the current context.
   872  */
   873 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
   874 
   875 /**
   876  *  \brief Create an OpenGL context for use with an OpenGL window, and make it
   877  *         current.
   878  *
   879  *  \sa SDL_GL_DeleteContext()
   880  */
   881 extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
   882                                                            window);
   883 
   884 /**
   885  *  \brief Set up an OpenGL context for rendering into an OpenGL window.
   886  *
   887  *  \note The context must have been created with a compatible window.
   888  */
   889 extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
   890                                                SDL_GLContext context);
   891 
   892 /**
   893  *  \brief Set the swap interval for the current OpenGL context.
   894  *
   895  *  \param interval 0 for immediate updates, 1 for updates synchronized with the
   896  *                  vertical retrace. If the system supports it, you may
   897  *                  specify -1 to allow late swaps to happen immediately
   898  *                  instead of waiting for the next retrace.
   899  *
   900  *  \return 0 on success, or -1 if setting the swap interval is not supported.
   901  *
   902  *  \sa SDL_GL_GetSwapInterval()
   903  */
   904 extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
   905 
   906 /**
   907  *  \brief Get the swap interval for the current OpenGL context.
   908  *
   909  *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer
   910  *          swap is synchronized with the vertical retrace, and -1 if late
   911  *          swaps happen immediately instead of waiting for the next retrace.
   912  *          If the system can't determine the swap interval, or there isn't a
   913  *          valid current context, this will return 0 as a safe default.
   914  *
   915  *  \sa SDL_GL_SetSwapInterval()
   916  */
   917 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
   918 
   919 /**
   920  * \brief Swap the OpenGL buffers for a window, if double-buffering is
   921  *        supported.
   922  */
   923 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
   924 
   925 /**
   926  *  \brief Delete an OpenGL context.
   927  *
   928  *  \sa SDL_GL_CreateContext()
   929  */
   930 extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
   931 
   932 /*@}*//*OpenGL support functions*/
   933 
   934 
   935 /* Ends C function definitions when using C++ */
   936 #ifdef __cplusplus
   937 }
   938 #endif
   939 #include "close_code.h"
   940 
   941 #endif /* _SDL_video_h */
   942 
   943 /* vi: set ts=4 sw=4 expandtab: */