[Scummvm-cvs-logs] CVS: scummvm/common system.h,1.105,1.106
Max Horn
fingolfin at users.sourceforge.net
Tue Nov 8 14:30:05 CET 2005
Update of /cvsroot/scummvm/scummvm/common
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16464/common
Modified Files:
system.h
Log Message:
Augmented OSystem docs
Index: system.h
===================================================================
RCS file: /cvsroot/scummvm/scummvm/common/system.h,v
retrieving revision 1.105
retrieving revision 1.106
diff -u -d -r1.105 -r1.106
--- system.h 18 Oct 2005 01:30:17 -0000 1.105
+++ system.h 8 Nov 2005 22:28:31 -0000 1.106
@@ -384,6 +384,21 @@
* Client code has to to call updateScreen to ensure any changes are
* visible to the user. This can be used to optimize drawing and reduce
* flicker.
+ * The graphics data uses 8 bits per pixel, using the palette specified
+ * via setPalette.
+ *
+ * @param buf the buffer containing the graphics data source
+ * @param pitch the pitch of the buffer (number of bytes 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
+ *
+ * @note The specified destination rectangle must be completly contained
+ * in the visible screen space, and must be non-empty. If not, a
+ * backend may or may not perform clipping, trigger an assert or
+ * silently corrupt memory.
+ *
* @see updateScreen
*/
virtual void copyRectToScreen(const byte *buf, int pitch, int x, int y, int w, int h) = 0;
More information about the Scummvm-git-logs
mailing list