[Scummvm-cvs-logs] CVS: scummvm/common system.h,1.70,1.71
Max Horn
fingolfin at users.sourceforge.net
Fri Oct 15 12:56:07 CEST 2004
Update of /cvsroot/scummvm/scummvm/common
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13765
Modified Files:
system.h
Log Message:
Clarify OSystem::setPalette documentation (thanks for pointing this out, LordHoto)
Index: system.h
===================================================================
RCS file: /cvsroot/scummvm/scummvm/common/system.h,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -d -r1.70 -r1.71
--- system.h 28 Sep 2004 20:19:25 -0000 1.70
+++ system.h 15 Oct 2004 19:54:14 -0000 1.71
@@ -235,12 +235,14 @@
/**
* Replace the specified range of the palette with new colors.
* The palette entries from 'start' till (start+num-1) will be replaced - so
- * a full palette update is acomplished via start=0, num=256.
- * The palette data is specified in interleaved RGB format. That is, the
+ * a full palette update is accomplished via start=0, num=256.
+ *
+ * The palette data is specified in interleaved RGBA format. That is, the
* first byte of the memory block 'colors' points at is the red component
* of the first new color; the second byte the blue component of the first
- * new color; the third byte the green compont. Then the second color
- * starts, and so on. So memory looks like this: R1-G1-B1-R2-G2-B2-R3-...
+ * new color; the third byte the green component, the last byte to the alpha
+ * (transparency) value. Then the second color starts, and so on. So memory
+ * looks like this: R1-G1-B1-A1-R2-G2-B2-A2-R3-...
*
* @param colors the new colors, in interleaved RGB format
* @param start the first palette entry to be updated
@@ -248,6 +250,8 @@
*
* @note It is an error if start+num exceeds 256, behaviour is undefined
* in that case (the backend may ignore it silently or assert).
+ * @note The alpha value is not actually used, and future revisions of this
+ * API are probably going to remove it.
*/
virtual void setPalette(const byte *colors, uint start, uint num) = 0;
More information about the Scummvm-git-logs
mailing list