[Scummvm-cvs-logs] SF.net SVN: scummvm:[36150] scummvm/trunk/common/system.h

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Fri Jan 30 17:16:57 CET 2009


Revision: 36150
          http://scummvm.svn.sourceforge.net/scummvm/?rev=36150&view=rev
Author:   fingolfin
Date:     2009-01-30 16:16:52 +0000 (Fri, 30 Jan 2009)

Log Message:
-----------
Document OSystem::copyRectToOverlay params more explicitly (esp. the pitch param, which differs from that of copyRectToScreen)

Modified Paths:
--------------
    scummvm/trunk/common/system.h

Modified: scummvm/trunk/common/system.h
===================================================================
--- scummvm/trunk/common/system.h	2009-01-30 16:04:39 UTC (rev 36149)
+++ scummvm/trunk/common/system.h	2009-01-30 16:16:52 UTC (rev 36150)
@@ -617,6 +617,20 @@
 	/**
 	 * Blit a graphics buffer to the overlay.
 	 * In a sense, this is the reverse of grabOverlay.
+	 *
+	 * @note The pitch parameter actually contains the 'pixel pitch', i.e.,
+	 * the number of pixels per scanline, and not as usual the number of bytes
+	 * per scanline.
+	 *
+	 * @todo Change 'pitch' to be byte and not pixel based
+	 *
+	 * @param buf		the buffer containing the graphics data source
+	 * @param pitch		the pixel pitch of the buffer (number of pixels in a scanline)
+	 * @param x			the x coordinate of the destination rectangle
+	 * @param y			the y coordinate of the destination rectangle
+	 * @param w			the width of the destination rectangle
+	 * @param h			the height of the destination rectangle
+	 *
 	 * @see copyRectToScreen
 	 * @see grabOverlay
 	 */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list