aboutsummaryrefslogtreecommitdiff
path: root/common/system.h
diff options
context:
space:
mode:
authorMax Horn2006-04-17 09:23:51 +0000
committerMax Horn2006-04-17 09:23:51 +0000
commiteb60d6abfe8b0a29dd9e93b8810ba7492904dbba (patch)
tree367c94b3054e22b2dc2934717b2ad7e8cbdbe348 /common/system.h
parentde250812e5e2a15fc3a1dddc9faae09f1c2df6d6 (diff)
downloadscummvm-rg350-eb60d6abfe8b0a29dd9e93b8810ba7492904dbba.tar.gz
scummvm-rg350-eb60d6abfe8b0a29dd9e93b8810ba7492904dbba.tar.bz2
scummvm-rg350-eb60d6abfe8b0a29dd9e93b8810ba7492904dbba.zip
Document how the alpha color component is to be interpreted
svn-id: r21962
Diffstat (limited to 'common/system.h')
-rw-r--r--common/system.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/common/system.h b/common/system.h
index 2c22fb4132..1b5781794e 100644
--- a/common/system.h
+++ b/common/system.h
@@ -545,6 +545,7 @@ public:
* be 8bit, 16bit or 32bit, depending on the target system. The default
* implementation generates a 16 bit color value, in the 565 format
* (that is, 5 bits red, 6 bits green, 5 bits blue).
+ * @note The alpha component, ranges from 0 (transparent) to 255 (opaque).
* @see colorToRGB
* @see RGBToColor
*/
@@ -557,6 +558,7 @@ public:
* be 8bit, 16bit or 32bit, depending on the target system. The default
* implementation takes a 16 bit color value and assumes it to be in 565 format
* (that is, 5 bits red, 6 bits green, 5 bits blue).
+ * @note The alpha component, ranges from 0 (transparent) to 255 (opaque).
* @see ARGBToColor
* @see colorToRGB
*/