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