include/SDL_render.h
changeset 7188 20bd120bf7e4
parent 7175 45276691c8c8
child 7191 75360622e65f
     1.1 --- a/include/SDL_render.h	Sat May 18 14:04:37 2013 +0200
     1.2 +++ b/include/SDL_render.h	Sat May 18 14:48:19 2013 +0200
     1.3 @@ -216,6 +216,7 @@
     1.4  /**
     1.5   *  \brief Create a texture for a rendering context.
     1.6   *  
     1.7 + *  \param renderer The renderer.
     1.8   *  \param format The format of the texture.
     1.9   *  \param access One of the enumerated values in ::SDL_TextureAccess.
    1.10   *  \param w      The width of the texture in pixels.
    1.11 @@ -237,6 +238,7 @@
    1.12  /**
    1.13   *  \brief Create a texture from an existing surface.
    1.14   *  
    1.15 + *  \param renderer The renderer.
    1.16   *  \param surface The surface containing pixel data used to fill the texture.
    1.17   *  
    1.18   *  \return The created texture is returned, or 0 on error.
    1.19 @@ -410,6 +412,7 @@
    1.20  /**
    1.21   * \brief Set a texture as the current rendering target.
    1.22   *
    1.23 + * \param renderer The renderer.
    1.24   * \param texture The targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
    1.25   *
    1.26   * \return 0 on success, or -1 on error
    1.27 @@ -431,6 +434,7 @@
    1.28  /**
    1.29   *  \brief Set device independent resolution for rendering
    1.30   *
    1.31 + *  \param renderer The renderer for which resolution should be set.
    1.32   *  \param w      The width of the logical resolution
    1.33   *  \param h      The height of the logical resolution
    1.34   *
    1.35 @@ -455,6 +459,7 @@
    1.36  /**
    1.37   *  \brief Get device independent resolution for rendering
    1.38   *
    1.39 + *  \param renderer The renderer from which resolution should be queried.
    1.40   *  \param w      A pointer filled with the width of the logical resolution
    1.41   *  \param h      A pointer filled with the height of the logical resolution
    1.42   *
    1.43 @@ -465,6 +470,7 @@
    1.44  /**
    1.45   *  \brief Set the drawing area for rendering on the current target.
    1.46   *
    1.47 + *  \param renderer The renderer for which the drawing area should be set.
    1.48   *  \param rect The rectangle representing the drawing area, or NULL to set the viewport to the entire target.
    1.49   *
    1.50   *  The x,y of the viewport rect represents the origin for rendering.
    1.51 @@ -491,6 +497,7 @@
    1.52  /**
    1.53   *  \brief Set the clip rectangle for the current target.
    1.54   *  
    1.55 + *  \param renderer The renderer for which clip rectangle should be set.
    1.56   *  \param rect   A pointer to the rectangle to set as the clip rectangle, or
    1.57   *                NULL to disable clipping.
    1.58   *
    1.59 @@ -504,6 +511,7 @@
    1.60  /**
    1.61   *  \brief Get the clip rectangle for the current target.
    1.62   *  
    1.63 + *  \param renderer The renderer from which clip rectangle should be queried.
    1.64   *  \param rect   A pointer filled in with the current clip rectangle, or
    1.65   *                an empty rectangle if clipping is disabled.
    1.66   *
    1.67 @@ -515,6 +523,7 @@
    1.68  /**
    1.69   *  \brief Set the drawing scale for rendering on the current target.
    1.70   *
    1.71 + *  \param renderer The renderer for which the drawing scale should be set.
    1.72   *  \param scaleX The horizontal scaling factor
    1.73   *  \param scaleY The vertical scaling factor
    1.74   *
    1.75 @@ -535,6 +544,7 @@
    1.76  /**
    1.77   *  \brief Get the drawing scale for the current target.
    1.78   *
    1.79 + *  \param renderer The renderer from which drawing scale should be queried.
    1.80   *  \param scaleX A pointer filled in with the horizontal scaling factor
    1.81   *  \param scaleY A pointer filled in with the vertical scaling factor
    1.82   *
    1.83 @@ -546,6 +556,7 @@
    1.84  /**
    1.85   *  \brief Set the color used for drawing operations (Rect, Line and Clear).
    1.86   *  
    1.87 + *  \param renderer The renderer for which drawing color should be set.
    1.88   *  \param r The red value used to draw on the rendering target.
    1.89   *  \param g The green value used to draw on the rendering target.
    1.90   *  \param b The blue value used to draw on the rendering target.
    1.91 @@ -561,6 +572,7 @@
    1.92  /**
    1.93   *  \brief Get the color used for drawing operations (Rect, Line and Clear).
    1.94   *  
    1.95 + *  \param renderer The renderer from which drawing color should be queried.
    1.96   *  \param r A pointer to the red value used to draw on the rendering target.
    1.97   *  \param g A pointer to the green value used to draw on the rendering target.
    1.98   *  \param b A pointer to the blue value used to draw on the rendering target.
    1.99 @@ -576,6 +588,7 @@
   1.100  /**
   1.101   *  \brief Set the blend mode used for drawing operations (Fill and Line).
   1.102   *  
   1.103 + *  \param renderer The renderer for which blend mode should be set.
   1.104   *  \param blendMode ::SDL_BlendMode to use for blending.
   1.105   *  
   1.106   *  \return 0 on success, or -1 on error
   1.107 @@ -591,6 +604,7 @@
   1.108  /**
   1.109   *  \brief Get the blend mode used for drawing operations.
   1.110   *  
   1.111 + *  \param renderer The renderer from which blend mode should be queried.
   1.112   *  \param blendMode A pointer filled in with the current blend mode.
   1.113   *  
   1.114   *  \return 0 on success, or -1 on error
   1.115 @@ -612,6 +626,7 @@
   1.116  /**
   1.117   *  \brief Draw a point on the current rendering target.
   1.118   *  
   1.119 + *  \param renderer The renderer which should draw a point.
   1.120   *  \param x The x coordinate of the point.
   1.121   *  \param y The y coordinate of the point.
   1.122   *  
   1.123 @@ -623,6 +638,7 @@
   1.124  /**
   1.125   *  \brief Draw multiple points on the current rendering target.
   1.126   *  
   1.127 + *  \param renderer The renderer which should draw multiple points.
   1.128   *  \param points The points to draw
   1.129   *  \param count The number of points to draw
   1.130   *  
   1.131 @@ -635,6 +651,7 @@
   1.132  /**
   1.133   *  \brief Draw a line on the current rendering target.
   1.134   *  
   1.135 + *  \param renderer The renderer which should draw a line.
   1.136   *  \param x1 The x coordinate of the start point.
   1.137   *  \param y1 The y coordinate of the start point.
   1.138   *  \param x2 The x coordinate of the end point.
   1.139 @@ -648,6 +665,7 @@
   1.140  /**
   1.141   *  \brief Draw a series of connected lines on the current rendering target.
   1.142   *  
   1.143 + *  \param renderer The renderer which should draw multiple lines.
   1.144   *  \param points The points along the lines
   1.145   *  \param count The number of points, drawing count-1 lines
   1.146   *  
   1.147 @@ -660,6 +678,7 @@
   1.148  /**
   1.149   *  \brief Draw a rectangle on the current rendering target.
   1.150   *  
   1.151 + *  \param renderer The renderer which should draw a rectangle.
   1.152   *  \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
   1.153   *  
   1.154   *  \return 0 on success, or -1 on error
   1.155 @@ -670,6 +689,7 @@
   1.156  /**
   1.157   *  \brief Draw some number of rectangles on the current rendering target.
   1.158   *  
   1.159 + *  \param renderer The renderer which should draw multiple rectangles.
   1.160   *  \param rects A pointer to an array of destination rectangles.
   1.161   *  \param count The number of rectangles.
   1.162   *  
   1.163 @@ -682,6 +702,7 @@
   1.164  /**
   1.165   *  \brief Fill a rectangle on the current rendering target with the drawing color.
   1.166   *  
   1.167 + *  \param renderer The renderer which should fill a rectangle.
   1.168   *  \param rect A pointer to the destination rectangle, or NULL for the entire 
   1.169   *              rendering target.
   1.170   *  
   1.171 @@ -693,6 +714,7 @@
   1.172  /**
   1.173   *  \brief Fill some number of rectangles on the current rendering target with the drawing color.
   1.174   *  
   1.175 + *  \param renderer The renderer which should fill multiple rectangles.
   1.176   *  \param rects A pointer to an array of destination rectangles.
   1.177   *  \param count The number of rectangles.
   1.178   *  
   1.179 @@ -705,6 +727,7 @@
   1.180  /**
   1.181   *  \brief Copy a portion of the texture to the current rendering target.
   1.182   *  
   1.183 + *  \param renderer The renderer which should copy parts of a texture.
   1.184   *  \param texture The source texture.
   1.185   *  \param srcrect   A pointer to the source rectangle, or NULL for the entire 
   1.186   *                   texture.
   1.187 @@ -721,6 +744,7 @@
   1.188  /**
   1.189   *  \brief Copy a portion of the source texture to the current rendering target, rotating it by angle around the given center 
   1.190   *
   1.191 + *  \param renderer The renderer which should copy parts of a texture.
   1.192   *  \param texture The source texture.
   1.193   *  \param srcrect   A pointer to the source rectangle, or NULL for the entire
   1.194   *                   texture.
   1.195 @@ -743,6 +767,7 @@
   1.196  /**
   1.197   *  \brief Read pixels from the current rendering target.
   1.198   *  
   1.199 + *  \param renderer The renderer from which pixels should be read.
   1.200   *  \param rect   A pointer to the rectangle to read, or NULL for the entire 
   1.201   *                render target.
   1.202   *  \param format The desired format of the pixel data, or 0 to use the format