aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--common/system.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/common/system.h b/common/system.h
index 97fe582813..52fb2dbd56 100644
--- a/common/system.h
+++ b/common/system.h
@@ -548,6 +548,23 @@ public:
* Grabs a specified part of the currently active palette.
* The format is the same as for setPalette.
*
+ * This should return exactly the same RGB data as was setup via previous
+ * setPalette calls.
+ *
+ * For example, for every valid value of start and num of the following
+ * code:
+ *
+ * byte origPal[num*4];
+ * // Setup origPal's data however you like
+ * g_system->setPalette(origPal, start, num);
+ * byte obtainedPal[num*4];
+ * g_system->grabPalette(obtainedPal, start, num);
+ *
+ * the following should be true:
+ *
+ * For each i < num : memcmp(&origPal[i*4], &obtainedPal[i*4], 3) == 0
+ * (i is an uint here)
+ *
* @see setPalette
* @param colors the palette data, in interleaved RGBA format
* @param start the first platte entry to be read