summaryrefslogtreecommitdiff
path: root/docs/xml/gui/fpg_colormapping.xml
blob: 0a88ca1ef4e650eba295dfa64c3bf650ec3a647b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<?xml version="1.0"?>
<fpdoc-descriptions>
  <package name="fpGUI">
    <module name="fpg_colormapping">
      <short>This unit contains some color conversion/mapping functions.</short>
      <descr/>
      <element name="RGBToHSV">
        <short>Map RGB colorspace to HSV colorspace.</short>
        <descr><p>This function converts a RGB (Red, Green, Blue) colorspace value to 
HSV (Hue, Saturation, Value) colorspace. The parameters have specific value ranges as
listed below.</p>
<dl>
<dt>Hue</dt>
<dd>The Hue range is from 0 - 1535. In that range, the primary colors are mapped to the following values. Red = 0. Green = 512 and Blue = 1024.</dd>
<dt>Saturation</dt>
<dd>The Saturation value range is from 0.0 - 1.0. Grey (no color) = 0. Maximum color = 1.0.</dd>
<dt>Value</dt>
<dd>The Value value range is from 0.0 to 1.0. Black being 0 and maximum brightness being 1.0.</dd>
</dl>
        </descr>
      </element>
      <element name="HSVToRGB">
        <short>Map HSV colorspace to RGB colorspace.</short>
        <seealso>
          <link id="RGBToHSV"/>
        </seealso>
      </element>
    </module>
  </package>
</fpdoc-descriptions>