Просмотр исходного кода

Updated SpriteBatch doxygen comments.

Darryl Gough 13 лет назад
Родитель
Сommit
b4482a3fdd
1 измененных файлов с 4 добавлено и 4 удалено
  1. 4 4
      gameplay/src/SpriteBatch.h

+ 4 - 4
gameplay/src/SpriteBatch.h

@@ -124,7 +124,7 @@ public:
      * @param color The color to tint the sprite. Use white for no tint.
      * @param color The color to tint the sprite. Use white for no tint.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
-     * @param rotationAngle The rotation angle.
+     * @param rotationAngle The rotation angle in radians.
      */
      */
     void draw(const Vector3& dst, const Rectangle& src, const Vector2& scale, const Vector4& color,
     void draw(const Vector3& dst, const Rectangle& src, const Vector2& scale, const Vector4& color,
               const Vector2& rotationPoint, float rotationAngle);
               const Vector2& rotationPoint, float rotationAngle);
@@ -142,7 +142,7 @@ public:
      * @param color The color to tint the sprite. Use white for no tint.
      * @param color The color to tint the sprite. Use white for no tint.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
-     * @param rotationAngle The rotation angle.
+     * @param rotationAngle The rotation angle in radians.
      * @param positionIsCenter Specified whether the given destination is to be the center of the sprite or not (if not, it is treated as the bottom-left).
      * @param positionIsCenter Specified whether the given destination is to be the center of the sprite or not (if not, it is treated as the bottom-left).
      */
      */
     void draw(const Vector3& dst, float width, float height, float u1, float v1, float u2, float v2, const Vector4& color,
     void draw(const Vector3& dst, float width, float height, float u1, float v1, float u2, float v2, const Vector4& color,
@@ -163,7 +163,7 @@ public:
      * @param color The color to tint the sprite. Use white for no tint.
      * @param color The color to tint the sprite. Use white for no tint.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
-     * @param rotationAngle The rotation angle.
+     * @param rotationAngle The rotation angle in radians.
      * @param positionIsCenter Specified whether the given destination is to be the center of the sprite or not (if not, it is treated as the bottom-left).
      * @param positionIsCenter Specified whether the given destination is to be the center of the sprite or not (if not, it is treated as the bottom-left).
      */
      */
     void draw(float x, float y, float z, float width, float height, float u1, float v1, float u2, float v2, const Vector4& color,
     void draw(float x, float y, float z, float width, float height, float u1, float v1, float u2, float v2, const Vector4& color,
@@ -184,7 +184,7 @@ public:
      * @param color The color to tint the sprite. Use white for no tint.
      * @param color The color to tint the sprite. Use white for no tint.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      * @param rotationPoint The point to rotate around, relative to dst's x and y values.
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
      *                      (e.g. Use Vector2(0.5f, 0.5f) to rotate around the quad's center.)
-     * @param rotationAngle The rotation angle.
+     * @param rotationAngle The rotation angle in radians.
      */
      */
     void draw(const Vector3& position, const Vector3& right, const Vector3& forward, float width, float height, 
     void draw(const Vector3& position, const Vector3& right, const Vector3& forward, float width, float height, 
               float u1, float v1, float u2, float v2, const Vector4& color, const Vector2& rotationPoint, float rotationAngle);
               float u1, float v1, float u2, float v2, const Vector4& color, const Vector2& rotationPoint, float rotationAngle);