diff options
| author | Johannes Schickel | 2010-01-07 15:28:58 +0000 |
|---|---|---|
| committer | Johannes Schickel | 2010-01-07 15:28:58 +0000 |
| commit | 71b4b3dcba134a76d7490daf65523a6042efb94d (patch) | |
| tree | 67ecb17c8aaa39636dc64ee8598201a6c9063fd8 /graphics/cursorman.h | |
| parent | 4f463e288e99c9b2adecfe91065da9cbd74950bf (diff) | |
| download | scummvm-rg350-71b4b3dcba134a76d7490daf65523a6042efb94d.tar.gz scummvm-rg350-71b4b3dcba134a76d7490daf65523a6042efb94d.tar.bz2 scummvm-rg350-71b4b3dcba134a76d7490daf65523a6042efb94d.zip | |
- Adapt documentation, that keycolor in setMouseCursor may not exceed the maximum color value of the specified format.
- Change SDL backend to assert out on invalid keycolor values
In case we really need a way to specify "no keycolor" we need to
discuss on how to do it *properly*.
svn-id: r47123
Diffstat (limited to 'graphics/cursorman.h')
| -rw-r--r-- | graphics/cursorman.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/graphics/cursorman.h b/graphics/cursorman.h index e0f9fcda2d..6b84be9f60 100644 --- a/graphics/cursorman.h +++ b/graphics/cursorman.h @@ -64,7 +64,8 @@ public: * @param h the height * @param hotspotX the hotspot X coordinate * @param hotspotY the hotspot Y coordinate - * @param keycolor the index for the transparent color + * @param keycolor the color value for the transparent color. This may not exceed + * the maximum color value as defined by format. * @param targetScale the scale for which the cursor is designed * @param format a pointer to the pixel format which the cursor graphic uses, * CLUT8 will be used if this is NULL or not specified. @@ -90,7 +91,8 @@ public: * @param h the height * @param hotspotX the hotspot X coordinate * @param hotspotY the hotspot Y coordinate - * @param keycolor the index for the transparent color + * @param keycolor the color value for the transparent color. This may not exceed + * the maximum color value as defined by format. * @param targetScale the scale for which the cursor is designed * @param format a pointer to the pixel format which the cursor graphic uses, * CLUT8 will be used if this is NULL or not specified. |