include/SDL_video.h
changeset 3407 d3baf5ac4e37
parent 3400 4ec48602f1db
child 3435 9f62f47d989b
     1.1 --- a/include/SDL_video.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_video.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -21,9 +21,9 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 - * \file SDL_video.h
     1.8 - *
     1.9 - * Header file for SDL video functions.
    1.10 + *  \file SDL_video.h
    1.11 + *  
    1.12 + *  Header file for SDL video functions.
    1.13   */
    1.14  
    1.15  #ifndef _SDL_video_h
    1.16 @@ -43,16 +43,14 @@
    1.17  #endif
    1.18  
    1.19  /**
    1.20 - * \struct SDL_DisplayMode
    1.21 - *
    1.22 - * \brief  The structure that defines a display mode
    1.23 - *
    1.24 - * \sa SDL_GetNumDisplayModes()
    1.25 - * \sa SDL_GetDisplayMode()
    1.26 - * \sa SDL_GetDesktopDisplayMode()
    1.27 - * \sa SDL_GetCurrentDisplayMode()
    1.28 - * \sa SDL_GetClosestDisplayMode()
    1.29 - * \sa SDL_SetDisplayMode()
    1.30 + *  \brief  The structure that defines a display mode
    1.31 + *  
    1.32 + *  \sa SDL_GetNumDisplayModes()
    1.33 + *  \sa SDL_GetDisplayMode()
    1.34 + *  \sa SDL_GetDesktopDisplayMode()
    1.35 + *  \sa SDL_GetCurrentDisplayMode()
    1.36 + *  \sa SDL_GetClosestDisplayMode()
    1.37 + *  \sa SDL_SetDisplayMode()
    1.38   */
    1.39  typedef struct
    1.40  {
    1.41 @@ -64,41 +62,37 @@
    1.42  } SDL_DisplayMode;
    1.43  
    1.44  /**
    1.45 - * \typedef SDL_WindowID
    1.46 - *
    1.47 - * \brief The type used to identify a window
    1.48 - *
    1.49 - * \sa SDL_CreateWindow()
    1.50 - * \sa SDL_CreateWindowFrom()
    1.51 - * \sa SDL_DestroyWindow()
    1.52 - * \sa SDL_GetWindowData()
    1.53 - * \sa SDL_GetWindowFlags()
    1.54 - * \sa SDL_GetWindowGrab()
    1.55 - * \sa SDL_GetWindowPosition()
    1.56 - * \sa SDL_GetWindowSize()
    1.57 - * \sa SDL_GetWindowTitle()
    1.58 - * \sa SDL_HideWindow()
    1.59 - * \sa SDL_MaximizeWindow()
    1.60 - * \sa SDL_MinimizeWindow()
    1.61 - * \sa SDL_RaiseWindow()
    1.62 - * \sa SDL_RestoreWindow()
    1.63 - * \sa SDL_SetWindowData()
    1.64 - * \sa SDL_SetWindowFullscreen()
    1.65 - * \sa SDL_SetWindowGrab()
    1.66 - * \sa SDL_SetWindowIcon()
    1.67 - * \sa SDL_SetWindowPosition()
    1.68 - * \sa SDL_SetWindowSize()
    1.69 - * \sa SDL_SetWindowTitle()
    1.70 - * \sa SDL_ShowWindow()
    1.71 + *  \brief The type used to identify a window
    1.72 + *  
    1.73 + *  \sa SDL_CreateWindow()
    1.74 + *  \sa SDL_CreateWindowFrom()
    1.75 + *  \sa SDL_DestroyWindow()
    1.76 + *  \sa SDL_GetWindowData()
    1.77 + *  \sa SDL_GetWindowFlags()
    1.78 + *  \sa SDL_GetWindowGrab()
    1.79 + *  \sa SDL_GetWindowPosition()
    1.80 + *  \sa SDL_GetWindowSize()
    1.81 + *  \sa SDL_GetWindowTitle()
    1.82 + *  \sa SDL_HideWindow()
    1.83 + *  \sa SDL_MaximizeWindow()
    1.84 + *  \sa SDL_MinimizeWindow()
    1.85 + *  \sa SDL_RaiseWindow()
    1.86 + *  \sa SDL_RestoreWindow()
    1.87 + *  \sa SDL_SetWindowData()
    1.88 + *  \sa SDL_SetWindowFullscreen()
    1.89 + *  \sa SDL_SetWindowGrab()
    1.90 + *  \sa SDL_SetWindowIcon()
    1.91 + *  \sa SDL_SetWindowPosition()
    1.92 + *  \sa SDL_SetWindowSize()
    1.93 + *  \sa SDL_SetWindowTitle()
    1.94 + *  \sa SDL_ShowWindow()
    1.95   */
    1.96  typedef Uint32 SDL_WindowID;
    1.97  
    1.98  /**
    1.99 - * \enum SDL_WindowFlags
   1.100 - *
   1.101 - * \brief The flags on a window
   1.102 - *
   1.103 - * \sa SDL_GetWindowFlags()
   1.104 + *  \brief The flags on a window
   1.105 + *  
   1.106 + *  \sa SDL_GetWindowFlags()
   1.107   */
   1.108  typedef enum
   1.109  {
   1.110 @@ -116,64 +110,80 @@
   1.111  } SDL_WindowFlags;
   1.112  
   1.113  /**
   1.114 - * \def SDL_WINDOWPOS_UNDEFINED
   1.115 - * \brief Used to indicate that you don't care what the window position is.
   1.116 + *  \brief Used to indicate that you don't care what the window position is.
   1.117   */
   1.118  #define SDL_WINDOWPOS_UNDEFINED 0x7FFFFFF
   1.119 +
   1.120  /**
   1.121 - * \def SDL_WINDOWPOS_CENTERED
   1.122 - * \brief Used to indicate that the window position should be centered.
   1.123 + *  \brief Used to indicate that the window position should be centered.
   1.124   */
   1.125  #define SDL_WINDOWPOS_CENTERED  0x7FFFFFE
   1.126  
   1.127  /**
   1.128 - * \enum SDL_WindowEventID
   1.129 - *
   1.130 - * \brief Event subtype for window events
   1.131 + *  \brief Event subtype for window events
   1.132   */
   1.133  typedef enum
   1.134  {
   1.135 -    SDL_WINDOWEVENT_NONE,               /**< Never used */
   1.136 -    SDL_WINDOWEVENT_SHOWN,              /**< Window has been shown */
   1.137 -    SDL_WINDOWEVENT_HIDDEN,             /**< Window has been hidden */
   1.138 -    SDL_WINDOWEVENT_EXPOSED,            /**< Window has been exposed and should be redrawn */
   1.139 -    SDL_WINDOWEVENT_MOVED,              /**< Window has been moved to data1,data2 */
   1.140 -    SDL_WINDOWEVENT_RESIZED,            /**< Window size changed to data1xdata2 */
   1.141 -    SDL_WINDOWEVENT_MINIMIZED,          /**< Window has been minimized */
   1.142 -    SDL_WINDOWEVENT_MAXIMIZED,          /**< Window has been maximized */
   1.143 -    SDL_WINDOWEVENT_RESTORED,           /**< Window has been restored to normal size and position */
   1.144 -    SDL_WINDOWEVENT_ENTER,              /**< The window has gained mouse focus */
   1.145 -    SDL_WINDOWEVENT_LEAVE,              /**< The window has lost mouse focus */
   1.146 -    SDL_WINDOWEVENT_FOCUS_GAINED,       /**< The window has gained keyboard focus */
   1.147 -    SDL_WINDOWEVENT_FOCUS_LOST,         /**< The window has lost keyboard focus */
   1.148 -    SDL_WINDOWEVENT_CLOSE               /**< The window manager requests that the window be closed */
   1.149 +    SDL_WINDOWEVENT_NONE,           /**< Never used */
   1.150 +    SDL_WINDOWEVENT_SHOWN,          /**< Window has been shown */
   1.151 +    SDL_WINDOWEVENT_HIDDEN,         /**< Window has been hidden */
   1.152 +    SDL_WINDOWEVENT_EXPOSED,        /**< Window has been exposed and should be 
   1.153 +                                         redrawn */
   1.154 +    SDL_WINDOWEVENT_MOVED,          /**< Window has been moved to data1, data2 
   1.155 +                                     */
   1.156 +    SDL_WINDOWEVENT_RESIZED,        /**< Window size changed to data1xdata2 */
   1.157 +    SDL_WINDOWEVENT_MINIMIZED,      /**< Window has been minimized */
   1.158 +    SDL_WINDOWEVENT_MAXIMIZED,      /**< Window has been maximized */
   1.159 +    SDL_WINDOWEVENT_RESTORED,       /**< Window has been restored to normal size
   1.160 +                                         and position */
   1.161 +    SDL_WINDOWEVENT_ENTER,          /**< The window has gained mouse focus */
   1.162 +    SDL_WINDOWEVENT_LEAVE,          /**< The window has lost mouse focus */
   1.163 +    SDL_WINDOWEVENT_FOCUS_GAINED,   /**< The window has gained keyboard focus */
   1.164 +    SDL_WINDOWEVENT_FOCUS_LOST,     /**< The window has lost keyboard focus */
   1.165 +    SDL_WINDOWEVENT_CLOSE           /**< The window manager requests that the 
   1.166 +                                         window be closed */
   1.167  } SDL_WindowEventID;
   1.168  
   1.169  /**
   1.170 - * \enum SDL_RendererFlags
   1.171 - *
   1.172 - * \brief Flags used when creating a rendering context
   1.173 + *  \brief Flags used when creating a rendering context
   1.174   */
   1.175  typedef enum
   1.176  {
   1.177 -    SDL_RENDERER_SINGLEBUFFER = 0x00000001,     /**< Render directly to the window, if possible */
   1.178 -    SDL_RENDERER_PRESENTCOPY = 0x00000002,      /**< Present uses a copy from back buffer to the front buffer */
   1.179 -    SDL_RENDERER_PRESENTFLIP2 = 0x00000004,     /**< Present uses a flip, swapping back buffer and front buffer */
   1.180 -    SDL_RENDERER_PRESENTFLIP3 = 0x00000008,     /**< Present uses a flip, rotating between two back buffers and a front buffer */
   1.181 -    SDL_RENDERER_PRESENTDISCARD = 0x00000010,   /**< Present leaves the contents of the backbuffer undefined */
   1.182 -    SDL_RENDERER_PRESENTVSYNC = 0x00000020,     /**< Present is synchronized with the refresh rate */
   1.183 -    SDL_RENDERER_ACCELERATED = 0x00000040       /**< The renderer uses hardware acceleration */
   1.184 -} SDL_RendererFlags;
   1.185 +    SDL_RENDERER_SINGLEBUFFER = 0x00000001,     /**< Render directly to the 
   1.186 +                                                     window, if possible */
   1.187 +    
   1.188 +    SDL_RENDERER_PRESENTCOPY = 0x00000002,      /**< Present uses a copy from 
   1.189 +                                                     back buffer to the front 
   1.190 +                                                     buffer */
   1.191 +    
   1.192 +    SDL_RENDERER_PRESENTFLIP2 = 0x00000004,     /**< Present uses a flip, 
   1.193 +                                                     swapping back buffer and 
   1.194 +                                                     front buffer */
   1.195 +    
   1.196 +    SDL_RENDERER_PRESENTFLIP3 = 0x00000008,     /**< Present uses a flip, 
   1.197 +                                                     rotating between two back 
   1.198 +                                                     buffers and a front buffer
   1.199 +                                                 */
   1.200 +    
   1.201 +    SDL_RENDERER_PRESENTDISCARD = 0x00000010,   /**< Present leaves the contents
   1.202 +                                                     of the backbuffer undefined
   1.203 +                                                 */
   1.204 +    
   1.205 +    SDL_RENDERER_PRESENTVSYNC = 0x00000020,     /**< Present is synchronized 
   1.206 +                                                     with the refresh rate */
   1.207 +    
   1.208 +    SDL_RENDERER_ACCELERATED = 0x00000040       /**< The renderer uses hardware 
   1.209 +                                                     acceleration */
   1.210 +    
   1.211 +    } SDL_RendererFlags;
   1.212  
   1.213  /**
   1.214 - * \struct SDL_RendererInfo
   1.215 - *
   1.216 - * \brief Information on the capabilities of a render driver or context
   1.217 + *  \brief Information on the capabilities of a render driver or context.
   1.218   */
   1.219  typedef struct SDL_RendererInfo
   1.220  {
   1.221      const char *name;           /**< The name of the renderer */
   1.222 -    Uint32 flags;               /**< Supported SDL_RendererFlags */
   1.223 +    Uint32 flags;               /**< Supported ::SDL_RendererFlags */
   1.224      Uint32 mod_modes;           /**< A mask of supported channel modulation */
   1.225      Uint32 blend_modes;         /**< A mask of supported blend modes */
   1.226      Uint32 scale_modes;         /**< A mask of supported scale modes */
   1.227 @@ -184,9 +194,7 @@
   1.228  } SDL_RendererInfo;
   1.229  
   1.230  /**
   1.231 - * \enum SDL_TextureAccess
   1.232 - *
   1.233 - * \brief The access pattern allowed for a texture
   1.234 + *  \brief The access pattern allowed for a texture.
   1.235   */
   1.236  typedef enum
   1.237  {
   1.238 @@ -195,9 +203,7 @@
   1.239  } SDL_TextureAccess;
   1.240  
   1.241  /**
   1.242 - * \enum SDL_TextureModulate
   1.243 - *
   1.244 - * \brief The texture channel modulation used in SDL_RenderCopy()
   1.245 + *  \brief The texture channel modulation used in SDL_RenderCopy().
   1.246   */
   1.247  typedef enum
   1.248  {
   1.249 @@ -207,50 +213,49 @@
   1.250  } SDL_TextureModulate;
   1.251  
   1.252  /**
   1.253 - * \enum SDL_BlendMode
   1.254 - *
   1.255 - * \brief The blend mode used in SDL_RenderCopy() and drawing operations
   1.256 + *  \brief The blend mode used in SDL_RenderCopy() and drawing operations.
   1.257   */
   1.258  typedef enum
   1.259  {
   1.260      SDL_BLENDMODE_NONE = 0x00000000,     /**< No blending */
   1.261 -    SDL_BLENDMODE_MASK = 0x00000001,     /**< dst = A ? src : dst (alpha is mask) */
   1.262 +    SDL_BLENDMODE_MASK = 0x00000001,     /**< dst = A ? src : dst 
   1.263 +                                              (alpha is mask) */
   1.264 +    
   1.265      SDL_BLENDMODE_BLEND = 0x00000002,    /**< dst = (src * A) + (dst * (1-A)) */
   1.266      SDL_BLENDMODE_ADD = 0x00000004,      /**< dst = (src * A) + dst */
   1.267      SDL_BLENDMODE_MOD = 0x00000008       /**< dst = src * dst */
   1.268  } SDL_BlendMode;
   1.269  
   1.270  /**
   1.271 - * \enum SDL_TextureScaleMode
   1.272 - *
   1.273 - * \brief The texture scale mode used in SDL_RenderCopy()
   1.274 + *  \brief The texture scale mode used in SDL_RenderCopy().
   1.275   */
   1.276  typedef enum
   1.277  {
   1.278 -    SDL_TEXTURESCALEMODE_NONE = 0x00000000,     /**< No scaling, rectangles must match dimensions */
   1.279 -    SDL_TEXTURESCALEMODE_FAST = 0x00000001,     /**< Point sampling or equivalent algorithm */
   1.280 -    SDL_TEXTURESCALEMODE_SLOW = 0x00000002,     /**< Linear filtering or equivalent algorithm */
   1.281 -    SDL_TEXTURESCALEMODE_BEST = 0x00000004      /**< Bicubic filtering or equivalent algorithm */
   1.282 +    SDL_TEXTURESCALEMODE_NONE = 0x00000000,     /**< No scaling, rectangles must
   1.283 +                                                     match dimensions */
   1.284 +    
   1.285 +    SDL_TEXTURESCALEMODE_FAST = 0x00000001,     /**< Point sampling or 
   1.286 +                                                     equivalent algorithm */
   1.287 +    
   1.288 +    SDL_TEXTURESCALEMODE_SLOW = 0x00000002,     /**< Linear filtering or 
   1.289 +                                                     equivalent algorithm */
   1.290 +    
   1.291 +    SDL_TEXTURESCALEMODE_BEST = 0x00000004      /**< Bicubic filtering or 
   1.292 +                                                     equivalent algorithm */
   1.293  } SDL_TextureScaleMode;
   1.294  
   1.295  /**
   1.296 - * \typedef SDL_TextureID
   1.297 - *
   1.298 - * \brief An efficient driver-specific representation of pixel data
   1.299 + *  \brief An efficient driver-specific representation of pixel data
   1.300   */
   1.301  typedef Uint32 SDL_TextureID;
   1.302  
   1.303  /**
   1.304 - * \typedef SDL_GLContext
   1.305 - *
   1.306 - * \brief An opaque handle to an OpenGL context.
   1.307 + *  \brief An opaque handle to an OpenGL context.
   1.308   */
   1.309  typedef void *SDL_GLContext;
   1.310  
   1.311  /**
   1.312 - * \enum SDL_GLattr
   1.313 - *
   1.314 - * \brief OpenGL configuration attributes
   1.315 + *  \brief OpenGL configuration attributes
   1.316   */
   1.317  typedef enum
   1.318  {
   1.319 @@ -279,156 +284,140 @@
   1.320  /* Function prototypes */
   1.321  
   1.322  /**
   1.323 - * \fn int SDL_GetNumVideoDrivers(void)
   1.324 - *
   1.325 - * \brief Get the number of video drivers compiled into SDL
   1.326 - *
   1.327 - * \sa SDL_GetVideoDriver()
   1.328 + *  \brief Get the number of video drivers compiled into SDL
   1.329 + *  
   1.330 + *  \sa SDL_GetVideoDriver()
   1.331   */
   1.332  extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
   1.333  
   1.334  /**
   1.335 - * \fn const char *SDL_GetVideoDriver(int index)
   1.336 - *
   1.337 - * \brief Get the name of a built in video driver.
   1.338 - *
   1.339 - * \note The video drivers are presented in the order in which they are
   1.340 - * normally checked during initialization.
   1.341 - *
   1.342 - * \sa SDL_GetNumVideoDrivers()
   1.343 + *  \brief Get the name of a built in video driver.
   1.344 + *  
   1.345 + *  \note The video drivers are presented in the order in which they are
   1.346 + *        normally checked during initialization.
   1.347 + *  
   1.348 + *  \sa SDL_GetNumVideoDrivers()
   1.349   */
   1.350  extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
   1.351  
   1.352  /**
   1.353 - * \fn int SDL_VideoInit(const char *driver_name, Uint32 flags)
   1.354 - *
   1.355 - * \brief Initialize the video subsystem, optionally specifying a video driver.
   1.356 - *
   1.357 - * \param driver_name Initialize a specific driver by name, or NULL for the default video driver.
   1.358 - * \param flags FIXME: Still needed?
   1.359 - *
   1.360 - * \return 0 on success, -1 on error
   1.361 - *
   1.362 - * This function initializes the video subsystem; setting up a connection
   1.363 - * to the window manager, etc, and determines the available display modes
   1.364 - * and pixel formats, but does not initialize a window or graphics mode.
   1.365 - *
   1.366 - * \sa SDL_VideoQuit()
   1.367 + *  \brief Initialize the video subsystem, optionally specifying a video driver.
   1.368 + *  
   1.369 + *  \param driver_name Initialize a specific driver by name, or NULL for the 
   1.370 + *                     default video driver.
   1.371 + *  
   1.372 + *  \param flags FIXME: Still needed?
   1.373 + *  
   1.374 + *  \return 0 on success, -1 on error
   1.375 + *  
   1.376 + *  This function initializes the video subsystem; setting up a connection
   1.377 + *  to the window manager, etc, and determines the available display modes
   1.378 + *  and pixel formats, but does not initialize a window or graphics mode.
   1.379 + *  
   1.380 + *  \sa SDL_VideoQuit()
   1.381   */
   1.382  extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name,
   1.383                                            Uint32 flags);
   1.384  
   1.385  /**
   1.386 - * \fn void SDL_VideoQuit(void)
   1.387 - *
   1.388 - * \brief Shuts down the video subsystem.
   1.389 - *
   1.390 - * This function closes all windows, and restores the original video mode.
   1.391 - *
   1.392 - * \sa SDL_VideoInit()
   1.393 + *  \brief Shuts down the video subsystem.
   1.394 + *  
   1.395 + *  This function closes all windows, and restores the original video mode.
   1.396 + *  
   1.397 + *  \sa SDL_VideoInit()
   1.398   */
   1.399  extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
   1.400  
   1.401  /**
   1.402 - * \fn const char *SDL_GetCurrentVideoDriver(void)
   1.403 - *
   1.404 - * \brief Returns the name of the currently initialized video driver.
   1.405 - *
   1.406 - * \return The name of the current video driver or NULL if no driver
   1.407 - *         has been initialized
   1.408 - *
   1.409 - * \sa SDL_GetNumVideoDrivers()
   1.410 - * \sa SDL_GetVideoDriver()
   1.411 + *  \brief Returns the name of the currently initialized video driver.
   1.412 + *  
   1.413 + *  \return The name of the current video driver or NULL if no driver
   1.414 + *          has been initialized
   1.415 + *  
   1.416 + *  \sa SDL_GetNumVideoDrivers()
   1.417 + *  \sa SDL_GetVideoDriver()
   1.418   */
   1.419  extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
   1.420  
   1.421  /**
   1.422 - * \fn int SDL_GetNumVideoDisplays(void)
   1.423 - *
   1.424 - * \brief Returns the number of available video displays.
   1.425 - *
   1.426 - * \sa SDL_SelectVideoDisplay()
   1.427 + *  \brief Returns the number of available video displays.
   1.428 + *  
   1.429 + *  \sa SDL_SelectVideoDisplay()
   1.430   */
   1.431  extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
   1.432  
   1.433  /**
   1.434 - * \fn int SDL_SelectVideoDisplay(int index)
   1.435 - *
   1.436 - * \brief Set the index of the currently selected display.
   1.437 - *
   1.438 - * \return 0 on success, or -1 if the index is out of range.
   1.439 - *
   1.440 - * \sa SDL_GetNumVideoDisplays()
   1.441 - * \sa SDL_GetCurrentVideoDisplay()
   1.442 + *  \brief Set the index of the currently selected display.
   1.443 + *  
   1.444 + *  \return 0 on success, or -1 if the index is out of range.
   1.445 + *  
   1.446 + *  \sa SDL_GetNumVideoDisplays()
   1.447 + *  \sa SDL_GetCurrentVideoDisplay()
   1.448   */
   1.449  extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
   1.450  
   1.451  /**
   1.452 - * \fn int SDL_GetCurrentVideoDisplay(void)
   1.453 - *
   1.454 - * \brief Get the index of the currently selected display.
   1.455 - *
   1.456 - * \return The index of the currently selected display.
   1.457 - *
   1.458 - * \sa SDL_GetNumVideoDisplays()
   1.459 - * \sa SDL_SelectVideoDisplay()
   1.460 + *  \brief Get the index of the currently selected display.
   1.461 + *  
   1.462 + *  \return The index of the currently selected display.
   1.463 + *  
   1.464 + *  \sa SDL_GetNumVideoDisplays()
   1.465 + *  \sa SDL_SelectVideoDisplay()
   1.466   */
   1.467  extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
   1.468  
   1.469  /**
   1.470 - * \fn int SDL_GetNumDisplayModes(void)
   1.471 - *
   1.472 - * \brief Returns the number of available display modes for the current display.
   1.473 - *
   1.474 - * \sa SDL_GetDisplayMode()
   1.475 + *  \brief Returns the number of available display modes for the current display.
   1.476 + *  
   1.477 + *  \sa SDL_GetDisplayMode()
   1.478   */
   1.479  extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
   1.480  
   1.481  /**
   1.482 - * \fn int SDL_GetDisplayMode(int index, SDL_DisplayMode *mode)
   1.483 - *
   1.484 - * \brief Fill in information about a specific display mode.
   1.485 - *
   1.486 - * \note The display modes are sorted in this priority:
   1.487 - *       \li bits per pixel -> more colors to fewer colors
   1.488 - *       \li width -> largest to smallest
   1.489 - *       \li height -> largest to smallest
   1.490 - *       \li refresh rate -> highest to lowest
   1.491 - *
   1.492 - * \sa SDL_GetNumDisplayModes()
   1.493 + *  \brief Fill in information about a specific display mode.
   1.494 + *  
   1.495 + *  \note The display modes are sorted in this priority:
   1.496 + *        \li bits per pixel -> more colors to fewer colors
   1.497 + *        \li width -> largest to smallest
   1.498 + *        \li height -> largest to smallest
   1.499 + *        \li refresh rate -> highest to lowest
   1.500 + *  
   1.501 + *  \sa SDL_GetNumDisplayModes()
   1.502   */
   1.503  extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
   1.504                                                 SDL_DisplayMode * mode);
   1.505  
   1.506  /**
   1.507 - * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
   1.508 - *
   1.509 - * \brief Fill in information about the desktop display mode for the current display.
   1.510 + *  \brief Fill in information about the desktop display mode for the current 
   1.511 + *         display.
   1.512   */
   1.513  extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
   1.514  
   1.515  /**
   1.516 - * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
   1.517 - *
   1.518 - * \brief Fill in information about the current display mode.
   1.519 + *  \brief Fill in information about the current display mode.
   1.520   */
   1.521  extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
   1.522  
   1.523  
   1.524  /**
   1.525 - * \fn SDL_DisplayMode SDL_GetClosestDisplayMode(const SDL_DisplayMode mode, SDL_DisplayMode closest)
   1.526 - *
   1.527 - * \brief Get the closest match to the requested display mode.
   1.528 - *
   1.529 - * \param mode The desired display mode
   1.530 - * \param closest A pointer to a display mode to be filled in with the closest match of the available display modes.
   1.531 - *
   1.532 - * \return The passed in value 'closest', or NULL if no matching video mode was available.
   1.533 - *
   1.534 - * The available display modes are scanned, and 'closest' is filled in with the closest mode matching the requested mode and returned.  The mode format and refresh_rate default to the desktop mode if they are 0.  The modes are scanned with size being first priority, format being second priority, and finally checking the refresh_rate.  If all the available modes are too small, then NULL is returned.
   1.535 - *
   1.536 - * \sa SDL_GetNumDisplayModes()
   1.537 - * \sa SDL_GetDisplayMode()
   1.538 + *  \brief Get the closest match to the requested display mode.
   1.539 + *  
   1.540 + *  \param mode The desired display mode
   1.541 + *  \param closest A pointer to a display mode to be filled in with the closest 
   1.542 + *                 match of the available display modes.
   1.543 + *  
   1.544 + *  \return The passed in value \c closest, or NULL if no matching video mode 
   1.545 + *          was available.
   1.546 + *  
   1.547 + *  The available display modes are scanned, and \c closest is filled in with the
   1.548 + *  closest mode matching the requested mode and returned.  The mode format and 
   1.549 + *  refresh_rate default to the desktop mode if they are 0.  The modes are 
   1.550 + *  scanned with size being first priority, format being second priority, and 
   1.551 + *  finally checking the refresh_rate.  If all the available modes are too 
   1.552 + *  small, then NULL is returned.
   1.553 + *  
   1.554 + *  \sa SDL_GetNumDisplayModes()
   1.555 + *  \sa SDL_GetDisplayMode()
   1.556   */
   1.557  extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const
   1.558                                                                     SDL_DisplayMode
   1.559 @@ -437,335 +426,290 @@
   1.560                                                                     * closest);
   1.561  
   1.562  /**
   1.563 - * \fn int SDL_SetFullscreenDisplayMode(const SDL_DisplayMode *mode)
   1.564 - *
   1.565 - * \brief Set the display mode used when a fullscreen window is visible
   1.566 - *        on the currently selected display.
   1.567 - *
   1.568 - * \param mode The mode to use, or NULL for the desktop mode.
   1.569 - *
   1.570 - * \return 0 on success, or -1 if setting the display mode failed.
   1.571 - *
   1.572 - * \sa SDL_SetWindowFullscreen()
   1.573 + *  \brief Set the display mode used when a fullscreen window is visible
   1.574 + *         on the currently selected display.
   1.575 + *  
   1.576 + *  \param mode The mode to use, or NULL for the desktop mode.
   1.577 + *  
   1.578 + *  \return 0 on success, or -1 if setting the display mode failed.
   1.579 + *  
   1.580 + *  \sa SDL_SetWindowFullscreen()
   1.581   */
   1.582  extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const SDL_DisplayMode
   1.583                                                           * mode);
   1.584  
   1.585  /**
   1.586 - * \fn int SDL_GetFullscreenDisplayMode(SDL_DisplayMode *mode)
   1.587 - *
   1.588 - * \brief Fill in information about the display mode used when a fullscreen
   1.589 - *        window is visible on the currently selected display.
   1.590 + *  \brief Fill in information about the display mode used when a fullscreen
   1.591 + *         window is visible on the currently selected display.
   1.592   */
   1.593  extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
   1.594                                                           mode);
   1.595  
   1.596  /**
   1.597 - * \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, int ncolors)
   1.598 - *
   1.599 - * \brief Set the palette entries for indexed display modes.
   1.600 - *
   1.601 - * \return 0 on success, or -1 if the display mode isn't palettized or the colors couldn't be set.
   1.602 + *  \brief Set the palette entries for indexed display modes.
   1.603 + *  
   1.604 + *  \return 0 on success, or -1 if the display mode isn't palettized or the 
   1.605 + *          colors couldn't be set.
   1.606   */
   1.607  extern DECLSPEC int SDLCALL SDL_SetDisplayPalette(const SDL_Color * colors,
   1.608                                                    int firstcolor,
   1.609                                                    int ncolors);
   1.610  
   1.611  /**
   1.612 - * \fn int SDL_GetDisplayPalette(SDL_Color *colors, int firstcolor, int ncolors)
   1.613 - *
   1.614 - * \brief Gets the palette entries for indexed display modes.
   1.615 - *
   1.616 - * \return 0 on success, or -1 if the display mode isn't palettized
   1.617 + *  \brief Gets the palette entries for indexed display modes.
   1.618 + *  
   1.619 + *  \return 0 on success, or -1 if the display mode isn't palettized
   1.620   */
   1.621  extern DECLSPEC int SDLCALL SDL_GetDisplayPalette(SDL_Color * colors,
   1.622                                                    int firstcolor,
   1.623                                                    int ncolors);
   1.624  
   1.625  /**
   1.626 - * \fn int SDL_SetGamma(float red, float green, float blue)
   1.627 - *
   1.628 - * \brief Set the gamma correction for each of the color channels on the currently selected display.
   1.629 - *
   1.630 - * \return 0 on success, or -1 if setting the gamma isn't supported.
   1.631 - *
   1.632 - * \sa SDL_SetGammaRamp()
   1.633 + *  \brief Set the gamma correction for each of the color channels on the 
   1.634 + *         currently selected display.
   1.635 + *  
   1.636 + *  \return 0 on success, or -1 if setting the gamma isn't supported.
   1.637 + *  
   1.638 + *  \sa SDL_SetGammaRamp()
   1.639   */
   1.640  extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
   1.641  
   1.642  /**
   1.643 - * \fn int SDL_SetGammaRamp(const Uint16 * red, const Uint16 * green, const Uint16 * blue)
   1.644 - *
   1.645 - * \brief Set the gamma ramp for the currently selected display.
   1.646 - *
   1.647 - * \param red The translation table for the red channel, or NULL
   1.648 - * \param green The translation table for the green channel, or NULL
   1.649 - * \param blue The translation table for the blue channel, or NULL
   1.650 - *
   1.651 - * \return 0 on success, or -1 if gamma ramps are unsupported.
   1.652 - *
   1.653 - * Set the gamma translation table for the red, green, and blue channels
   1.654 - * of the video hardware.  Each table is an array of 256 16-bit quantities,
   1.655 - * representing a mapping between the input and output for that channel.
   1.656 - * The input is the index into the array, and the output is the 16-bit
   1.657 - * gamma value at that index, scaled to the output color precision.
   1.658 - * 
   1.659 - * \sa SDL_GetGammaRamp()
   1.660 + *  \brief Set the gamma ramp for the currently selected display.
   1.661 + *  
   1.662 + *  \param red The translation table for the red channel, or NULL.
   1.663 + *  \param green The translation table for the green channel, or NULL.
   1.664 + *  \param blue The translation table for the blue channel, or NULL.
   1.665 + *  
   1.666 + *  \return 0 on success, or -1 if gamma ramps are unsupported.
   1.667 + *  
   1.668 + *  Set the gamma translation table for the red, green, and blue channels
   1.669 + *  of the video hardware.  Each table is an array of 256 16-bit quantities,
   1.670 + *  representing a mapping between the input and output for that channel.
   1.671 + *  The input is the index into the array, and the output is the 16-bit
   1.672 + *  gamma value at that index, scaled to the output color precision.
   1.673 + *  
   1.674 + *  \sa SDL_GetGammaRamp()
   1.675   */
   1.676  extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 * red,
   1.677                                               const Uint16 * green,
   1.678                                               const Uint16 * blue);
   1.679  
   1.680  /**
   1.681 - * \fn int SDL_GetGammaRamp(Uint16 * red, Uint16 * green, Uint16 * blue)
   1.682 - *
   1.683 - * \brief Get the gamma ramp for the currently selected display.
   1.684 - *
   1.685 - * \param red A pointer to a 256 element array of 16-bit quantities to hold the translation table for the red channel, or NULL.
   1.686 - * \param green A pointer to a 256 element array of 16-bit quantities to hold the translation table for the green channel, or NULL.
   1.687 - * \param blue A pointer to a 256 element array of 16-bit quantities to hold the translation table for the blue channel, or NULL.
   1.688 - * 
   1.689 - * \return 0 on success, or -1 if gamma ramps are unsupported.
   1.690 - *
   1.691 - * \sa SDL_SetGammaRamp()
   1.692 + *  \brief Get the gamma ramp for the currently selected display.
   1.693 + *  
   1.694 + *  \param red   A pointer to a 256 element array of 16-bit quantities to hold 
   1.695 + *               the translation table for the red channel, or NULL.
   1.696 + *  \param green A pointer to a 256 element array of 16-bit quantities to hold 
   1.697 + *               the translation table for the green channel, or NULL.
   1.698 + *  \param blue  A pointer to a 256 element array of 16-bit quantities to hold 
   1.699 + *               the translation table for the blue channel, or NULL.
   1.700 + *   
   1.701 + *  \return 0 on success, or -1 if gamma ramps are unsupported.
   1.702 + *  
   1.703 + *  \sa SDL_SetGammaRamp()
   1.704   */
   1.705  extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 * red, Uint16 * green,
   1.706                                               Uint16 * blue);
   1.707  
   1.708  
   1.709  /**
   1.710 - * \fn SDL_WindowID SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)
   1.711 - *
   1.712 - * \brief Create a window with the specified position, dimensions, and flags.
   1.713 - *
   1.714 - * \param title The title of the window, in UTF-8 encoding
   1.715 - * \param x The x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   1.716 - * \param y The y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   1.717 - * \param w The width of the window
   1.718 - * \param h The height of the window
   1.719 - * \param flags The flags for the window, a mask of any of the following: SDL_WINDOW_FULLSCREEN, SDL_WINDOW_OPENGL, SDL_WINDOW_SHOWN, SDL_WINDOW_BORDERLESS, SDL_WINDOW_RESIZABLE, SDL_WINDOW_MAXIMIZED, SDL_WINDOW_MINIMIZED, SDL_WINDOW_INPUT_GRABBED
   1.720 - *
   1.721 - * \return The id of the window created, or zero if window creation failed.
   1.722 - *
   1.723 - * \sa SDL_DestroyWindow()
   1.724 + *  \brief Create a window with the specified position, dimensions, and flags.
   1.725 + *  
   1.726 + *  \param title The title of the window, in UTF-8 encoding.
   1.727 + *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   1.728 + *               ::SDL_WINDOWPOS_UNDEFINED.
   1.729 + *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
   1.730 + *               ::SDL_WINDOWPOS_UNDEFINED.
   1.731 + *  \param w     The width of the window.
   1.732 + *  \param h     The height of the window.
   1.733 + *  \param flags The flags for the window, a mask of any of the following: 
   1.734 + *               ::SDL_WINDOW_FULLSCREEN, ::SDL_WINDOW_OPENGL, 
   1.735 + *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_BORDERLESS, 
   1.736 + *               ::SDL_WINDOW_RESIZABLE,  ::SDL_WINDOW_MAXIMIZED, 
   1.737 + *               ::SDL_WINDOW_MINIMIZED,  ::SDL_WINDOW_INPUT_GRABBED.
   1.738 + *  
   1.739 + *  \return The id of the window created, or zero if window creation failed.
   1.740 + *  
   1.741 + *  \sa SDL_DestroyWindow()
   1.742   */
   1.743  extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindow(const char *title,
   1.744                                                        int x, int y, int w,
   1.745                                                        int h, Uint32 flags);
   1.746  
   1.747  /**
   1.748 - * \fn SDL_WindowID SDL_CreateWindowFrom(void *data)
   1.749 - *
   1.750 - * \brief Create an SDL window struct from an existing native window.
   1.751 - *
   1.752 - * \param data A pointer to driver-dependent window creation data
   1.753 - *
   1.754 - * \return The id of the window created, or zero if window creation failed.
   1.755 - *
   1.756 - * \warning This function is NOT SUPPORTED, use at your own risk!
   1.757 - *
   1.758 - * \sa SDL_DestroyWindow()
   1.759 + *  \brief Create an SDL window struct from an existing native window.
   1.760 + *  
   1.761 + *  \param data A pointer to driver-dependent window creation data
   1.762 + *  
   1.763 + *  \return The id of the window created, or zero if window creation failed.
   1.764 + *  
   1.765 + *  \warning This function is NOT SUPPORTED, use at your own risk!
   1.766 + *  
   1.767 + *  \sa SDL_DestroyWindow()
   1.768   */
   1.769  extern DECLSPEC SDL_WindowID SDLCALL SDL_CreateWindowFrom(const void *data);
   1.770  
   1.771  /**
   1.772 - * \fn Uint32 SDL_GetWindowFlags(SDL_WindowID windowID)
   1.773 - *
   1.774 - * \brief Get the window flags.
   1.775 + *  \brief Get the window flags.
   1.776   */
   1.777  extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_WindowID windowID);
   1.778  
   1.779  /**
   1.780 - * \fn void SDL_SetWindowTitle(SDL_WindowID windowID, const char *title)
   1.781 - *
   1.782 - * \brief Set the title of the window, in UTF-8 format.
   1.783 - *
   1.784 - * \sa SDL_GetWindowTitle()
   1.785 + *  \brief Set the title of the window, in UTF-8 format.
   1.786 + *  
   1.787 + *  \sa SDL_GetWindowTitle()
   1.788   */
   1.789  extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_WindowID windowID,
   1.790                                                  const char *title);
   1.791  
   1.792  /**
   1.793 - * \fn const char *SDL_GetWindowTitle(SDL_WindowID windowID)
   1.794 - *
   1.795 - * \brief Get the title of the window, in UTF-8 format.
   1.796 - *
   1.797 - * \sa SDL_SetWindowTitle()
   1.798 + *  \brief Get the title of the window, in UTF-8 format.
   1.799 + *  
   1.800 + *  \sa SDL_SetWindowTitle()
   1.801   */
   1.802  extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_WindowID windowID);
   1.803  
   1.804  /**
   1.805 - * \fn void SDL_SetWindowIcon(SDL_WindowID windowID, SDL_Surface *icon)
   1.806 - *
   1.807 - * \brief Set the icon of the window.
   1.808 - *
   1.809 - * \param icon The icon for the window
   1.810 + *  \brief Set the icon of the window.
   1.811 + *  
   1.812 + *  \param icon The icon for the window.
   1.813   */
   1.814  extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_WindowID windowID,
   1.815                                                 SDL_Surface * icon);
   1.816  
   1.817  /**
   1.818 - * \fn void SDL_SetWindowData(SDL_WindowID windowID, void *userdata)
   1.819 - *
   1.820 - * \brief Associate an arbitrary pointer with the window.
   1.821 - *
   1.822 - * \sa SDL_GetWindowData()
   1.823 + *  \brief Associate an arbitrary pointer with the window.
   1.824 + *  
   1.825 + *  \sa SDL_GetWindowData()
   1.826   */
   1.827  extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_WindowID windowID,
   1.828                                                 void *userdata);
   1.829  
   1.830  /**
   1.831 - * \fn void *SDL_GetWindowData(SDL_WindowID windowID)
   1.832 - *
   1.833 - * \brief Retrieve the data pointer associated with the window.
   1.834 - *
   1.835 - * \sa SDL_SetWindowData()
   1.836 + *  \brief Retrieve the data pointer associated with the window.
   1.837 + *  
   1.838 + *  \sa SDL_SetWindowData()
   1.839   */
   1.840  extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_WindowID windowID);
   1.841  
   1.842  /**
   1.843 - * \fn void SDL_SetWindowPosition(SDL_WindowID windowID, int x, int y)
   1.844 - *
   1.845 - * \brief Set the position of the window.
   1.846 - *
   1.847 - * \param windowID The window to reposition
   1.848 - * \param x The x coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   1.849 - * \param y The y coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
   1.850 - *
   1.851 - * \note The window coordinate origin is the upper left of the display.
   1.852 - *
   1.853 - * \sa SDL_GetWindowPosition()
   1.854 + *  \brief Set the position of the window.
   1.855 + *  
   1.856 + *  \param windowID The window to reposition.
   1.857 + *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   1.858 +                    ::SDL_WINDOWPOS_UNDEFINED.
   1.859 + *  \param y        The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
   1.860 +                    ::SDL_WINDOWPOS_UNDEFINED.
   1.861 + *  
   1.862 + *  \note The window coordinate origin is the upper left of the display.
   1.863 + *  
   1.864 + *  \sa SDL_GetWindowPosition()
   1.865   */
   1.866  extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_WindowID windowID,
   1.867                                                     int x, int y);
   1.868  
   1.869  /**
   1.870 - * \fn void SDL_GetWindowPosition(SDL_WindowID windowID, int *x, int *y)
   1.871 - *
   1.872 - * \brief Get the position of the window.
   1.873 - *
   1.874 - * \sa SDL_SetWindowPosition()
   1.875 + *  \brief Get the position of the window.
   1.876 + *  
   1.877 + *  \sa SDL_SetWindowPosition()
   1.878   */
   1.879  extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_WindowID windowID,
   1.880                                                     int *x, int *y);
   1.881  
   1.882  /**
   1.883 - * \fn void SDL_SetWindowSize(SDL_WindowID windowID, int w, int w)
   1.884 - *
   1.885 - * \brief Set the size of the window's client area.
   1.886 - *
   1.887 - * \note You can't change the size of a fullscreen window, it automatically
   1.888 - * matches the size of the display mode.
   1.889 - *
   1.890 - * \sa SDL_GetWindowSize()
   1.891 + *  \brief Set the size of the window's client area.
   1.892 + *  
   1.893 + *  \note You can't change the size of a fullscreen window, it automatically
   1.894 + *        matches the size of the display mode.
   1.895 + *  
   1.896 + *  \sa SDL_GetWindowSize()
   1.897   */
   1.898  extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_WindowID windowID, int w,
   1.899                                                 int h);
   1.900  
   1.901  /**
   1.902 - * \fn void SDL_GetWindowSize(SDL_WindowID windowID, int *w, int *h)
   1.903 - *
   1.904 - * \brief Get the size of the window's client area.
   1.905 - *
   1.906 - * \sa SDL_SetWindowSize()
   1.907 + *  \brief Get the size of the window's client area.
   1.908 + *  
   1.909 + *  \sa SDL_SetWindowSize()
   1.910   */
   1.911  extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_WindowID windowID, int *w,
   1.912                                                 int *h);
   1.913  
   1.914  /**
   1.915 - * \fn void SDL_ShowWindow(SDL_WindowID windowID)
   1.916 - *
   1.917 - * \brief Show the window
   1.918 - *
   1.919 - * \sa SDL_HideWindow()
   1.920 + *  \brief Show the window.
   1.921 + *  
   1.922 + *  \sa SDL_HideWindow()
   1.923   */
   1.924  extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_WindowID windowID);
   1.925  
   1.926  /**
   1.927 - * \fn void SDL_HideWindow(SDL_WindowID windowID)
   1.928 - *
   1.929 - * \brief Hide the window
   1.930 - *
   1.931 - * \sa SDL_ShowWindow()
   1.932 + *  \brief Hide the window.
   1.933 + *  
   1.934 + *  \sa SDL_ShowWindow()
   1.935   */
   1.936  extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_WindowID windowID);
   1.937  
   1.938  /**
   1.939 - * \fn void SDL_RaiseWindow(SDL_WindowID windowID)
   1.940 - *
   1.941 - * \brief Raise the window above other windows and set the input focus.
   1.942 + *  \brief Raise the window above other windows and set the input focus.
   1.943   */
   1.944  extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_WindowID windowID);
   1.945  
   1.946  /**
   1.947 - * \fn void SDL_MaximizeWindow(SDL_WindowID windowID)
   1.948 - *
   1.949 - * \brief Make the window as large as possible.
   1.950 - *
   1.951 - * \sa SDL_RestoreWindow()
   1.952 + *  \brief Make the window as large as possible.
   1.953 + *  
   1.954 + *  \sa SDL_RestoreWindow()
   1.955   */
   1.956  extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_WindowID windowID);
   1.957  
   1.958  /**
   1.959 - * \fn void SDL_MinimizeWindow(SDL_WindowID windowID)
   1.960 - *
   1.961 - * \brief Minimize the window to an iconic representation.
   1.962 - *
   1.963 - * \sa SDL_RestoreWindow()
   1.964 + *  \brief Minimize the window to an iconic representation.
   1.965 + *  
   1.966 + *  \sa SDL_RestoreWindow()
   1.967   */
   1.968  extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_WindowID windowID);
   1.969  
   1.970  /**
   1.971 - * \fn void SDL_RestoreWindow(SDL_WindowID windowID)
   1.972 - *
   1.973 - * \brief Restore the size and position of a minimized or maximized window.
   1.974 - *
   1.975 - * \sa SDL_MaximizeWindow()
   1.976 - * \sa SDL_MinimizeWindow()
   1.977 + *  \brief Restore the size and position of a minimized or maximized window.
   1.978 + *  
   1.979 + *  \sa SDL_MaximizeWindow()
   1.980 + *  \sa SDL_MinimizeWindow()
   1.981   */
   1.982  extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_WindowID windowID);
   1.983  
   1.984  /**
   1.985 - * \fn int SDL_SetWindowFullscreen(SDL_WindowID windowID, int fullscreen)
   1.986 - *
   1.987 - * \brief Set the window's fullscreen state.
   1.988 - *
   1.989 - * \return 0 on success, or -1 if setting the display mode failed.
   1.990 - *
   1.991 - * \sa SDL_SetFullscreenDisplayMode()
   1.992 + *  \brief Set the window's fullscreen state.
   1.993 + *  
   1.994 + *  \return 0 on success, or -1 if setting the display mode failed.
   1.995 + *  
   1.996 + *  \sa SDL_SetFullscreenDisplayMode()
   1.997   */
   1.998  extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_WindowID windowID,
   1.999                                                      int fullscreen);
  1.1000  
  1.1001  /**
  1.1002 - * \fn void SDL_SetWindowGrab(SDL_WindowID windowID, int mode)
  1.1003 - *
  1.1004 - * \brief Set the window's input grab mode.
  1.1005 - *
  1.1006 - * \param mode This is 1 to grab input, and 0 to release input.
  1.1007 - *
  1.1008 - * \sa SDL_GetWindowGrab()
  1.1009 + *  \brief Set the window's input grab mode.
  1.1010 + *  
  1.1011 + *  \param mode This is 1 to grab input, and 0 to release input.
  1.1012 + *  
  1.1013 + *  \sa SDL_GetWindowGrab()
  1.1014   */
  1.1015  extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_WindowID windowID,
  1.1016                                                 int mode);
  1.1017  
  1.1018  /**
  1.1019 - * \fn int SDL_GetWindowGrab(SDL_WindowID windowID)
  1.1020 - *
  1.1021 - * \brief Get the window's input grab mode.
  1.1022 - *
  1.1023 - * \return This returns 1 if input is grabbed, and 0 otherwise.
  1.1024 - *
  1.1025 - * \sa SDL_SetWindowGrab()
  1.1026 + *  \brief Get the window's input grab mode.
  1.1027 + *  
  1.1028 + *  \return This returns 1 if input is grabbed, and 0 otherwise.
  1.1029 + *  
  1.1030 + *  \sa SDL_SetWindowGrab()
  1.1031   */
  1.1032  extern DECLSPEC int SDLCALL SDL_GetWindowGrab(SDL_WindowID windowID);
  1.1033  
  1.1034  /**
  1.1035 - * \fn SDL_bool SDL_GetWindowWMInfo(SDL_WindowID windowID, struct SDL_SysWMinfo * info)
  1.1036 - *
  1.1037 - * \brief Get driver specific information about a window.
  1.1038 - *
  1.1039 - * \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
  1.1040 + *  \brief Get driver specific information about a window.
  1.1041 + *  
  1.1042 + *  \note Include SDL_syswm.h for the declaration of SDL_SysWMinfo.
  1.1043   */
  1.1044  struct SDL_SysWMinfo;
  1.1045  extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
  1.1046 @@ -773,109 +717,101 @@
  1.1047                                                       *info);
  1.1048  
  1.1049  /**
  1.1050 - * \fn void SDL_DestroyWindow(SDL_WindowID windowID)
  1.1051 - *
  1.1052 - * \brief Destroy a window.
  1.1053 + *  \brief Destroy a window.
  1.1054   */
  1.1055  extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_WindowID windowID);
  1.1056  
  1.1057  /**
  1.1058 - * \fn int SDL_GetNumRenderDrivers(void)
  1.1059 - *
  1.1060 - * \brief Get the number of 2D rendering drivers available for the current display.
  1.1061 - *
  1.1062 - * A render driver is a set of code that handles rendering and texture
  1.1063 - * management on a particular display.  Normally there is only one, but
  1.1064 - * some drivers may have several available with different capabilities.
  1.1065 - *
  1.1066 - * \sa SDL_GetRenderDriverInfo()
  1.1067 - * \sa SDL_CreateRenderer()
  1.1068 + *  \brief Get the number of 2D rendering drivers available for the current 
  1.1069 + *         display.
  1.1070 + *  
  1.1071 + *  A render driver is a set of code that handles rendering and texture
  1.1072 + *  management on a particular display.  Normally there is only one, but
  1.1073 + *  some drivers may have several available with different capabilities.
  1.1074 + *  
  1.1075 + *  \sa SDL_GetRenderDriverInfo()
  1.1076 + *  \sa SDL_CreateRenderer()
  1.1077   */
  1.1078  extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
  1.1079  
  1.1080  /**
  1.1081 - * \fn int SDL_GetRenderDriverInfo(int index, SDL_RendererInfo *info)
  1.1082 - *
  1.1083 - * \brief Get information about a specific 2D rendering driver for the current display.
  1.1084 - *
  1.1085 - * \param index The index of the driver to query information about.
  1.1086 - * \param info A pointer to an SDL_RendererInfo struct to be filled with information on the rendering driver.
  1.1087 - *
  1.1088 - * \return 0 on success, -1 if the index was out of range
  1.1089 - *
  1.1090 - * \sa SDL_CreateRenderer()
  1.1091 + *  \brief Get information about a specific 2D rendering driver for the current 
  1.1092 + *         display.
  1.1093 + *  
  1.1094 + *  \param index The index of the driver to query information about.
  1.1095 + *  \param info  A pointer to an SDL_RendererInfo struct to be filled with 
  1.1096 + *               information on the rendering driver.
  1.1097 + *  
  1.1098 + *  \return 0 on success, -1 if the index was out of range.
  1.1099 + *  
  1.1100 + *  \sa SDL_CreateRenderer()
  1.1101   */
  1.1102  extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
  1.1103                                                      SDL_RendererInfo * info);
  1.1104  
  1.1105  /**
  1.1106 - * \fn int SDL_CreateRenderer(SDL_WindowID window, int index, Uint32 flags)
  1.1107 - *
  1.1108 - * \brief Create and make active a 2D rendering context for a window.
  1.1109 - *
  1.1110 - * \param windowID The window used for rendering
  1.1111 - * \param index The index of the rendering driver to initialize, or -1 to initialize the first one supporting the requested flags.
  1.1112 - * \param flags SDL_RendererFlags
  1.1113 - *
  1.1114 - * \return 0 on success, -1 if there was an error creating the renderer.
  1.1115 - *
  1.1116 - * \sa SDL_SelectRenderer()
  1.1117 - * \sa SDL_GetRendererInfo()
  1.1118 - * \sa SDL_DestroyRenderer()
  1.1119 + *  \brief Create and make active a 2D rendering context for a window.
  1.1120 + *  
  1.1121 + *  \param windowID The window used for rendering.
  1.1122 + *  \param index    The index of the rendering driver to initialize, or -1 to 
  1.1123 + *                  initialize the first one supporting the requested flags.
  1.1124 + *  \param flags    ::SDL_RendererFlags.
  1.1125 + *  
  1.1126 + *  \return 0 on success, -1 if there was an error creating the renderer.
  1.1127 + *  
  1.1128 + *  \sa SDL_SelectRenderer()
  1.1129 + *  \sa SDL_GetRendererInfo()
  1.1130 + *  \sa SDL_DestroyRenderer()
  1.1131   */
  1.1132  extern DECLSPEC int SDLCALL SDL_CreateRenderer(SDL_WindowID windowID,
  1.1133                                                 int index, Uint32 flags);
  1.1134  
  1.1135  /**
  1.1136 - * \fn int SDL_SelectRenderer(SDL_WindowID windowID)
  1.1137 - *
  1.1138 - * \brief Select the rendering context for a particular window.
  1.1139 - *
  1.1140 - * \return 0 on success, -1 if the selected window doesn't have a
  1.1141 - *         rendering context.
  1.1142 + *  \brief Select the rendering context for a particular window.
  1.1143 + *  
  1.1144 + *  \return 0 on success, -1 if the selected window doesn't have a
  1.1145 + *          rendering context.
  1.1146   */
  1.1147  extern DECLSPEC int SDLCALL SDL_SelectRenderer(SDL_WindowID windowID);
  1.1148  
  1.1149  /**
  1.1150 - * \fn int SDL_GetRendererInfo(SDL_RendererInfo *info)
  1.1151 - *
  1.1152 - * \brief Get information about the current rendering context.
  1.1153 + *  \brief Get information about the current rendering context.
  1.1154   */
  1.1155  extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_RendererInfo * info);
  1.1156  
  1.1157  /**
  1.1158 - * \fn SDL_TextureID SDL_CreateTexture(Uint32 format, int access, int w, int h)
  1.1159 - *
  1.1160 - * \brief Create a texture for the current rendering context.
  1.1161 - *
  1.1162 - * \param format The format of the texture
  1.1163 - * \param access One of the enumerated values in SDL_TextureAccess
  1.1164 - * \param w The width of the texture in pixels
  1.1165 - * \param h The height of the texture in pixels
  1.1166 - *
  1.1167 - * \return The created texture is returned, or 0 if no rendering context was active,  the format was unsupported, or the width or height were out of range.
  1.1168 - *
  1.1169 - * \sa SDL_QueryTexture()
  1.1170 - * \sa SDL_DestroyTexture()
  1.1171 + *  \brief Create a texture for the current rendering context.
  1.1172 + *  
  1.1173 + *  \param format The format of the texture.
  1.1174 + *  \param access One of the enumerated values in ::SDL_TextureAccess.
  1.1175 + *  \param w      The width of the texture in pixels.
  1.1176 + *  \param h      The height of the texture in pixels.
  1.1177 + *  
  1.1178 + *  \return The created texture is returned, or 0 if no rendering context was 
  1.1179 + *          active,  the format was unsupported, or the width or height were out
  1.1180 + *          of range.
  1.1181 + *  
  1.1182 + *  \sa SDL_QueryTexture()
  1.1183 + *  \sa SDL_DestroyTexture()
  1.1184   */
  1.1185  extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTexture(Uint32 format,
  1.1186                                                          int access, int w,
  1.1187                                                          int h);
  1.1188  
  1.1189  /**
  1.1190 - * \fn SDL_TextureID SDL_CreateTextureFromSurface(Uint32 format, SDL_Surface *surface)
  1.1191 - *
  1.1192 - * \brief Create a texture from an existing surface.
  1.1193 - *
  1.1194 - * \param format The format of the texture, or 0 to pick an appropriate format
  1.1195 - * \param surface The surface containing pixel data used to fill the texture
  1.1196 - *
  1.1197 - * \return The created texture is returned, or 0 if no rendering context was active,  the format was unsupported, or the surface width or height were out of range.
  1.1198 - *
  1.1199 - * \note The surface is not modified or freed by this function.
  1.1200 - *
  1.1201 - * \sa SDL_QueryTexture()
  1.1202 - * \sa SDL_DestroyTexture()
  1.1203 + *  \brief Create a texture from an existing surface.
  1.1204 + *  
  1.1205 + *  \param format The format of the texture, or 0 to pick an appropriate format.
  1.1206 + *  \param surface The surface containing pixel data used to fill the texture.
  1.1207 + *  
  1.1208 + *  \return The created texture is returned, or 0 if no rendering context was 
  1.1209 + *          active,  the format was unsupported, or the surface width or height 
  1.1210 + *          were out of range.
  1.1211 + *  
  1.1212 + *  \note The surface is not modified or freed by this function.
  1.1213 + *  
  1.1214 + *  \sa SDL_QueryTexture()
  1.1215 + *  \sa SDL_DestroyTexture()
  1.1216   */
  1.1217  extern DECLSPEC SDL_TextureID SDLCALL SDL_CreateTextureFromSurface(Uint32
  1.1218                                                                     format,
  1.1219 @@ -883,47 +819,48 @@
  1.1220                                                                     * surface);
  1.1221  
  1.1222  /**
  1.1223 - * \fn int SDL_QueryTexture(SDL_TextureID textureID, Uint32 *format, int *access, int *w, int *h)
  1.1224 - *
  1.1225 - * \brief Query the attributes of a texture
  1.1226 - *
  1.1227 - * \param texture A texture to be queried
  1.1228 - * \param format A pointer filled in with the raw format of the texture.  The actual format may differ, but pixel transfers will use this format.
  1.1229 - * \param access A pointer filled in with the actual access to the texture.
  1.1230 - * \param w A pointer filled in with the width of the texture in pixels
  1.1231 - * \param h A pointer filled in with the height of the texture in pixels
  1.1232 - *
  1.1233 - * \return 0 on success, or -1 if the texture is not valid
  1.1234 + *  \brief Query the attributes of a texture
  1.1235 + *  
  1.1236 + *  \param textureID A texture to be queried.
  1.1237 + *  \param format  A pointer filled in with the raw format of the texture.  The 
  1.1238 + *                 actual format may differ, but pixel transfers will use this 
  1.1239 + *                 format.
  1.1240 + *  \param access  A pointer filled in with the actual access to the texture.
  1.1241 + *  \param w       A pointer filled in with the width of the texture in pixels.
  1.1242 + *  \param h       A pointer filled in with the height of the texture in pixels.
  1.1243 + *  
  1.1244 + *  \return 0 on success, or -1 if the texture is not valid.
  1.1245   */
  1.1246  extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_TextureID textureID,
  1.1247                                               Uint32 * format, int *access,
  1.1248                                               int *w, int *h);
  1.1249  
  1.1250  /**
  1.1251 - * \fn int SDL_QueryTexturePixels(SDL_TextureID textureID, void **pixels, int pitch)
  1.1252 - *
  1.1253 - * \brief Query the pixels of a texture, if the texture does not need to be locked for pixel access.
  1.1254 - *
  1.1255 - * \param texture A texture to be queried, which was created with SDL_TEXTUREACCESS_STREAMING
  1.1256 - * \param pixels A pointer filled with a pointer to the pixels for the texture 
  1.1257 - * \param pitch A pointer filled in with the pitch of the pixel data
  1.1258 - *
  1.1259 - * \return 0 on success, or -1 if the texture is not valid, or must be locked for pixel access.
  1.1260 + *  \brief Query the pixels of a texture, if the texture does not need to be 
  1.1261 + *         locked for pixel access.
  1.1262 + *  
  1.1263 + *  \param textureID A texture to be queried, which was created with 
  1.1264 + *                   ::SDL_TEXTUREACCESS_STREAMING.
  1.1265 + *  \param pixels    A pointer filled with a pointer to the pixels for the 
  1.1266 + *                   texture.
  1.1267 + *  \param pitch     A pointer filled in with the pitch of the pixel data.
  1.1268 + *  
  1.1269 + *  \return 0 on success, or -1 if the texture is not valid, or must be locked 
  1.1270 + *          for pixel access.
  1.1271   */
  1.1272  extern DECLSPEC int SDLCALL SDL_QueryTexturePixels(SDL_TextureID textureID,
  1.1273                                                     void **pixels, int *pitch);
  1.1274  
  1.1275  /**
  1.1276 - * \fn int SDL_SetTexturePalette(SDL_TextureID textureID, const SDL_Color * colors, int firstcolor, int ncolors)
  1.1277 - *
  1.1278 - * \brief Set the color palette of an indexed texture.
  1.1279 - *
  1.1280 - * \param texture The texture to update
  1.1281 - * \param colors The array of RGB color data
  1.1282 - * \param firstcolor The first index to update
  1.1283 - * \param ncolors The number of palette entries to fill with the color data
  1.1284 - *
  1.1285 - * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
  1.1286 + *  \brief Set the color palette of an indexed texture.
  1.1287 + *  
  1.1288 + *  \param textureID  The texture to update.
  1.1289 + *  \param colors     The array of RGB color data.
  1.1290 + *  \param firstcolor The first index to update.
  1.1291 + *  \param ncolors    The number of palette entries to fill with the color data.
  1.1292 + *  
  1.1293 + *  \return 0 on success, or -1 if the texture is not valid or not an indexed 
  1.1294 + *          texture.
  1.1295   */
  1.1296  extern DECLSPEC int SDLCALL SDL_SetTexturePalette(SDL_TextureID textureID,
  1.1297                                                    const SDL_Color * colors,
  1.1298 @@ -931,16 +868,15 @@
  1.1299                                                    int ncolors);
  1.1300  
  1.1301  /**
  1.1302 - * \fn int SDL_GetTexturePalette(SDL_TextureID textureID, SDL_Color * colors, int firstcolor, int ncolors)
  1.1303 - *
  1.1304 - * \brief Get the color palette from an indexed texture if it has one.
  1.1305 - *
  1.1306 - * \param texture The texture to update
  1.1307 - * \param colors The array to fill with RGB color data
  1.1308 - * \param firstcolor The first index to retrieve
  1.1309 - * \param ncolors The number of palette entries to retrieve
  1.1310 - *
  1.1311 - * \return 0 on success, or -1 if the texture is not valid or not an indexed texture
  1.1312 + *  \brief Get the color palette from an indexed texture if it has one.
  1.1313 + *  
  1.1314 + *  \param textureID  The texture to update.
  1.1315 + *  \param colors     The array to fill with RGB color data.
  1.1316 + *  \param firstcolor The first index to retrieve.
  1.1317 + *  \param ncolors    The number of palette entries to retrieve.
  1.1318 + *  
  1.1319 + *  \return 0 on success, or -1 if the texture is not valid or not an indexed 
  1.1320 + *          texture.
  1.1321   */
  1.1322  extern DECLSPEC int SDLCALL SDL_GetTexturePalette(SDL_TextureID textureID,
  1.1323                                                    SDL_Color * colors,
  1.1324 @@ -948,168 +884,160 @@
  1.1325                                                    int ncolors);
  1.1326  
  1.1327  /**
  1.1328 - * \fn int SDL_SetTextureColorMod(SDL_TextureID textureID, Uint8 r, Uint8 g, Uint8 b)
  1.1329 - *
  1.1330 - * \brief Set an additional color value used in render copy operations
  1.1331 - *
  1.1332 - * \param texture The texture to update
  1.1333 - * \param r The red source color value multiplied into copy operations
  1.1334 - * \param g The green source color value multiplied into copy operations
  1.1335 - * \param b The blue source color value multiplied into copy operations
  1.1336 - *
  1.1337 - * \return 0 on success, or -1 if the texture is not valid or color modulation is not supported
  1.1338 - *
  1.1339 - * \sa SDL_GetTextureColorMod()
  1.1340 + *  \brief Set an additional color value used in render copy operations.
  1.1341 + *  
  1.1342 + *  \param textureID The texture to update.
  1.1343 + *  \param r       The red source color value multiplied into copy operations.
  1.1344 + *  \param g       The green source color value multiplied into copy operations.
  1.1345 + *  \param b       The blue source color value multiplied into copy operations.
  1.1346 + *  
  1.1347 + *  \return 0 on success, or -1 if the texture is not valid or color modulation 
  1.1348 + *          is not supported.
  1.1349 + *  
  1.1350 + *  \sa SDL_GetTextureColorMod()
  1.1351   */
  1.1352  extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_TextureID textureID,
  1.1353                                                     Uint8 r, Uint8 g, Uint8 b);
  1.1354  
  1.1355  
  1.1356  /**
  1.1357 - * \fn int SDL_GetTextureColorMod(SDL_TextureID textureID, Uint8 *r, Uint8 *g, Uint8 *b)
  1.1358 - *
  1.1359 - * \brief Get the additional color value used in render copy operations
  1.1360 - *
  1.1361 - * \param texture The texture to query
  1.1362 - * \param r A pointer filled in with the source red color value
  1.1363 - * \param g A pointer filled in with the source green color value
  1.1364 - * \param b A pointer filled in with the source blue color value
  1.1365 - *
  1.1366 - * \return 0 on success, or -1 if the texture is not valid
  1.1367 - *
  1.1368 - * \sa SDL_SetTextureColorMod()
  1.1369 + *  \brief Get the additional color value used in render copy operations.
  1.1370 + *  
  1.1371 + *  \param textureID The texture to query.
  1.1372 + *  \param r         A pointer filled in with the source red color value.
  1.1373 + *  \param g         A pointer filled in with the source green color value.
  1.1374 + *  \param b         A pointer filled in with the source blue color value.
  1.1375 + *  
  1.1376 + *  \return 0 on success, or -1 if the texture is not valid.
  1.1377 + *  
  1.1378 + *  \sa SDL_SetTextureColorMod()
  1.1379   */
  1.1380  extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_TextureID textureID,
  1.1381                                                     Uint8 * r, Uint8 * g,
  1.1382                                                     Uint8 * b);
  1.1383  
  1.1384  /**
  1.1385 - * \fn int SDL_SetTextureAlphaMod(SDL_TextureID textureID, Uint8 alpha)
  1.1386 - *
  1.1387 - * \brief Set an additional alpha value used in render copy operations
  1.1388 - *
  1.1389 - * \param texture The texture to update
  1.1390 - * \param alpha The source alpha value multiplied into copy operations.
  1.1391 - *
  1.1392 - * \return 0 on success, or -1 if the texture is not valid or alpha modulation is not supported
  1.1393 - *
  1.1394 - * \sa SDL_GetTextureAlphaMod()
  1.1395 + *  \brief Set an additional alpha value used in render copy operations.
  1.1396 + *  
  1.1397 + *  \param textureID The texture to update.
  1.1398 + *  \param alpha     The source alpha value multiplied into copy operations.
  1.1399 + *  
  1.1400 + *  \return 0 on success, or -1 if the texture is not valid or alpha modulation 
  1.1401 + *          is not supported.
  1.1402 + *  
  1.1403 + *  \sa SDL_GetTextureAlphaMod()
  1.1404   */
  1.1405  extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_TextureID textureID,
  1.1406                                                     Uint8 alpha);
  1.1407  
  1.1408  /**
  1.1409 - * \fn int SDL_GetTextureAlphaMod(SDL_TextureID textureID, Uint8 *alpha)
  1.1410 - *
  1.1411 - * \brief Get the additional alpha value used in render copy operations
  1.1412 - *
  1.1413 - * \param texture The texture to query
  1.1414 - * \param alpha A pointer filled in with the source alpha value
  1.1415 - *
  1.1416 - * \return 0 on success, or -1 if the texture is not valid
  1.1417 - *
  1.1418 - * \sa SDL_SetTextureAlphaMod()
  1.1419 + *  \brief Get the additional alpha value used in render copy operations.
  1.1420 + *  
  1.1421 + *  \param textureID The texture to query.
  1.1422 + *  \param alpha     A pointer filled in with the source alpha value.
  1.1423 + *  
  1.1424 + *  \return 0 on success, or -1 if the texture is not valid.
  1.1425 + *  
  1.1426 + *  \sa SDL_SetTextureAlphaMod()
  1.1427   */
  1.1428  extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_TextureID textureID,
  1.1429                                                     Uint8 * alpha);
  1.1430  
  1.1431  /**
  1.1432 - * \fn int SDL_SetTextureBlendMode(SDL_TextureID textureID, int blendMode)
  1.1433 - *
  1.1434 - * \brief Set the blend mode used for texture copy operations
  1.1435 - *
  1.1436 - * \param texture The texture to update
  1.1437 - * \param blendMode SDL_TextureBlendMode to use for texture blending
  1.1438 - *
  1.1439 - * \return 0 on success, or -1 if the texture is not valid or the blend mode is not supported
  1.1440 - *
  1.1441 - * \note If the blend mode is not supported, the closest supported mode is chosen.
  1.1442 - *
  1.1443 - * \sa SDL_GetTextureBlendMode()
  1.1444 + *  \brief Set the blend mode used for texture copy operations.
  1.1445 + *  
  1.1446 + *  \param textureID The texture to update.
  1.1447 + *  \param blendMode ::SDL_BlendMode to use for texture blending.
  1.1448 + *  
  1.1449 + *  \return 0 on success, or -1 if the texture is not valid or the blend mode is
  1.1450 + *          not supported.
  1.1451 + *  
  1.1452 + *  \note If the blend mode is not supported, the closest supported mode is
  1.1453 + *        chosen.
  1.1454 + *  
  1.1455 + *  \sa SDL_GetTextureBlendMode()
  1.1456   */
  1.1457  extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_TextureID textureID,
  1.1458                                                      int blendMode);
  1.1459  
  1.1460  /**
  1.1461 - * \fn int SDL_GetTextureBlendMode(SDL_TextureID textureID, int *blendMode)
  1.1462 - *
  1.1463 - * \brief Get the blend mode used for texture copy operations
  1.1464 - *
  1.1465 - * \param texture The texture to query
  1.1466 - * \param blendMode A pointer filled in with the current blend mode
  1.1467 - *
  1.1468 - * \return 0 on success, or -1 if the texture is not valid
  1.1469 - *
  1.1470 - * \sa SDL_SetTextureBlendMode()
  1.1471 + *  \brief Get the blend mode used for texture copy operations.
  1.1472 + *  
  1.1473 + *  \param textureID The texture to query.
  1.1474 + *  \param blendMode A pointer filled in with the current blend mode.
  1.1475 + *  
  1.1476 + *  \return 0 on success, or -1 if the texture is not valid.
  1.1477 + *  
  1.1478 + *  \sa SDL_SetTextureBlendMode()
  1.1479   */
  1.1480  extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_TextureID textureID,
  1.1481                                                      int *blendMode);
  1.1482  
  1.1483  /**
  1.1484 - * \fn int SDL_SetTextureScaleMode(SDL_TextureID textureID, int scaleMode)
  1.1485 - *
  1.1486 - * \brief Set the scale mode used for texture copy operations
  1.1487 - *
  1.1488 - * \param texture The texture to update
  1.1489 - * \param scaleMode SDL_TextureScaleMode to use for texture scaling
  1.1490 - *
  1.1491 - * \return 0 on success, or -1 if the texture is not valid or the scale mode is not supported
  1.1492 - *
  1.1493 - * \note If the scale mode is not supported, the closest supported mode is chosen.
  1.1494 - *
  1.1495 - * \sa SDL_GetTextureScaleMode()
  1.1496 + *  \brief Set the scale mode used for texture copy operations.
  1.1497 + *  
  1.1498 + *  \param textureID The texture to update.
  1.1499 + *  \param scaleMode ::SDL_TextureScaleMode to use for texture scaling.
  1.1500 + *  
  1.1501 + *  \return 0 on success, or -1 if the texture is not valid or the scale mode is
  1.1502 + *          not supported.
  1.1503 + *  
  1.1504 + *  \note If the scale mode is not supported, the closest supported mode is
  1.1505 + *        chosen.
  1.1506 + *  
  1.1507 + *  \sa SDL_GetTextureScaleMode()
  1.1508   */
  1.1509  extern DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_TextureID textureID,
  1.1510                                                      int scaleMode);
  1.1511  
  1.1512  /**
  1.1513 - * \fn int SDL_GetTextureScaleMode(SDL_TextureID textureID, int *scaleMode)
  1.1514 - *
  1.1515 - * \brief Get the scale mode used for texture copy operations
  1.1516 - *
  1.1517 - * \param texture The texture to query
  1.1518 - * \param scaleMode A pointer filled in with the current scale mode
  1.1519 - *
  1.1520 - * \return 0 on success, or -1 if the texture is not valid
  1.1521 - *
  1.1522 - * \sa SDL_SetTextureScaleMode()
  1.1523 + *  \brief Get the scale mode used for texture copy operations.
  1.1524 + *  
  1.1525 + *  \param textureID The texture to query.
  1.1526 + *  \param scaleMode A pointer filled in with the current scale mode.
  1.1527 + *  
  1.1528 + *  \return 0 on success, or -1 if the texture is not valid.
  1.1529 + *  
  1.1530 + *  \sa SDL_SetTextureScaleMode()
  1.1531   */
  1.1532  extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_TextureID textureID,
  1.1533                                                      int *scaleMode);
  1.1534  
  1.1535  /**
  1.1536 - * \fn int SDL_UpdateTexture(SDL_TextureID textureID, const SDL_Rect *rect, const void *pixels, int pitch)
  1.1537 - *
  1.1538 - * \brief Update the given texture rectangle with new pixel data.
  1.1539 - *
  1.1540 - * \param texture The texture to update
  1.1541 - * \param rect A pointer to the rectangle of pixels to update, or NULL to update the entire texture.
  1.1542 - * \param pixels The raw pixel data
  1.1543 - * \param pitch The number of bytes between rows of pixel data
  1.1544 - *
  1.1545 - * \return 0 on success, or -1 if the texture is not valid
  1.1546 - *
  1.1547 - * \note This is a fairly slow function.
  1.1548 + *  \brief Update the given texture rectangle with new pixel data.
  1.1549 + *  
  1.1550 + *  \param textureID The texture to update
  1.1551 + *  \param rect      A pointer to the rectangle of pixels to update, or NULL to 
  1.1552 + *                   update the entire texture.
  1.1553 + *  \param pixels    The raw pixel data.
  1.1554 + *  \param pitch     The number of bytes between rows of pixel data.
  1.1555 + *  
  1.1556 + *  \return 0 on success, or -1 if the texture is not valid.
  1.1557 + *  
  1.1558 + *  \note This is a fairly slow function.
  1.1559   */
  1.1560  extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_TextureID textureID,
  1.1561                                                const SDL_Rect * rect,
  1.1562                                                const void *pixels, int pitch);
  1.1563  
  1.1564  /**
  1.1565 - * \fn void SDL_LockTexture(SDL_TextureID textureID, const SDL_Rect *rect, int markDirty, void **pixels, int *pitch)
  1.1566 - *
  1.1567 - * \brief Lock a portion of the texture for pixel access.
  1.1568 - *
  1.1569 - * \param textureID The texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING.
  1.1570 - * \param rect A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
  1.1571 - * \param markDirty If this is nonzero, the locked area will be marked dirty when the texture is unlocked.
  1.1572 - * \param pixels This is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
  1.1573 - * \param pitch This is filled in with the pitch of the locked pixels.
  1.1574 - *
  1.1575 - * \return 0 on success, or -1 if the texture is not valid or was created with SDL_TEXTUREACCESS_STATIC
  1.1576 - *
  1.1577 - * \sa SDL_DirtyTexture()
  1.1578 - * \sa SDL_UnlockTexture()
  1.1579 + *  \brief Lock a portion of the texture for pixel access.
  1.1580 + *  
  1.1581 + *  \param textureID The texture to lock for access, which was created with 
  1.1582 + *                   ::SDL_TEXTUREACCESS_STREAMING.
  1.1583 + *  \param rect      A pointer to the rectangle to lock for access. If the rect 
  1.1584 + *                   is NULL, the entire texture will be locked.
  1.1585 + *  \param markDirty If this is nonzero, the locked area will be marked dirty 
  1.1586 + *                   when the texture is unlocked.
  1.1587 + *  \param pixels    This is filled in with a pointer to the locked pixels, 
  1.1588 + *                   appropriately offset by the locked area.
  1.1589 + *  \param pitch     This is filled in with the pitch of the locked pixels.
  1.1590 + *  
  1.1591 + *  \return 0 on success, or -1 if the texture is not valid or was created with 
  1.1592 + *          ::SDL_TEXTUREACCESS_STATIC.
  1.1593 + *  
  1.1594 + *  \sa SDL_DirtyTexture()
  1.1595 + *  \sa SDL_UnlockTexture()
  1.1596   */
  1.1597  extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_TextureID textureID,
  1.1598                                              const SDL_Rect * rect,
  1.1599 @@ -1117,353 +1045,316 @@
  1.1600                                              int *pitch);
  1.1601  
  1.1602  /**
  1.1603 - * \fn void SDL_UnlockTexture(SDL_TextureID textureID)
  1.1604 - *
  1.1605 - * \brief Unlock a texture, uploading the changes to video memory, if needed.
  1.1606 - *
  1.1607 - * \sa SDL_LockTexture()
  1.1608 - * \sa SDL_DirtyTexture()
  1.1609 + *  \brief Unlock a texture, uploading the changes to video memory, if needed.
  1.1610 + *  
  1.1611 + *  \sa SDL_LockTexture()
  1.1612 + *  \sa SDL_DirtyTexture()
  1.1613   */
  1.1614  extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_TextureID textureID);
  1.1615  
  1.1616  /**
  1.1617 - * \fn void SDL_DirtyTexture(SDL_TextureID textureID, int numrects, const SDL_Rect * rects)
  1.1618 - *
  1.1619 - * \brief Mark the specified rectangles of the texture as dirty.
  1.1620 - *
  1.1621 - * \param textureID The texture to mark dirty, which was created with SDL_TEXTUREACCESS_STREAMING.
  1.1622 - * \param numrects The number of rectangles pointed to by rects.
  1.1623 - * \param rects The pointer to an array of dirty rectangles.
  1.1624 - *
  1.1625 - * \sa SDL_LockTexture()
  1.1626 - * \sa SDL_UnlockTexture()
  1.1627 + *  \brief Mark the specified rectangles of the texture as dirty.
  1.1628 + *  
  1.1629 + *  \param textureID The texture to mark dirty, which was created with 
  1.1630 + *                   ::SDL_TEXTUREACCESS_STREAMING.
  1.1631 + *  \param numrects  The number of rectangles pointed to by rects.
  1.1632 + *  \param rects     The pointer to an array of dirty rectangles.
  1.1633 + *  
  1.1634 + *  \sa SDL_LockTexture()
  1.1635 + *  \sa SDL_UnlockTexture()
  1.1636   */
  1.1637  extern DECLSPEC void SDLCALL SDL_DirtyTexture(SDL_TextureID textureID,
  1.1638                                                int numrects,
  1.1639                                                const SDL_Rect * rects);
  1.1640  
  1.1641  /**
  1.1642 - * \fn int SDL_SetRenderDrawColor(Uint8 r, Uint8 g, Uint8 b, Uint8 a)
  1.1643 - *
  1.1644 - * \brief Set the color used for drawing operations (Fill and Line).
  1.1645 - *
  1.1646 - * \param r The red value used to draw on the rendering target
  1.1647 - * \param g The green value used to draw on the rendering target
  1.1648 - * \param b The blue value used to draw on the rendering target
  1.1649 - * \param a The alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255)
  1.1650 - * \return 0 on success, or -1 if there is no rendering context current
  1.1651 + *  \brief Set the color used for drawing operations (Fill and Line).
  1.1652 + *  
  1.1653 + *  \param r The red value used to draw on the rendering target.
  1.1654 + *  \param g The green value used to draw on the rendering target.
  1.1655 + *  \param b The blue value used to draw on the rendering target.
  1.1656 + *  \param a The alpha value used to draw on the rendering target, usually 
  1.1657 + *           ::SDL_ALPHA_OPAQUE (255).
  1.1658 + *  
  1.1659 + *  \return 0 on success, or -1 if there is no rendering context current.
  1.1660   */
  1.1661  extern DECLSPEC int SDL_SetRenderDrawColor(Uint8 r, Uint8 g, Uint8 b,
  1.1662                                             Uint8 a);
  1.1663  
  1.1664  /**
  1.1665 - * \fn int SDL_GetRenderDrawColor(Uint8 * r, Uint8 * g, Uint8 * b, Uint8 * a)
  1.1666 - *
  1.1667 - * \brief Get the color used for drawing operations (Fill and Line).
  1.1668 - *
  1.1669 - * \param r A pointer to the red value used to draw on the rendering target
  1.1670 - * \param g A pointer to the green value used to draw on the rendering target
  1.1671 - * \param b A pointer to the blue value used to draw on the rendering target
  1.1672 - * \param a A pointer to the alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255)
  1.1673 - * \return 0 on success, or -1 if there is no rendering context current
  1.1674 + *  \brief Get the color used for drawing operations (Fill and Line).
  1.1675 + *  
  1.1676 + *  \param r A pointer to the red value used to draw on the rendering target.
  1.1677 + *  \param g A pointer to the green value used to draw on the rendering target.
  1.1678 + *  \param b A pointer to the blue value used to draw on the rendering target.
  1.1679 + *  \param a A pointer to the alpha value used to draw on the rendering target, 
  1.1680 + *           usually ::SDL_ALPHA_OPAQUE (255).
  1.1681 + *  
  1.1682 + *  \return 0 on success, or -1 if there is no rendering context current.
  1.1683   */
  1.1684  extern DECLSPEC int SDL_GetRenderDrawColor(Uint8 * r, Uint8 * g, Uint8 * b,
  1.1685                                             Uint8 * a);
  1.1686  
  1.1687  /**
  1.1688 - * \fn int SDL_SetRenderDrawBlendMode(int blendMode)
  1.1689 - *
  1.1690 - * \brief Set the blend mode used for drawing operations (Fill and Line).
  1.1691 - *
  1.1692 - * \param blendMode SDL_BlendMode to use for blending
  1.1693 - *
  1.1694 - * \return 0 on success, or -1 if there is no rendering context current
  1.1695 - *
  1.1696 - * \note If the blend mode is not supported, the closest supported mode is chosen.
  1.1697 - *
  1.1698 - * \sa SDL_SetRenderDrawBlendMode()
  1.1699 + *  \brief Set the blend mode used for drawing operations (Fill and Line).
  1.1700 + *  
  1.1701 + *  \param blendMode ::SDL_BlendMode to use for blending.
  1.1702 + *  
  1.1703 + *  \return 0 on success, or -1 if there is no rendering context current.
  1.1704 + *  
  1.1705 + *  \note If the blend mode is not supported, the closest supported mode is 
  1.1706 + *        chosen.
  1.1707 + *  
  1.1708 + *  \sa SDL_GetRenderDrawBlendMode()
  1.1709   */
  1.1710  extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(int blendMode);
  1.1711  
  1.1712  /**
  1.1713 - * \fn int SDL_GetRenderDrawBlendMode(int *blendMode)
  1.1714 - *
  1.1715 - * \brief Get the blend mode used for drawing operations
  1.1716 - *
  1.1717 - * \param blendMode A pointer filled in with the current blend mode
  1.1718 - *
  1.1719 - * \return 0 on success, or -1 if there is no rendering context current
  1.1720 - *
  1.1721 - * \sa SDL_SetRenderDrawBlendMode()
  1.1722 + *  \brief Get the blend mode used for drawing operations.
  1.1723 + *  
  1.1724 + *  \param blendMode A pointer filled in with the current blend mode.
  1.1725 + *  
  1.1726 + *  \return 0 on success, or -1 if there is no rendering context current.
  1.1727 + *  
  1.1728 + *  \sa SDL_SetRenderDrawBlendMode()
  1.1729   */
  1.1730  extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(int *blendMode);
  1.1731  
  1.1732  /**
  1.1733 - * \fn int SDL_RenderPoint(int x, int y)
  1.1734 - *
  1.1735 - * \brief Draw a point on the current rendering target.
  1.1736 - *
  1.1737 - * \param x The x coordinate of the point
  1.1738 - * \param y The y coordinate of the point
  1.1739 - *
  1.1740 - * \return 0 on success, or -1 if there is no rendering context current
  1.1741 + *  \brief Draw a point on the current rendering target.
  1.1742 + *  
  1.1743 + *  \param x The x coordinate of the point.
  1.1744 + *  \param y The y coordinate of the point.
  1.1745 + *  
  1.1746 + *  \return 0 on success, or -1 if there is no rendering context current.
  1.1747   */
  1.1748  extern DECLSPEC int SDLCALL SDL_RenderPoint(int x, int y);
  1.1749  
  1.1750  /**
  1.1751 - * \fn int SDL_RenderLine(int x1, int y1, int x2, int y2)
  1.1752 - *
  1.1753 - * \brief Draw a line on the current rendering target.
  1.1754 - *
  1.1755 - * \param x1 The x coordinate of the start point
  1.1756 - * \param y1 The y coordinate of the start point
  1.1757 - * \param x2 The x coordinate of the end point
  1.1758 - * \param y2 The y coordinate of the end point
  1.1759 - *
  1.1760 - * \return 0 on success, or -1 if there is no rendering context current
  1.1761 + *  \brief Draw a line on the current rendering target.
  1.1762 + *  
  1.1763 + *  \param x1 The x coordinate of the start point.
  1.1764 + *  \param y1 The y coordinate of the start point.
  1.1765 + *  \param x2 The x coordinate of the end point.
  1.1766 + *  \param y2 The y coordinate of the end point.
  1.1767 + *  
  1.1768 + *  \return 0 on success, or -1 if there is no rendering context current.
  1.1769   */
  1.1770  extern DECLSPEC int SDLCALL SDL_RenderLine(int x1, int y1, int x2, int y2);
  1.1771  
  1.1772  /**
  1.1773 - * \fn void SDL_RenderFill(const SDL_Rect *rect)
  1.1774 - *
  1.1775 - * \brief Fill the current rendering target with the drawing color.
  1.1776 - *
  1.1777 - * \param rect A pointer to the destination rectangle, or NULL for the entire rendering target.
  1.1778 - *
  1.1779 - * \return 0 on success, or -1 if there is no rendering context current
  1.1780 + *  \brief Fill the current rendering target with the drawing color.
  1.1781 + *  
  1.1782 + *  \param rect A pointer to the destination rectangle, or NULL for the entire 
  1.1783 + *              rendering target.
  1.1784 + *  
  1.1785 + *  \return 0 on success, or -1 if there is no rendering context current.
  1.1786   */
  1.1787  extern DECLSPEC int SDLCALL SDL_RenderFill(const SDL_Rect * rect);
  1.1788  
  1.1789  /**
  1.1790 - * \fn int SDL_RenderCopy(SDL_TextureID textureID, const SDL_Rect *srcrect, const SDL_Rect *dstrect)
  1.1791 - *
  1.1792 - * \brief Copy a portion of the texture to the current rendering target.
  1.1793 - *
  1.1794 - * \param texture The source texture.
  1.1795 - * \param srcrect A pointer to the source rectangle, or NULL for the entire texture.
  1.1796 - * \param dstrect A pointer to the destination rectangle, or NULL for the entire rendering target.
  1.1797 - *
  1.1798 - * \return 0 on success, or -1 if there is no rendering context current, or the driver doesn't support the requested operation.
  1.1799 + *  \brief Copy a portion of the texture to the current rendering target.
  1.1800 + *  
  1.1801 + *  \param textureID The source texture.
  1.1802 + *  \param srcrect   A pointer to the source rectangle, or NULL for the entire 
  1.1803 + *                   texture.
  1.1804 + *  \param dstrect   A pointer to the destination rectangle, or NULL for the 
  1.1805 + *                   entire rendering target.
  1.1806 + *  
  1.1807 + *  \return 0 on success, or -1 if there is no rendering context current, or the
  1.1808 + *          driver doesn't support the requested operation.
  1.1809   */
  1.1810  extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_TextureID textureID,
  1.1811                                             const SDL_Rect * srcrect,
  1.1812                                             const SDL_Rect * dstrect);
  1.1813  
  1.1814  /**
  1.1815 - * \fn int SDL_RenderReadPixels(const SDL_Rect *rect, void *pixels, int pitch)
  1.1816 - *
  1.1817 - * \brief Read pixels from the current rendering target.
  1.1818 - *
  1.1819 - * \param rect A pointer to the rectangle to read, or NULL for the entire render target
  1.1820 - * \param pixels A pointer to be filled in with the pixel data in the rendering target format
  1.1821 - * \param pitch The pitch of the pixels parameter
  1.1822 - *
  1.1823 - * \return 0 on success, or -1 if pixel reading is not supported.
  1.1824 - *
  1.1825 - * \warning This is a very slow operation, and should not be used frequently.
  1.1826 + *  \brief Read pixels from the current rendering target.
  1.1827 + *  
  1.1828 + *  \param rect   A pointer to the rectangle to read, or NULL for the entire 
  1.1829 + *                render target.
  1.1830 + *  \param pixels A pointer to be filled in with the pixel data in the rendering
  1.1831 + *                target format.
  1.1832 + *  \param pitch  The pitch of the pixels parameter.
  1.1833 + *  
  1.1834 + *  \return 0 on success, or -1 if pixel reading is not supported.
  1.1835 + *  
  1.1836 + *  \warning This is a very slow operation, and should not be used frequently.
  1.1837   */
  1.1838  extern DECLSPEC int SDLCALL SDL_RenderReadPixels(const SDL_Rect * rect,
  1.1839                                                   void *pixels, int pitch);
  1.1840  
  1.1841  /**
  1.1842 - * \fn int SDL_RenderWritePixels(const SDL_Rect *rect, const void *pixels, int pitch)
  1.1843 - *
  1.1844 - * \brief Write pixels to the current rendering target.
  1.1845 - *
  1.1846 - * \param rect A pointer to the rectangle to write, or NULL for the entire render target
  1.1847 - * \param pixels A pointer to the pixel data to write
  1.1848 - * \param pitch The pitch of the pixels parameter
  1.1849 - *
  1.1850 - * \return 0 on success, or -1 if pixel writing is not supported.
  1.1851 - *
  1.1852 - * \warning This is a very slow operation, and should not be used frequently.
  1.1853 + *  \brief Write pixels to the current rendering target.
  1.1854 + *  
  1.1855 + *  \param rect   A pointer to the rectangle to write, or NULL for the entire 
  1.1856 + *                render target.
  1.1857 + *  \param pixels A pointer to the pixel data to write.
  1.1858 + *  \param pitch  The pitch of the pixels parameter.
  1.1859 + *  
  1.1860 + *  \return 0 on success, or -1 if pixel writing is not supported.
  1.1861 + *  
  1.1862 + *  \warning This is a very slow operation, and should not be used frequently.
  1.1863   */
  1.1864  extern DECLSPEC int SDLCALL SDL_RenderWritePixels(const SDL_Rect * rect,
  1.1865                                                    const void *pixels,
  1.1866                                                    int pitch);
  1.1867  
  1.1868  /**
  1.1869 - * \fn void SDL_RenderPresent(void)
  1.1870 - *
  1.1871 - * \brief Update the screen with rendering performed.
  1.1872 + *  \brief Update the screen with rendering performed.
  1.1873   */
  1.1874  extern DECLSPEC void SDLCALL SDL_RenderPresent(void);
  1.1875  
  1.1876  /**
  1.1877 - * \fn void SDL_DestroyTexture(SDL_TextureID textureID);
  1.1878 - *
  1.1879 - * \brief Destroy the specified texture.
  1.1880 - *
  1.1881 - * \sa SDL_CreateTexture()
  1.1882 - * \sa SDL_CreateTextureFromSurface()
  1.1883 + *  \brief Destroy the specified texture.
  1.1884 + *  
  1.1885 + *  \sa SDL_CreateTexture()
  1.1886 + *  \sa SDL_CreateTextureFromSurface()
  1.1887   */
  1.1888  extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_TextureID textureID);
  1.1889  
  1.1890  /**
  1.1891 - * \fn void SDL_DestroyRenderer(SDL_WindowID windowID);
  1.1892 - *
  1.1893 - * \brief Destroy the rendering context for a window and free associated
  1.1894 - *        textures.
  1.1895 - *
  1.1896 - * \sa SDL_CreateRenderer()
  1.1897 + *  \brief Destroy the rendering context for a window and free associated
  1.1898 + *         textures.
  1.1899 + *  
  1.1900 + *  \sa SDL_CreateRenderer()
  1.1901   */
  1.1902  extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_WindowID windowID);
  1.1903  
  1.1904  /**
  1.1905 - * \fn SDL_bool SDL_IsScreenSaverEnabled();
  1.1906 - *
  1.1907 - * \brief Returns whether the screensaver is currently enabled (default off).
  1.1908 - *
  1.1909 - * \sa SDL_EnableScreenSaver()
  1.1910 - * \sa SDL_DisableScreenSaver()
  1.1911 + *  \brief Returns whether the screensaver is currently enabled (default off).
  1.1912 + *  
  1.1913 + *  \sa SDL_EnableScreenSaver()
  1.1914 + *  \sa SDL_DisableScreenSaver()
  1.1915   */
  1.1916  extern DECLSPEC SDL_bool SDLCALL SDL_IsScreenSaverEnabled(void);
  1.1917  
  1.1918  /**
  1.1919 - * \fn void SDL_EnableScreenSaver();
  1.1920 - *
  1.1921 - * \brief Allow the screen to be blanked by a screensaver
  1.1922 - *
  1.1923 - * \sa SDL_IsScreenSaverEnabled()
  1.1924 - * \sa SDL_DisableScreenSaver()
  1.1925 + *  \brief Allow the screen to be blanked by a screensaver
  1.1926 + *  
  1.1927 + *  \sa SDL_IsScreenSaverEnabled()
  1.1928 + *  \sa SDL_DisableScreenSaver()
  1.1929   */
  1.1930  extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
  1.1931  
  1.1932  /**
  1.1933 - * \fn void SDL_DisableScreenSaver();
  1.1934 - *
  1.1935 - * \brief Prevent the screen from being blanked by a screensaver
  1.1936 - *
  1.1937 - * \sa SDL_IsScreenSaverEnabled()
  1.1938 - * \sa SDL_EnableScreenSaver()
  1.1939 + *  \brief Prevent the screen from being blanked by a screensaver
  1.1940 + *  
  1.1941 + *  \sa SDL_IsScreenSaverEnabled()
  1.1942 + *  \sa SDL_EnableScreenSaver()
  1.1943   */
  1.1944  extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
  1.1945  
  1.1946  
  1.1947 -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1.1948 -/* OpenGL support functions.                                                 */
  1.1949 -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  1.1950 +/**
  1.1951 + *  \name OpenGL support functions
  1.1952 + */
  1.1953 +/*@{*/
  1.1954  
  1.1955  /**
  1.1956 - * \fn int SDL_GL_LoadLibrary(const char *path)
  1.1957 - *
  1.1958 - * \brief Dynamically load an OpenGL library.
  1.1959 - *
  1.1960 - * \param path The platform dependent OpenGL library name, or NULL to open the default OpenGL library
  1.1961 - *
  1.1962 - * \return 0 on success, or -1 if the library couldn't be loaded
  1.1963 - *
  1.1964 - * This should be done after initializing the video driver, but before
  1.1965 - * creating any OpenGL windows.  If no OpenGL library is loaded, the default
  1.1966 - * library will be loaded upon creation of the first OpenGL window.
  1.1967 - *
  1.1968 - * \note If you do this, you need to retrieve all of the GL functions used in
  1.1969 - *       your program from the dynamic library using SDL_GL_GetProcAddress().
  1.1970 - *
  1.1971 - * \sa SDL_GL_GetProcAddress()
  1.1972 - * \sa SDL_GL_UnloadLibrary()
  1.1973 + *  \brief Dynamically load an OpenGL library.
  1.1974 + *  
  1.1975 + *  \param path The platform dependent OpenGL library name, or NULL to open the 
  1.1976 + *              default OpenGL library.
  1.1977 + *  
  1.1978 + *  \return 0 on success, or -1 if the library couldn't be loaded.
  1.1979 + *  
  1.1980 + *  This should be done after initializing the video driver, but before
  1.1981 + *  creating any OpenGL windows.  If no OpenGL library is loaded, the default
  1.1982 + *  library will be loaded upon creation of the first OpenGL window.
  1.1983 + *  
  1.1984 + *  \note If you do this, you need to retrieve all of the GL functions used in
  1.1985 + *        your program from the dynamic library using SDL_GL_GetProcAddress().
  1.1986 + *  
  1.1987 + *  \sa SDL_GL_GetProcAddress()
  1.1988 + *  \sa SDL_GL_UnloadLibrary()
  1.1989   */
  1.1990  extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
  1.1991  
  1.1992  /**
  1.1993 - * \fn void *SDL_GL_GetProcAddress(const char *proc)
  1.1994 - *
  1.1995 - * \brief Get the address of an OpenGL function.
  1.1996 + *  \brief Get the address of an OpenGL function.
  1.1997   */
  1.1998  extern DECLSPEC void *SDLCALL SDL_GL_GetProcAddress(const char *proc);
  1.1999  
  1.2000  /**
  1.2001 - * \fn void SDL_GL_UnloadLibrary(void)
  1.2002 - *
  1.2003 - * \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary()
  1.2004 - *
  1.2005 - * \sa SDL_GL_LoadLibrary()
  1.2006 + *  \brief Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
  1.2007 + *  
  1.2008 + *  \sa SDL_GL_LoadLibrary()
  1.2009   */
  1.2010  extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
  1.2011  
  1.2012  /**
  1.2013 - * \fn SDL_bool SDL_GL_ExtensionSupported(const char *extension)
  1.2014 - *
  1.2015 - * \brief Return true if an OpenGL extension is supported for the current context.
  1.2016 + *  \brief Return true if an OpenGL extension is supported for the current 
  1.2017 + *         context.
  1.2018   */
  1.2019  extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char
  1.2020                                                             *extension);
  1.2021  
  1.2022  /**
  1.2023 - * \fn int SDL_GL_SetAttribute(SDL_GLattr attr, int value)
  1.2024 - *
  1.2025 - * \brief Set an OpenGL window attribute before window creation.
  1.2026 + *  \brief Set an OpenGL window attribute before window creation.
  1.2027   */
  1.2028  extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
  1.2029  
  1.2030  /**
  1.2031 - * \fn int SDL_GL_GetWindowAttribute(SDL_WindowID windowID, SDL_GLattr attr, int *value)
  1.2032 - *
  1.2033 - * \brief Get the actual value for an attribute from the current context.
  1.2034 + *  \brief Get the actual value for an attribute from the current context.
  1.2035   */
  1.2036  extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
  1.2037  
  1.2038  /**
  1.2039 - * \fn SDL_GLContext SDL_GL_CreateContext(SDL_WindowID windowID)
  1.2040 - *
  1.2041 - * \brief Create an OpenGL context for use with an OpenGL window, and make it current.
  1.2042 - *
  1.2043 - * \sa SDL_GL_DeleteContext()
  1.2044 + *  \brief Create an OpenGL context for use with an OpenGL window, and make it 
  1.2045 + *         current.
  1.2046 + *  
  1.2047 + *  \sa SDL_GL_DeleteContext()
  1.2048   */
  1.2049  extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_WindowID
  1.2050                                                             windowID);
  1.2051  
  1.2052  /**
  1.2053 - * \fn int SDL_GL_MakeCurrent(SDL_WindowID windowID, SDL_GLContext context)
  1.2054 - *
  1.2055 - * \brief Set up an OpenGL context for rendering into an OpenGL window.
  1.2056 - *
  1.2057 - * \note The context must have been created with a compatible window.
  1.2058 + *  \brief Set up an OpenGL context for rendering into an OpenGL window.
  1.2059 + *  
  1.2060 + *  \note The context must have been created with a compatible window.
  1.2061   */
  1.2062  extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_WindowID windowID,
  1.2063                                                 SDL_GLContext context);
  1.2064  
  1.2065  /**
  1.2066 - * \fn int SDL_GL_SetSwapInterval(int interval)
  1.2067 - *
  1.2068 - * \brief Set the swap interval for the current OpenGL context.
  1.2069 - *
  1.2070 - * \param interval 0 for immediate updates, 1 for updates synchronized with the vertical retrace
  1.2071 - *
  1.2072 - * \return 0 on success, or -1 if setting the swap interval is not supported.
  1.2073 - *
  1.2074 - * \sa SDL_GL_GetSwapInterval()
  1.2075 + *  \brief Set the swap interval for the current OpenGL context.
  1.2076 + *  
  1.2077 + *  \param interval 0 for immediate updates, 1 for updates synchronized with the
  1.2078 + *                  vertical retrace.
  1.2079 + *  
  1.2080 + *  \return 0 on success, or -1 if setting the swap interval is not supported.
  1.2081 + *  
  1.2082 + *  \sa SDL_GL_GetSwapInterval()
  1.2083   */
  1.2084  extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
  1.2085  
  1.2086  /**
  1.2087 - * \fn int SDL_GL_GetSwapInterval(void)
  1.2088 - *
  1.2089 - * \brief Get the swap interval for the current OpenGL context.
  1.2090 - *
  1.2091 - * \return 0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if getting the swap interval is not supported.
  1.2092 - *
  1.2093 - * \sa SDL_GL_SetSwapInterval()
  1.2094 + *  \brief Get the swap interval for the current OpenGL context.
  1.2095 + *  
  1.2096 + *  \return 0 if there is no vertical retrace synchronization, 1 if the buffer 
  1.2097 + *          swap is synchronized with the vertical retrace, and -1 if getting 
  1.2098 + *          the swap interval is not supported.
  1.2099 + *  
  1.2100 + *  \sa SDL_GL_SetSwapInterval()
  1.2101   */
  1.2102  extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
  1.2103  
  1.2104  /**
  1.2105 - * \fn void SDL_GL_SwapWindow(SDL_WindowID windowID)
  1.2106 - *
  1.2107 - * \brief Swap the OpenGL buffers for the window, if double-buffering is supported.
  1.2108 + * \brief Swap the OpenGL buffers for the window, if double-buffering is 
  1.2109 + *        supported.
  1.2110   */
  1.2111  extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_WindowID windowID);
  1.2112  
  1.2113  /**
  1.2114 - * \fn void SDL_GL_DeleteContext(SDL_GLContext context)
  1.2115 - *
  1.2116 - * \brief Delete an OpenGL context.
  1.2117 - *
  1.2118 - * \sa SDL_GL_CreateContext()
  1.2119 + *  \brief Delete an OpenGL context.
  1.2120 + *  
  1.2121 + *  \sa SDL_GL_CreateContext()
  1.2122   */
  1.2123  extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
  1.2124  
  1.2125 +/*@}*//*OpenGL support functions*/
  1.2126 +
  1.2127  
  1.2128  /* Ends C function definitions when using C++ */
  1.2129  #ifdef __cplusplus