From ba0c61b961eb0cb69885d72cfed8299c537105f8 Mon Sep 17 00:00:00 2001
From: Greg Ercolano <erco@seriss.com>
Date: Tue, 2 Apr 2013 16:47:57 +0000
Subject: Small color documentation clarification/improvements:     o Added
 some references to the FLTK colormap diagram in obvious places (Fl_Color
 docs)     o Added info regarding the 'reserved' colors     o Added quotes to
 clarify RGBI description: "RGB" and "I"

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9856 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Enumerations.H             | 6 +++---
 documentation/src/drawing.dox | 9 +++++----
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index 2fe35ee3d..26d521338 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -755,7 +755,7 @@ extern FL_EXPORT Fl_Fontsize FL_NORMAL_SIZE;	///< normal font size
     The Fl_Color type holds an FLTK color value.
 
     Colors are either 8-bit indexes into a virtual colormap
-    or 24-bit RGB color values.
+    or 24-bit RGB color values. (See \ref drawing_colors for the default FLTK colormap)
 
     Color indices occupy the lower 8 bits of the value, while
     RGB colors occupy the upper 24 bits, for a byte organization of RGBI.
@@ -763,7 +763,7 @@ extern FL_EXPORT Fl_Fontsize FL_NORMAL_SIZE;	///< normal font size
 <pre>
  Fl_Color => 0xrrggbbii
                 | | | |
-                | | | +--- index between 0 and 255
+                | | | +--- \ref drawing_colors "index" between 0 and 255
                 | | +----- blue color component (8 bit)
                 | +------- green component (8 bit)
                 +--------- red component (8 bit)
@@ -774,7 +774,7 @@ extern FL_EXPORT Fl_Fontsize FL_NORMAL_SIZE;	///< normal font size
 
  */
 /*@{*/
-/** an FLTK color value */
+/** An FLTK color value; see also \ref drawing_colors  */
 typedef unsigned int Fl_Color;
 
 // Standard colors. These are used as default colors in widgets and altered as necessary
diff --git a/documentation/src/drawing.dox b/documentation/src/drawing.dox
index 285a61ea5..8a2e0e940 100644
--- a/documentation/src/drawing.dox
+++ b/documentation/src/drawing.dox
@@ -154,11 +154,12 @@ the current clipping region.
 \section drawing_colors Colors
 
 FLTK manages colors as 32-bit unsigned integers, encoded as RGBI.
-When the RGB bytes are non-zero, the value is treated as RGB.
-If these bytes are zero, the I byte will be used as an index
-into the colormap.
+When the "RGB" bytes are non-zero, the value is treated as RGB.
+If these bytes are zero, the "I" byte will be used as an index
+into the colormap. Colors with both RGB set and an index >0
+are reserved for special use.
 
-Values from 0 to 255, i.e. the I index value, represent
+Values from 0 to 255, i.e. the "I" index value, represent
 colors from the FLTK 1.3.x standard colormap
 and are allocated as needed on screens without TrueColor support.
 The \b Fl_Color enumeration type defines the
-- 
cgit v1.2.3