libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2025-01-31 07:53:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

GRAPHICS: Fix some Doxygen comments that seem wrong.

Browse Source
This commit is contained in:
Einar Johan Trøan Sømåen 2014-08-29 03:26:48 +02:00
parent 183f8eea43
commit 0593c2eab2
5 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
graphics/VectorRenderer.h
View File

@ -182,7 +182,7 @@ public:
* @param x Horizontal (X) coordinate for the top left corner of the triangle
* @param y Vertical (Y) coordinate for the top left corner of the triangle
* @param base Width of the base of the triangle
* @param h Height of the triangle
* @param height Height of the triangle
* @param orient Orientation of the triangle.
*/
virtual void drawTriangle(int x, int y, int base, int height, TriangleOrientation orient) = 0;
@ -276,8 +276,6 @@ public:
/**
* Fills the active surface with the specified fg/bg color or the active gradient.
* Defaults to using the active Foreground color for filling.
*
* @param mode Fill mode (bg, fg or gradient) used to fill the surface
*/
virtual void fillSurface() = 0;

8
graphics/conversion.h
View File

@ -48,10 +48,10 @@ inline static void RGB2YUV(byte r, byte g, byte b, byte &y, byte &u, byte &v) {
/**
* Blits a rectangle from one graphical format to another.
*
* @param dstbuf the buffer which will recieve the converted graphics data
* @param srcbuf the buffer containing the original graphics data
* @param dstpitch width in bytes of one full line of the dest buffer
* @param srcpitch width in bytes of one full line of the source buffer
* @param dst the buffer which will recieve the converted graphics data
* @param src the buffer containing the original graphics data
* @param dstPitch width in bytes of one full line of the dest buffer
* @param srcPitch width in bytes of one full line of the source buffer
* @param w the width of the graphics data
* @param h the height of the graphics data
* @param dstFmt the desired pixel format

1
graphics/fontman.h
View File

@ -75,7 +75,6 @@ public:
* Associates a BDF font object with an 'usage'. This is useful for platforms
* with a screen DPI much larger than a regular desktop workstation.
*
* @param name the name of the font
* @param font the font object
* @return true on success, false on failure
*/

5
graphics/surface.h
View File

@ -214,7 +214,7 @@ public:
* of buffer must match the pixel format of the Surface.
*
* @param buffer The buffer containing the graphics data source
* @param pitch The pitch of the buffer (number of bytes in a scanline)
* @param srcPitch The pitch of the buffer (number of bytes in a scanline)
* @param destX The x coordinate of the destination rectangle
* @param destY The y coordinate of the destination rectangle
* @param width The width of the destination rectangle
@ -228,8 +228,7 @@ public:
* @param srcSurface The source of the bitmap data
* @param destX The x coordinate of the destination rectangle
* @param destY The y coordinate of the destination rectangle
* @param subRect The subRect of surface to be blitted
* @return
* @param subRect The subRect of surface to be blitted
*/
void copyRectToSurface(const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect);

10
graphics/transform_tools.h
View File

@ -57,15 +57,15 @@ class TransformTools {
public:
/**
* Basic transform (scale + rotate) for a single point
* @param point the point on which the transform is to be applied
* @param rotate the angle in degrees
* @param zoom zoom x,y in percent
* @param mirrorX flip along the vertical axis?
* @param mirrorY flip along the horizontal axis?
*/
static FloatPoint transformPoint(FloatPoint point, const float rotate, const Common::Point &zoom, const bool mirrorX = false, const bool mirrorY = false);
/**
* @param &point the point on which the transform is to be applied
* @param rotate the angle in degrees
* @param &zoom zoom x,y in percent
* @param mirrorX flip along the vertical axis?
* @param mirrorY flip along the horizontal axis?
* @return the smallest rect that can contain the transformed sprite
* and, as a side-effect, "newHotspot" will tell you where the hotspot will
* have ended up in the new rect, for centering.