From 71b4b3dcba134a76d7490daf65523a6042efb94d Mon Sep 17 00:00:00 2001
From: Johannes Schickel
Date: Thu, 7 Jan 2010 15:28:58 +0000
Subject: - 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
---
 graphics/cursorman.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'graphics')

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.
-- 
cgit v1.2.3