summaryrefslogtreecommitdiff
path: root/docs/xml/gui/fpg_colormapping.xml
blob: b833acf1463d9982eb5ceebed96c5961afd5074f (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
31
<?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>This function converts a RGB (Red, Green, Blue) colorspace value to HSV (Hue, Saturation, Value) colorspace. The parameters have specific value ranges. Please see the parameter documentation for more details.</descr>
      </element>
      <element name="HSVToRGB">
        <short>Map HSV colorspace to RGB colorspace.</short>
      </element>
      <element name="RGBToHSV.Hue">
        <short>Returned Hue value</short>
        <descr>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.</descr>
      </element>
      <element name="RGBToHSV.Saturation">
        <short>Returned Saturation value.</short>
        <descr>The Saturation value range is from 0.0 - 1.0. Grey (no color) = 0. Maximum color = 1.0.</descr>
      </element>
      <element name="RGBToHSV.Value">
        <short>Returned Value value.</short>
        <descr>The Value value range is from 0.0 to 1.0. Black being 0 and maximum brightness being 1.0.</descr>
      </element>
      <element name="HSVToRGB.H">
        <short>Hue value</short>
      </element>
    </module>
  </package>
</fpdoc-descriptions>