diff options
| author | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-08-10 14:29:45 +0200 |
|---|---|---|
| committer | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-08-10 14:29:45 +0200 |
| commit | 4b1f7b27e3affdbc8b457de595a239f24d4022cb (patch) | |
| tree | 5f655a79405e2c43ee9d0a6d939088289cdcb4b8 | |
| parent | d18d2adc38d3da574a193928fe4b0b00123aac27 (diff) | |
| download | fpGUI-4b1f7b27e3affdbc8b457de595a239f24d4022cb.tar.xz | |
docs: updated docs for fpg_colormapping.pas unit.
Not all fpdoc output writers document the parameters
of methods. So instead of add the documentation of
those parameters as part of the Method help.
| -rw-r--r-- | docs/xml/gui/fpg_colormapping.xml | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/xml/gui/fpg_colormapping.xml b/docs/xml/gui/fpg_colormapping.xml index b833acf1..0a88ca1e 100644 --- a/docs/xml/gui/fpg_colormapping.xml +++ b/docs/xml/gui/fpg_colormapping.xml @@ -6,25 +6,24 @@ <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> + <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> - </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> + <seealso> + <link id="RGBToHSV"/> + </seealso> </element> </module> </package> |