1.1 --- a/include/SDL_events.h Sat May 18 14:04:37 2013 +0200
1.2 +++ b/include/SDL_events.h Sat May 18 14:48:19 2013 +0200
1.3 @@ -581,6 +581,7 @@
1.4 *
1.5 * \param event If not NULL, the next event is removed from the queue and
1.6 * stored in that area.
1.7 + * \param timeout The timeout (in milliseconds) to wait for next event.
1.8 */
1.9 extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
1.10 int timeout);
2.1 --- a/include/SDL_messagebox.h Sat May 18 14:04:37 2013 +0200
2.2 +++ b/include/SDL_messagebox.h Sat May 18 14:48:19 2013 +0200
2.3 @@ -108,6 +108,7 @@
2.4 * \brief Create a modal message box.
2.5 *
2.6 * \param messageboxdata The SDL_MessageBoxData structure with title, text, etc.
2.7 + * \param buttonid The pointer to which user id of hit button should be copied.
2.8 *
2.9 * \return -1 on error, otherwise 0 and buttonid contains user id of button
2.10 * hit or -1 if dialog was closed.
3.1 --- a/include/SDL_render.h Sat May 18 14:04:37 2013 +0200
3.2 +++ b/include/SDL_render.h Sat May 18 14:48:19 2013 +0200
3.3 @@ -216,6 +216,7 @@
3.4 /**
3.5 * \brief Create a texture for a rendering context.
3.6 *
3.7 + * \param renderer The renderer.
3.8 * \param format The format of the texture.
3.9 * \param access One of the enumerated values in ::SDL_TextureAccess.
3.10 * \param w The width of the texture in pixels.
3.11 @@ -237,6 +238,7 @@
3.12 /**
3.13 * \brief Create a texture from an existing surface.
3.14 *
3.15 + * \param renderer The renderer.
3.16 * \param surface The surface containing pixel data used to fill the texture.
3.17 *
3.18 * \return The created texture is returned, or 0 on error.
3.19 @@ -410,6 +412,7 @@
3.20 /**
3.21 * \brief Set a texture as the current rendering target.
3.22 *
3.23 + * \param renderer The renderer.
3.24 * \param texture The targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
3.25 *
3.26 * \return 0 on success, or -1 on error
3.27 @@ -431,6 +434,7 @@
3.28 /**
3.29 * \brief Set device independent resolution for rendering
3.30 *
3.31 + * \param renderer The renderer for which resolution should be set.
3.32 * \param w The width of the logical resolution
3.33 * \param h The height of the logical resolution
3.34 *
3.35 @@ -455,6 +459,7 @@
3.36 /**
3.37 * \brief Get device independent resolution for rendering
3.38 *
3.39 + * \param renderer The renderer from which resolution should be queried.
3.40 * \param w A pointer filled with the width of the logical resolution
3.41 * \param h A pointer filled with the height of the logical resolution
3.42 *
3.43 @@ -465,6 +470,7 @@
3.44 /**
3.45 * \brief Set the drawing area for rendering on the current target.
3.46 *
3.47 + * \param renderer The renderer for which the drawing area should be set.
3.48 * \param rect The rectangle representing the drawing area, or NULL to set the viewport to the entire target.
3.49 *
3.50 * The x,y of the viewport rect represents the origin for rendering.
3.51 @@ -491,6 +497,7 @@
3.52 /**
3.53 * \brief Set the clip rectangle for the current target.
3.54 *
3.55 + * \param renderer The renderer for which clip rectangle should be set.
3.56 * \param rect A pointer to the rectangle to set as the clip rectangle, or
3.57 * NULL to disable clipping.
3.58 *
3.59 @@ -504,6 +511,7 @@
3.60 /**
3.61 * \brief Get the clip rectangle for the current target.
3.62 *
3.63 + * \param renderer The renderer from which clip rectangle should be queried.
3.64 * \param rect A pointer filled in with the current clip rectangle, or
3.65 * an empty rectangle if clipping is disabled.
3.66 *
3.67 @@ -515,6 +523,7 @@
3.68 /**
3.69 * \brief Set the drawing scale for rendering on the current target.
3.70 *
3.71 + * \param renderer The renderer for which the drawing scale should be set.
3.72 * \param scaleX The horizontal scaling factor
3.73 * \param scaleY The vertical scaling factor
3.74 *
3.75 @@ -535,6 +544,7 @@
3.76 /**
3.77 * \brief Get the drawing scale for the current target.
3.78 *
3.79 + * \param renderer The renderer from which drawing scale should be queried.
3.80 * \param scaleX A pointer filled in with the horizontal scaling factor
3.81 * \param scaleY A pointer filled in with the vertical scaling factor
3.82 *
3.83 @@ -546,6 +556,7 @@
3.84 /**
3.85 * \brief Set the color used for drawing operations (Rect, Line and Clear).
3.86 *
3.87 + * \param renderer The renderer for which drawing color should be set.
3.88 * \param r The red value used to draw on the rendering target.
3.89 * \param g The green value used to draw on the rendering target.
3.90 * \param b The blue value used to draw on the rendering target.
3.91 @@ -561,6 +572,7 @@
3.92 /**
3.93 * \brief Get the color used for drawing operations (Rect, Line and Clear).
3.94 *
3.95 + * \param renderer The renderer from which drawing color should be queried.
3.96 * \param r A pointer to the red value used to draw on the rendering target.
3.97 * \param g A pointer to the green value used to draw on the rendering target.
3.98 * \param b A pointer to the blue value used to draw on the rendering target.
3.99 @@ -576,6 +588,7 @@
3.100 /**
3.101 * \brief Set the blend mode used for drawing operations (Fill and Line).
3.102 *
3.103 + * \param renderer The renderer for which blend mode should be set.
3.104 * \param blendMode ::SDL_BlendMode to use for blending.
3.105 *
3.106 * \return 0 on success, or -1 on error
3.107 @@ -591,6 +604,7 @@
3.108 /**
3.109 * \brief Get the blend mode used for drawing operations.
3.110 *
3.111 + * \param renderer The renderer from which blend mode should be queried.
3.112 * \param blendMode A pointer filled in with the current blend mode.
3.113 *
3.114 * \return 0 on success, or -1 on error
3.115 @@ -612,6 +626,7 @@
3.116 /**
3.117 * \brief Draw a point on the current rendering target.
3.118 *
3.119 + * \param renderer The renderer which should draw a point.
3.120 * \param x The x coordinate of the point.
3.121 * \param y The y coordinate of the point.
3.122 *
3.123 @@ -623,6 +638,7 @@
3.124 /**
3.125 * \brief Draw multiple points on the current rendering target.
3.126 *
3.127 + * \param renderer The renderer which should draw multiple points.
3.128 * \param points The points to draw
3.129 * \param count The number of points to draw
3.130 *
3.131 @@ -635,6 +651,7 @@
3.132 /**
3.133 * \brief Draw a line on the current rendering target.
3.134 *
3.135 + * \param renderer The renderer which should draw a line.
3.136 * \param x1 The x coordinate of the start point.
3.137 * \param y1 The y coordinate of the start point.
3.138 * \param x2 The x coordinate of the end point.
3.139 @@ -648,6 +665,7 @@
3.140 /**
3.141 * \brief Draw a series of connected lines on the current rendering target.
3.142 *
3.143 + * \param renderer The renderer which should draw multiple lines.
3.144 * \param points The points along the lines
3.145 * \param count The number of points, drawing count-1 lines
3.146 *
3.147 @@ -660,6 +678,7 @@
3.148 /**
3.149 * \brief Draw a rectangle on the current rendering target.
3.150 *
3.151 + * \param renderer The renderer which should draw a rectangle.
3.152 * \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
3.153 *
3.154 * \return 0 on success, or -1 on error
3.155 @@ -670,6 +689,7 @@
3.156 /**
3.157 * \brief Draw some number of rectangles on the current rendering target.
3.158 *
3.159 + * \param renderer The renderer which should draw multiple rectangles.
3.160 * \param rects A pointer to an array of destination rectangles.
3.161 * \param count The number of rectangles.
3.162 *
3.163 @@ -682,6 +702,7 @@
3.164 /**
3.165 * \brief Fill a rectangle on the current rendering target with the drawing color.
3.166 *
3.167 + * \param renderer The renderer which should fill a rectangle.
3.168 * \param rect A pointer to the destination rectangle, or NULL for the entire
3.169 * rendering target.
3.170 *
3.171 @@ -693,6 +714,7 @@
3.172 /**
3.173 * \brief Fill some number of rectangles on the current rendering target with the drawing color.
3.174 *
3.175 + * \param renderer The renderer which should fill multiple rectangles.
3.176 * \param rects A pointer to an array of destination rectangles.
3.177 * \param count The number of rectangles.
3.178 *
3.179 @@ -705,6 +727,7 @@
3.180 /**
3.181 * \brief Copy a portion of the texture to the current rendering target.
3.182 *
3.183 + * \param renderer The renderer which should copy parts of a texture.
3.184 * \param texture The source texture.
3.185 * \param srcrect A pointer to the source rectangle, or NULL for the entire
3.186 * texture.
3.187 @@ -721,6 +744,7 @@
3.188 /**
3.189 * \brief Copy a portion of the source texture to the current rendering target, rotating it by angle around the given center
3.190 *
3.191 + * \param renderer The renderer which should copy parts of a texture.
3.192 * \param texture The source texture.
3.193 * \param srcrect A pointer to the source rectangle, or NULL for the entire
3.194 * texture.
3.195 @@ -743,6 +767,7 @@
3.196 /**
3.197 * \brief Read pixels from the current rendering target.
3.198 *
3.199 + * \param renderer The renderer from which pixels should be read.
3.200 * \param rect A pointer to the rectangle to read, or NULL for the entire
3.201 * render target.
3.202 * \param format The desired format of the pixel data, or 0 to use the format
4.1 --- a/include/SDL_surface.h Sat May 18 14:04:37 2013 +0200
4.2 +++ b/include/SDL_surface.h Sat May 18 14:48:19 2013 +0200
4.3 @@ -109,6 +109,13 @@
4.4 * If the function runs out of memory, it will return NULL.
4.5 *
4.6 * \param flags The \c flags are obsolete and should be set to 0.
4.7 + * \param width The width in pixels of the surface to create.
4.8 + * \param height The height in pixels of the surface to create.
4.9 + * \param depth The depth in bits of the surface to create.
4.10 + * \param Rmask The red mask of the surface to create.
4.11 + * \param Gmask The green mask of the surface to create.
4.12 + * \param Bmask The blue mask of the surface to create.
4.13 + * \param Amask The alpha mask of the surface to create.
4.14 */
4.15 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
4.16 (Uint32 flags, int width, int height, int depth,
5.1 --- a/include/SDL_video.h Sat May 18 14:04:37 2013 +0200
5.2 +++ b/include/SDL_video.h Sat May 18 14:48:19 2013 +0200
5.3 @@ -323,6 +323,7 @@
5.4 /**
5.5 * \brief Get the closest match to the requested display mode.
5.6 *
5.7 + * \param displayIndex The index of display from which mode should be queried.
5.8 * \param mode The desired display mode
5.9 * \param closest A pointer to a display mode to be filled in with the closest
5.10 * match of the available display modes.
5.11 @@ -356,6 +357,7 @@
5.12 * By default the window's dimensions and the desktop format and refresh rate
5.13 * are used.
5.14 *
5.15 + * \param window The window for which the display mode should be set.
5.16 * \param mode The mode to use, or NULL for the default mode.
5.17 *
5.18 * \return 0 on success, or -1 if setting the display mode failed.
5.19 @@ -450,6 +452,7 @@
5.20 /**
5.21 * \brief Set the icon for a window.
5.22 *
5.23 + * \param window The window for which the icon should be set.
5.24 * \param icon The icon for the window.
5.25 */
5.26 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
5.27 @@ -707,6 +710,7 @@
5.28 /**
5.29 * \brief Set a window's input grab mode.
5.30 *
5.31 + * \param window The window for which the input grab mode should be set.
5.32 * \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
5.33 *
5.34 * \sa SDL_GetWindowGrab()
5.35 @@ -745,6 +749,7 @@
5.36 /**
5.37 * \brief Set the gamma ramp for a window.
5.38 *
5.39 + * \param window The window for which the gamma ramp should be set.
5.40 * \param red The translation table for the red channel, or NULL.
5.41 * \param green The translation table for the green channel, or NULL.
5.42 * \param blue The translation table for the blue channel, or NULL.
5.43 @@ -767,6 +772,7 @@
5.44 /**
5.45 * \brief Get the gamma ramp for a window.
5.46 *
5.47 + * \param window The window from which the gamma ramp should be queried.
5.48 * \param red A pointer to a 256 element array of 16-bit quantities to hold
5.49 * the translation table for the red channel, or NULL.
5.50 * \param green A pointer to a 256 element array of 16-bit quantities to hold