libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2025-04-03 07:11:49 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

OSYSTEM: Clarify grabPalette documentation after talking with Max about it.

Browse Source 
svn-id: r54978
This commit is contained in:
Johannes Schickel 2010-12-20 17:28:17 +00:00
parent 184d56df0a
commit 6308dd77d6
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
common/system.h
View File

@ -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