include/SDL_video.h
changeset 7191 75360622e65f
parent 7188 20bd120bf7e4
child 7412 50211a1fd557
     1.1 --- a/include/SDL_video.h	Sat May 18 12:48:50 2013 -0700
     1.2 +++ b/include/SDL_video.h	Sat May 18 14:17:52 2013 -0700
     1.3 @@ -21,7 +21,7 @@
     1.4  
     1.5  /**
     1.6   *  \file SDL_video.h
     1.7 - *  
     1.8 + *
     1.9   *  Header file for SDL video functions.
    1.10   */
    1.11  
    1.12 @@ -36,14 +36,12 @@
    1.13  #include "begin_code.h"
    1.14  /* Set up for C function definitions, even when using C++ */
    1.15  #ifdef __cplusplus
    1.16 -/* *INDENT-OFF* */
    1.17  extern "C" {
    1.18 -/* *INDENT-ON* */
    1.19  #endif
    1.20  
    1.21  /**
    1.22   *  \brief  The structure that defines a display mode
    1.23 - *  
    1.24 + *
    1.25   *  \sa SDL_GetNumDisplayModes()
    1.26   *  \sa SDL_GetDisplayMode()
    1.27   *  \sa SDL_GetDesktopDisplayMode()
    1.28 @@ -63,7 +61,7 @@
    1.29  
    1.30  /**
    1.31   *  \brief The type used to identify a window
    1.32 - *  
    1.33 + *
    1.34   *  \sa SDL_CreateWindow()
    1.35   *  \sa SDL_CreateWindowFrom()
    1.36   *  \sa SDL_DestroyWindow()
    1.37 @@ -92,7 +90,7 @@
    1.38  
    1.39  /**
    1.40   *  \brief The flags on a window
    1.41 - *  
    1.42 + *
    1.43   *  \sa SDL_GetWindowFlags()
    1.44   */
    1.45  typedef enum
    1.46 @@ -108,7 +106,7 @@
    1.47      SDL_WINDOW_INPUT_GRABBED = 0x00000100,      /**< window has grabbed input focus */
    1.48      SDL_WINDOW_INPUT_FOCUS = 0x00000200,        /**< window has input focus */
    1.49      SDL_WINDOW_MOUSE_FOCUS = 0x00000400,        /**< window has mouse focus */
    1.50 -	SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
    1.51 +    SDL_WINDOW_FULLSCREEN_DESKTOP = ( SDL_WINDOW_FULLSCREEN | 0x00001000 ),
    1.52      SDL_WINDOW_FOREIGN = 0x00000800             /**< window not created by SDL */
    1.53  } SDL_WindowFlags;
    1.54  
    1.55 @@ -138,9 +136,9 @@
    1.56      SDL_WINDOWEVENT_NONE,           /**< Never used */
    1.57      SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
    1.58      SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
    1.59 -    SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be 
    1.60 +    SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be
    1.61                                           redrawn */
    1.62 -    SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2 
    1.63 +    SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2
    1.64                                       */
    1.65      SDL_WINDOWEVENT_RESIZED,        /**< Window has been resized to data1xdata2 */
    1.66      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. */
    1.67 @@ -152,7 +150,7 @@
    1.68      SDL_WINDOWEVENT_LEAVE,          /**< Window has lost mouse focus */
    1.69      SDL_WINDOWEVENT_FOCUS_GAINED,   /**< Window has gained keyboard focus */
    1.70      SDL_WINDOWEVENT_FOCUS_LOST,     /**< Window has lost keyboard focus */
    1.71 -    SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the 
    1.72 +    SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the
    1.73                                           window be closed */
    1.74  } SDL_WindowEventID;
    1.75  
    1.76 @@ -211,52 +209,52 @@
    1.77  
    1.78  /**
    1.79   *  \brief Get the number of video drivers compiled into SDL
    1.80 - *  
    1.81 + *
    1.82   *  \sa SDL_GetVideoDriver()
    1.83   */
    1.84  extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
    1.85  
    1.86  /**
    1.87   *  \brief Get the name of a built in video driver.
    1.88 - *  
    1.89 + *
    1.90   *  \note The video drivers are presented in the order in which they are
    1.91   *        normally checked during initialization.
    1.92 - *  
    1.93 + *
    1.94   *  \sa SDL_GetNumVideoDrivers()
    1.95   */
    1.96  extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
    1.97  
    1.98  /**
    1.99   *  \brief Initialize the video subsystem, optionally specifying a video driver.
   1.100 - *  
   1.101 - *  \param driver_name Initialize a specific driver by name, or NULL for the 
   1.102 + *
   1.103 + *  \param driver_name Initialize a specific driver by name, or NULL for the
   1.104   *                     default video driver.
   1.105 - *  
   1.106 + *
   1.107   *  \return 0 on success, -1 on error
   1.108 - *  
   1.109 + *
   1.110   *  This function initializes the video subsystem; setting up a connection
   1.111   *  to the window manager, etc, and determines the available display modes
   1.112   *  and pixel formats, but does not initialize a window or graphics mode.
   1.113 - *  
   1.114 + *
   1.115   *  \sa SDL_VideoQuit()
   1.116   */
   1.117  extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name);
   1.118  
   1.119  /**
   1.120   *  \brief Shuts down the video subsystem.
   1.121 - *  
   1.122 + *
   1.123   *  This function closes all windows, and restores the original video mode.
   1.124 - *  
   1.125 + *
   1.126   *  \sa SDL_VideoInit()
   1.127   */
   1.128  extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   1.129  
   1.130  /**
   1.131   *  \brief Returns the name of the currently initialized video driver.
   1.132 - *  
   1.133 + *
   1.134   *  \return The name of the current video driver or NULL if no driver
   1.135   *          has been initialized
   1.136 - *  
   1.137 + *
   1.138   *  \sa SDL_GetNumVideoDrivers()
   1.139   *  \sa SDL_GetVideoDriver()
   1.140   */
   1.141 @@ -264,16 +262,16 @@
   1.142  
   1.143  /**
   1.144   *  \brief Returns the number of available video displays.
   1.145 - *  
   1.146 + *
   1.147   *  \sa SDL_GetDisplayBounds()
   1.148   */
   1.149  extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   1.150  
   1.151  /**
   1.152   *  \brief Get the name of a display in UTF-8 encoding
   1.153 - *  
   1.154 + *
   1.155   *  \return The name of a display, or NULL for an invalid display index.
   1.156 - *  
   1.157 + *
   1.158   *  \sa SDL_GetNumVideoDisplays()
   1.159   */
   1.160  extern DECLSPEC const char * SDLCALL SDL_GetDisplayName(int displayIndex);
   1.161 @@ -281,29 +279,29 @@
   1.162  /**
   1.163   *  \brief Get the desktop area represented by a display, with the primary
   1.164   *         display located at 0,0
   1.165 - *  
   1.166 + *
   1.167   *  \return 0 on success, or -1 if the index is out of range.
   1.168 - *  
   1.169 + *
   1.170   *  \sa SDL_GetNumVideoDisplays()
   1.171   */
   1.172  extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
   1.173  
   1.174  /**
   1.175   *  \brief Returns the number of available display modes.
   1.176 - *  
   1.177 + *
   1.178   *  \sa SDL_GetDisplayMode()
   1.179   */
   1.180  extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
   1.181  
   1.182  /**
   1.183   *  \brief Fill in information about a specific display mode.
   1.184 - *  
   1.185 + *
   1.186   *  \note The display modes are sorted in this priority:
   1.187   *        \li bits per pixel -> more colors to fewer colors
   1.188   *        \li width -> largest to smallest
   1.189   *        \li height -> largest to smallest
   1.190   *        \li refresh rate -> highest to lowest
   1.191 - *  
   1.192 + *
   1.193   *  \sa SDL_GetNumDisplayModes()
   1.194   */
   1.195  extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
   1.196 @@ -322,22 +320,22 @@
   1.197  
   1.198  /**
   1.199   *  \brief Get the closest match to the requested display mode.
   1.200 - *  
   1.201 + *
   1.202   *  \param displayIndex The index of display from which mode should be queried.
   1.203   *  \param mode The desired display mode
   1.204 - *  \param closest A pointer to a display mode to be filled in with the closest 
   1.205 + *  \param closest A pointer to a display mode to be filled in with the closest
   1.206   *                 match of the available display modes.
   1.207 - *  
   1.208 - *  \return The passed in value \c closest, or NULL if no matching video mode 
   1.209 + *
   1.210 + *  \return The passed in value \c closest, or NULL if no matching video mode
   1.211   *          was available.
   1.212 - *  
   1.213 + *
   1.214   *  The available display modes are scanned, and \c closest is filled in with the
   1.215 - *  closest mode matching the requested mode and returned.  The mode format and 
   1.216 - *  refresh_rate default to the desktop mode if they are 0.  The modes are 
   1.217 - *  scanned with size being first priority, format being second priority, and 
   1.218 - *  finally checking the refresh_rate.  If all the available modes are too 
   1.219 + *  closest mode matching the requested mode and returned.  The mode format and
   1.220 + *  refresh_rate default to the desktop mode if they are 0.  The modes are
   1.221 + *  scanned with size being first priority, format being second priority, and
   1.222 + *  finally checking the refresh_rate.  If all the available modes are too
   1.223   *  small, then NULL is returned.
   1.224 - *  
   1.225 + *
   1.226   *  \sa SDL_GetNumDisplayModes()
   1.227   *  \sa SDL_GetDisplayMode()
   1.228   */
   1.229 @@ -345,7 +343,7 @@
   1.230  
   1.231  /**
   1.232   *  \brief Get the display index associated with a window.
   1.233 - *  
   1.234 + *
   1.235   *  \return the display index of the display containing the center of the
   1.236   *          window, or -1 on error.
   1.237   */
   1.238 @@ -356,12 +354,12 @@
   1.239   *
   1.240   *  By default the window's dimensions and the desktop format and refresh rate
   1.241   *  are used.
   1.242 - *  
   1.243 + *
   1.244   *  \param window The window for which the display mode should be set.
   1.245   *  \param mode The mode to use, or NULL for the default mode.
   1.246 - *  
   1.247 + *
   1.248   *  \return 0 on success, or -1 if setting the display mode failed.
   1.249 - *  
   1.250 + *
   1.251   *  \sa SDL_GetWindowDisplayMode()
   1.252   *  \sa SDL_SetWindowFullscreen()
   1.253   */
   1.254 @@ -386,22 +384,22 @@
   1.255  
   1.256  /**
   1.257   *  \brief Create a window with the specified position, dimensions, and flags.
   1.258 - *  
   1.259 + *
   1.260   *  \param title The title of the window, in UTF-8 encoding.
   1.261 - *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   1.262 + *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
   1.263   *               ::SDL_WINDOWPOS_UNDEFINED.
   1.264 - *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   1.265 + *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
   1.266   *               ::SDL_WINDOWPOS_UNDEFINED.
   1.267   *  \param w     The width of the window.
   1.268   *  \param h     The height of the window.
   1.269 - *  \param flags The flags for the window, a mask of any of the following: 
   1.270 - *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL, 
   1.271 - *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS, 
   1.272 - *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED, 
   1.273 + *  \param flags The flags for the window, a mask of any of the following:
   1.274 + *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL,
   1.275 + *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS,
   1.276 + *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED,
   1.277   *               ::SDL_WINDOW_MINIMIZED,  ::SDL_WINDOW_INPUT_GRABBED.
   1.278 - *  
   1.279 + *
   1.280   *  \return The id of the window created, or zero if window creation failed.
   1.281 - *  
   1.282 + *
   1.283   *  \sa SDL_DestroyWindow()
   1.284   */
   1.285  extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindow(const char *title,
   1.286 @@ -410,11 +408,11 @@
   1.287  
   1.288  /**
   1.289   *  \brief Create an SDL window from an existing native window.
   1.290 - *  
   1.291 + *
   1.292   *  \param data A pointer to driver-dependent window creation data
   1.293 - *  
   1.294 + *
   1.295   *  \return The id of the window created, or zero if window creation failed.
   1.296 - *  
   1.297 + *
   1.298   *  \sa SDL_DestroyWindow()
   1.299   */
   1.300  extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
   1.301 @@ -436,7 +434,7 @@
   1.302  
   1.303  /**
   1.304   *  \brief Set the title of a window, in UTF-8 format.
   1.305 - *  
   1.306 + *
   1.307   *  \sa SDL_GetWindowTitle()
   1.308   */
   1.309  extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
   1.310 @@ -444,14 +442,14 @@
   1.311  
   1.312  /**
   1.313   *  \brief Get the title of a window, in UTF-8 format.
   1.314 - *  
   1.315 + *
   1.316   *  \sa SDL_SetWindowTitle()
   1.317   */
   1.318  extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
   1.319  
   1.320  /**
   1.321   *  \brief Set the icon for a window.
   1.322 - *  
   1.323 + *
   1.324   *  \param window The window for which the icon should be set.
   1.325   *  \param icon The icon for the window.
   1.326   */
   1.327 @@ -460,7 +458,7 @@
   1.328  
   1.329  /**
   1.330   *  \brief Associate an arbitrary named pointer with a window.
   1.331 - *  
   1.332 + *
   1.333   *  \param window   The window to associate with the pointer.
   1.334   *  \param name     The name of the pointer.
   1.335   *  \param userdata The associated pointer.
   1.336 @@ -477,12 +475,12 @@
   1.337  
   1.338  /**
   1.339   *  \brief Retrieve the data pointer associated with a window.
   1.340 - *  
   1.341 + *
   1.342   *  \param window   The window to query.
   1.343   *  \param name     The name of the pointer.
   1.344   *
   1.345   *  \return The value associated with 'name'
   1.346 - *  
   1.347 + *
   1.348   *  \sa SDL_SetWindowData()
   1.349   */
   1.350  extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window,
   1.351 @@ -490,15 +488,15 @@
   1.352  
   1.353  /**
   1.354   *  \brief Set the position of a window.
   1.355 - *  
   1.356 + *
   1.357   *  \param window   The window to reposition.
   1.358   *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   1.359                      ::SDL_WINDOWPOS_UNDEFINED.
   1.360   *  \param y        The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   1.361                      ::SDL_WINDOWPOS_UNDEFINED.
   1.362 - *  
   1.363 + *
   1.364   *  \note The window coordinate origin is the upper left of the display.
   1.365 - *  
   1.366 + *
   1.367   *  \sa SDL_GetWindowPosition()
   1.368   */
   1.369  extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
   1.370 @@ -506,7 +504,7 @@
   1.371  
   1.372  /**
   1.373   *  \brief Get the position of a window.
   1.374 - *  
   1.375 + *
   1.376   *  \param window   The window to query.
   1.377   *  \param x        Pointer to variable for storing the x position, may be NULL
   1.378   *  \param y        Pointer to variable for storing the y position, may be NULL
   1.379 @@ -518,14 +516,14 @@
   1.380  
   1.381  /**
   1.382   *  \brief Set the size of a window's client area.
   1.383 - *  
   1.384 + *
   1.385   *  \param window   The window to resize.
   1.386   *  \param w        The width of the window, must be >0
   1.387   *  \param h        The height of the window, must be >0
   1.388   *
   1.389   *  \note You can't change the size of a fullscreen window, it automatically
   1.390   *        matches the size of the display mode.
   1.391 - *  
   1.392 + *
   1.393   *  \sa SDL_GetWindowSize()
   1.394   */
   1.395  extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
   1.396 @@ -533,19 +531,19 @@
   1.397  
   1.398  /**
   1.399   *  \brief Get the size of a window's client area.
   1.400 - *  
   1.401 + *
   1.402   *  \param window   The window to query.
   1.403   *  \param w        Pointer to variable for storing the width, may be NULL
   1.404   *  \param h        Pointer to variable for storing the height, may be NULL
   1.405 - *  
   1.406 + *
   1.407   *  \sa SDL_SetWindowSize()
   1.408   */
   1.409  extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
   1.410                                                 int *h);
   1.411 -    
   1.412 +
   1.413  /**
   1.414   *  \brief Set the minimum size of a window's client area.
   1.415 - *  
   1.416 + *
   1.417   *  \param window    The window to set a new minimum size.
   1.418   *  \param min_w     The minimum width of the window, must be >0
   1.419   *  \param min_h     The minimum height of the window, must be >0
   1.420 @@ -558,14 +556,14 @@
   1.421   */
   1.422  extern DECLSPEC void SDLCALL SDL_SetWindowMinimumSize(SDL_Window * window,
   1.423                                                        int min_w, int min_h);
   1.424 -    
   1.425 +
   1.426  /**
   1.427   *  \brief Get the minimum size of a window's client area.
   1.428 - *  
   1.429 + *
   1.430   *  \param window   The window to query.
   1.431   *  \param w        Pointer to variable for storing the minimum width, may be NULL
   1.432   *  \param h        Pointer to variable for storing the minimum height, may be NULL
   1.433 - *  
   1.434 + *
   1.435   *  \sa SDL_GetWindowMaximumSize()
   1.436   *  \sa SDL_SetWindowMinimumSize()
   1.437   */
   1.438 @@ -587,10 +585,10 @@
   1.439   */
   1.440  extern DECLSPEC void SDLCALL SDL_SetWindowMaximumSize(SDL_Window * window,
   1.441                                                        int max_w, int max_h);
   1.442 -    
   1.443 +
   1.444  /**
   1.445   *  \brief Get the maximum size of a window's client area.
   1.446 - *  
   1.447 + *
   1.448   *  \param window   The window to query.
   1.449   *  \param w        Pointer to variable for storing the maximum width, may be NULL
   1.450   *  \param h        Pointer to variable for storing the maximum height, may be NULL
   1.451 @@ -612,7 +610,7 @@
   1.452   *  \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
   1.453   *
   1.454   *  \note You can't change the border state of a fullscreen window.
   1.455 - *  
   1.456 + *
   1.457   *  \sa SDL_GetWindowFlags()
   1.458   */
   1.459  extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window * window,
   1.460 @@ -620,14 +618,14 @@
   1.461  
   1.462  /**
   1.463   *  \brief Show a window.
   1.464 - *  
   1.465 + *
   1.466   *  \sa SDL_HideWindow()
   1.467   */
   1.468  extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
   1.469  
   1.470  /**
   1.471   *  \brief Hide a window.
   1.472 - *  
   1.473 + *
   1.474   *  \sa SDL_ShowWindow()
   1.475   */
   1.476  extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
   1.477 @@ -639,21 +637,21 @@
   1.478  
   1.479  /**
   1.480   *  \brief Make a window as large as possible.
   1.481 - *  
   1.482 + *
   1.483   *  \sa SDL_RestoreWindow()
   1.484   */
   1.485  extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
   1.486  
   1.487  /**
   1.488   *  \brief Minimize a window to an iconic representation.
   1.489 - *  
   1.490 + *
   1.491   *  \sa SDL_RestoreWindow()
   1.492   */
   1.493  extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
   1.494  
   1.495  /**
   1.496   *  \brief Restore the size and position of a minimized or maximized window.
   1.497 - *  
   1.498 + *
   1.499   *  \sa SDL_MaximizeWindow()
   1.500   *  \sa SDL_MinimizeWindow()
   1.501   */
   1.502 @@ -661,9 +659,9 @@
   1.503  
   1.504  /**
   1.505   *  \brief Set a window's fullscreen state.
   1.506 - *  
   1.507 + *
   1.508   *  \return 0 on success, or -1 if setting the display mode failed.
   1.509 - *  
   1.510 + *
   1.511   *  \sa SDL_SetWindowDisplayMode()
   1.512   *  \sa SDL_GetWindowDisplayMode()
   1.513   */
   1.514 @@ -673,7 +671,7 @@
   1.515  /**
   1.516   *  \brief Get the SDL surface associated with the window.
   1.517   *
   1.518 - *  \return The window's framebuffer surface, or NULL on error. 
   1.519 + *  \return The window's framebuffer surface, or NULL on error.
   1.520   *
   1.521   *  A new surface will be created with the optimal format for the window,
   1.522   *  if necessary. This surface will be freed when the window is destroyed.
   1.523 @@ -709,10 +707,10 @@
   1.524  
   1.525  /**
   1.526   *  \brief Set a window's input grab mode.
   1.527 - *  
   1.528 + *
   1.529   *  \param window The window for which the input grab mode should be set.
   1.530   *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
   1.531 - *  
   1.532 + *
   1.533   *  \sa SDL_GetWindowGrab()
   1.534   */
   1.535  extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
   1.536 @@ -720,18 +718,18 @@
   1.537  
   1.538  /**
   1.539   *  \brief Get a window's input grab mode.
   1.540 - *  
   1.541 + *
   1.542   *  \return This returns SDL_TRUE if input is grabbed, and SDL_FALSE otherwise.
   1.543 - *  
   1.544 + *
   1.545   *  \sa SDL_SetWindowGrab()
   1.546   */
   1.547  extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window * window);
   1.548  
   1.549  /**
   1.550   *  \brief Set the brightness (gamma correction) for a window.
   1.551 - *  
   1.552 + *
   1.553   *  \return 0 on success, or -1 if setting the brightness isn't supported.
   1.554 - *  
   1.555 + *
   1.556   *  \sa SDL_GetWindowBrightness()
   1.557   *  \sa SDL_SetWindowGammaRamp()
   1.558   */
   1.559 @@ -739,23 +737,23 @@
   1.560  
   1.561  /**
   1.562   *  \brief Get the brightness (gamma correction) for a window.
   1.563 - *  
   1.564 + *
   1.565   *  \return The last brightness value passed to SDL_SetWindowBrightness()
   1.566 - *  
   1.567 + *
   1.568   *  \sa SDL_SetWindowBrightness()
   1.569   */
   1.570  extern DECLSPEC float SDLCALL SDL_GetWindowBrightness(SDL_Window * window);
   1.571  
   1.572  /**
   1.573   *  \brief Set the gamma ramp for a window.
   1.574 - *  
   1.575 + *
   1.576   *  \param window The window for which the gamma ramp should be set.
   1.577   *  \param red The translation table for the red channel, or NULL.
   1.578   *  \param green The translation table for the green channel, or NULL.
   1.579   *  \param blue The translation table for the blue channel, or NULL.
   1.580 - *  
   1.581 + *
   1.582   *  \return 0 on success, or -1 if gamma ramps are unsupported.
   1.583 - *  
   1.584 + *
   1.585   *  Set the gamma translation table for the red, green, and blue channels
   1.586   *  of the video hardware.  Each table is an array of 256 16-bit quantities,
   1.587   *  representing a mapping between the input and output for that channel.
   1.588 @@ -771,17 +769,17 @@
   1.589  
   1.590  /**
   1.591   *  \brief Get the gamma ramp for a window.
   1.592 - *  
   1.593 + *
   1.594   *  \param window The window from which the gamma ramp should be queried.
   1.595 - *  \param red   A pointer to a 256 element array of 16-bit quantities to hold 
   1.596 + *  \param red   A pointer to a 256 element array of 16-bit quantities to hold
   1.597   *               the translation table for the red channel, or NULL.
   1.598 - *  \param green A pointer to a 256 element array of 16-bit quantities to hold 
   1.599 + *  \param green A pointer to a 256 element array of 16-bit quantities to hold
   1.600   *               the translation table for the green channel, or NULL.
   1.601 - *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold 
   1.602 + *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold
   1.603   *               the translation table for the blue channel, or NULL.
   1.604 - *   
   1.605 + *
   1.606   *  \return 0 on success, or -1 if gamma ramps are unsupported.
   1.607 - *  
   1.608 + *
   1.609   *  \sa SDL_SetWindowGammaRamp()
   1.610   */
   1.611  extern DECLSPEC int SDLCALL SDL_GetWindowGammaRamp(SDL_Window * window,
   1.612 @@ -797,7 +795,7 @@
   1.613  
   1.614  /**
   1.615   *  \brief Returns whether the screensaver is currently enabled (default on).
   1.616 - *  
   1.617 + *
   1.618   *  \sa SDL_EnableScreenSaver()
   1.619   *  \sa SDL_DisableScreenSaver()
   1.620   */
   1.621 @@ -805,7 +803,7 @@
   1.622  
   1.623  /**
   1.624   *  \brief Allow the screen to be blanked by a screensaver
   1.625 - *  
   1.626 + *
   1.627   *  \sa SDL_IsScreenSaverEnabled()
   1.628   *  \sa SDL_DisableScreenSaver()
   1.629   */
   1.630 @@ -813,7 +811,7 @@
   1.631  
   1.632  /**
   1.633   *  \brief Prevent the screen from being blanked by a screensaver
   1.634 - *  
   1.635 + *
   1.636   *  \sa SDL_IsScreenSaverEnabled()
   1.637   *  \sa SDL_EnableScreenSaver()
   1.638   */
   1.639 @@ -827,19 +825,19 @@
   1.640  
   1.641  /**
   1.642   *  \brief Dynamically load an OpenGL library.
   1.643 - *  
   1.644 - *  \param path The platform dependent OpenGL library name, or NULL to open the 
   1.645 + *
   1.646 + *  \param path The platform dependent OpenGL library name, or NULL to open the
   1.647   *              default OpenGL library.
   1.648 - *  
   1.649 + *
   1.650   *  \return 0 on success, or -1 if the library couldn't be loaded.
   1.651 - *  
   1.652 + *
   1.653   *  This should be done after initializing the video driver, but before
   1.654   *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
   1.655   *  library will be loaded upon creation of the first OpenGL window.
   1.656 - *  
   1.657 + *
   1.658   *  \note If you do this, you need to retrieve all of the GL functions used in
   1.659   *        your program from the dynamic library using SDL_GL_GetProcAddress().
   1.660 - *  
   1.661 + *
   1.662   *  \sa SDL_GL_GetProcAddress()
   1.663   *  \sa SDL_GL_UnloadLibrary()
   1.664   */
   1.665 @@ -852,13 +850,13 @@
   1.666  
   1.667  /**
   1.668   *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
   1.669 - *  
   1.670 + *
   1.671   *  \sa SDL_GL_LoadLibrary()
   1.672   */
   1.673  extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
   1.674  
   1.675  /**
   1.676 - *  \brief Return true if an OpenGL extension is supported for the current 
   1.677 + *  \brief Return true if an OpenGL extension is supported for the current
   1.678   *         context.
   1.679   */
   1.680  extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
   1.681 @@ -875,9 +873,9 @@
   1.682  extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
   1.683  
   1.684  /**
   1.685 - *  \brief Create an OpenGL context for use with an OpenGL window, and make it 
   1.686 + *  \brief Create an OpenGL context for use with an OpenGL window, and make it
   1.687   *         current.
   1.688 - *  
   1.689 + *
   1.690   *  \sa SDL_GL_DeleteContext()
   1.691   */
   1.692  extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *
   1.693 @@ -885,7 +883,7 @@
   1.694  
   1.695  /**
   1.696   *  \brief Set up an OpenGL context for rendering into an OpenGL window.
   1.697 - *  
   1.698 + *
   1.699   *  \note The context must have been created with a compatible window.
   1.700   */
   1.701  extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window * window,
   1.702 @@ -893,40 +891,40 @@
   1.703  
   1.704  /**
   1.705   *  \brief Set the swap interval for the current OpenGL context.
   1.706 - *  
   1.707 + *
   1.708   *  \param interval 0 for immediate updates, 1 for updates synchronized with the
   1.709   *                  vertical retrace. If the system supports it, you may
   1.710   *                  specify -1 to allow late swaps to happen immediately
   1.711   *                  instead of waiting for the next retrace.
   1.712 - *  
   1.713 + *
   1.714   *  \return 0 on success, or -1 if setting the swap interval is not supported.
   1.715 - *  
   1.716 + *
   1.717   *  \sa SDL_GL_GetSwapInterval()
   1.718   */
   1.719  extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
   1.720  
   1.721  /**
   1.722   *  \brief Get the swap interval for the current OpenGL context.
   1.723 - *  
   1.724 - *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer 
   1.725 + *
   1.726 + *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer
   1.727   *          swap is synchronized with the vertical retrace, and -1 if late
   1.728   *          swaps happen immediately instead of waiting for the next retrace.
   1.729   *          If the system can't determine the swap interval, or there isn't a
   1.730   *          valid current context, this will return 0 as a safe default.
   1.731 - *  
   1.732 + *
   1.733   *  \sa SDL_GL_SetSwapInterval()
   1.734   */
   1.735  extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
   1.736  
   1.737  /**
   1.738 - * \brief Swap the OpenGL buffers for a window, if double-buffering is 
   1.739 + * \brief Swap the OpenGL buffers for a window, if double-buffering is
   1.740   *        supported.
   1.741   */
   1.742  extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
   1.743  
   1.744  /**
   1.745   *  \brief Delete an OpenGL context.
   1.746 - *  
   1.747 + *
   1.748   *  \sa SDL_GL_CreateContext()
   1.749   */
   1.750  extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
   1.751 @@ -936,9 +934,7 @@
   1.752  
   1.753  /* Ends C function definitions when using C++ */
   1.754  #ifdef __cplusplus
   1.755 -/* *INDENT-OFF* */
   1.756  }
   1.757 -/* *INDENT-ON* */
   1.758  #endif
   1.759  #include "close_code.h"
   1.760