aboutsummaryrefslogtreecommitdiff
path: root/graphics/cursorman.h
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/cursorman.h')
-rw-r--r--graphics/cursorman.h6
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.