Author: greg.ercolano
Date: 2013-04-02 09:47:57 -0700 (Tue, 02 Apr 2013)
New Revision: 9856
Log:
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"
Modified:
branches/branch-1.3/FL/Enumerations.H
branches/branch-1.3/documentation/src/drawing.dox
Modified: branches/branch-1.3/FL/Enumerations.H
===================================================================
--- branches/branch-1.3/FL/Enumerations.H 2013-03-29 18:26:36 UTC (rev
9855)
+++ branches/branch-1.3/FL/Enumerations.H 2013-04-02 16:47:57 UTC (rev
9856)
@@ -755,7 +755,7 @@
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 @@
<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 @@
*/
/*@{*/
-/** 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
Modified: branches/branch-1.3/documentation/src/drawing.dox
===================================================================
--- branches/branch-1.3/documentation/src/drawing.dox 2013-03-29 18:26:36 UTC
(rev 9855)
+++ branches/branch-1.3/documentation/src/drawing.dox 2013-04-02 16:47:57 UTC
(rev 9856)
@@ -154,11 +154,12 @@
\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
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
