← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpcolor/xml/gimpcolorspace.xml

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-08-22 11:50:05 UTC
  • mfrom: (0.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20080822115005-yxj5svf3v9x1mkr7
Tags: upstream-2.4.7
Import upstream version 2.4.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpcolor/xml/gimpcolorspace.xml
4
4
 
5
5
<refentry id="libgimpcolor-GimpColorSpace">
6
6
<refmeta>
7
 
<refentrytitle role="top_of_page">GimpColorSpace</refentrytitle>
 
7
<refentrytitle role="top_of_page" id="libgimpcolor-GimpColorSpace.top_of_page">GimpColorSpace</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPCOLOR Library</refmiscinfo>
10
10
</refmeta>
15
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
16
</refnamediv>
17
17
 
18
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="libgimpcolor-GimpColorSpace.synopsis" role="synopsis">
19
19
<title role="synopsis.title">Synopsis</title>
20
20
 
21
21
<synopsis>
22
 
 
23
 
 
24
 
 
25
22
<link linkend="void">void</link>                <link linkend="gimp-rgb-to-hsv">gimp_rgb_to_hsv</link>                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
26
23
                                                         <link linkend="GimpHSV">GimpHSV</link> *hsv);
27
24
<link linkend="void">void</link>                <link linkend="gimp-rgb-to-hsl">gimp_rgb_to_hsl</link>                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
85
82
 
86
83
 
87
84
 
88
 
<refsect1 role="desc">
 
85
<refsect1 id="libgimpcolor-GimpColorSpace.description" role="desc">
89
86
<title role="desc.title">Description</title>
90
87
<para>
91
88
When programming pixel data manipulation functions you will often use
95
92
</para>
96
93
</refsect1>
97
94
 
98
 
<refsect1 role="details">
 
95
<refsect1 id="libgimpcolor-GimpColorSpace.details" role="details">
99
96
<title role="details.title">Details</title>
100
 
<refsect2>
101
 
<title><anchor id="gimp-rgb-to-hsv" role="function"/>gimp_rgb_to_hsv ()</title>
102
 
<indexterm><primary>gimp_rgb_to_hsv</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsv                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
 
97
<refsect2 id="gimp-rgb-to-hsv" role="function">
 
98
<title>gimp_rgb_to_hsv ()</title>
 
99
<indexterm zone="gimp-rgb-to-hsv"><primary>gimp_rgb_to_hsv</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsv                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
103
100
                                                         <link linkend="GimpHSV">GimpHSV</link> *hsv);</programlisting>
104
101
<para>
105
102
Does a conversion from RGB to HSV (Hue, Saturation,
114
111
<listitem><simpara> The value converted to the HSV colorspace
115
112
</simpara></listitem></varlistentry>
116
113
</variablelist></refsect2>
117
 
<refsect2>
118
 
<title><anchor id="gimp-rgb-to-hsl" role="function"/>gimp_rgb_to_hsl ()</title>
119
 
<indexterm><primary>gimp_rgb_to_hsl</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsl                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
 
114
<refsect2 id="gimp-rgb-to-hsl" role="function">
 
115
<title>gimp_rgb_to_hsl ()</title>
 
116
<indexterm zone="gimp-rgb-to-hsl"><primary>gimp_rgb_to_hsl</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsl                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
120
117
                                                         <link linkend="GimpHSL">GimpHSL</link> *hsl);</programlisting>
121
118
<para>
122
119
Convert an RGB color value to a HSL (Hue, Saturation, Lightness)
131
128
<listitem><simpara> The value converted to HSL
132
129
</simpara></listitem></varlistentry>
133
130
</variablelist></refsect2>
134
 
<refsect2>
135
 
<title><anchor id="gimp-rgb-to-cmyk" role="function"/>gimp_rgb_to_cmyk ()</title>
136
 
<indexterm><primary>gimp_rgb_to_cmyk</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_cmyk                    (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
 
131
<refsect2 id="gimp-rgb-to-cmyk" role="function">
 
132
<title>gimp_rgb_to_cmyk ()</title>
 
133
<indexterm zone="gimp-rgb-to-cmyk"><primary>gimp_rgb_to_cmyk</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_cmyk                    (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
137
134
                                                         <link linkend="gdouble">gdouble</link> pullout,
138
135
                                                         <link linkend="GimpCMYK">GimpCMYK</link> *cmyk);</programlisting>
139
136
<para>
156
153
<listitem><simpara> The input value naively converted to the CMYK colorspace
157
154
</simpara></listitem></varlistentry>
158
155
</variablelist></refsect2>
159
 
<refsect2>
160
 
<title><anchor id="gimp-hsv-to-rgb" role="function"/>gimp_hsv_to_rgb ()</title>
161
 
<indexterm><primary>gimp_hsv_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsv_to_rgb                     (const <link linkend="GimpHSV">GimpHSV</link> *hsv,
 
156
<refsect2 id="gimp-hsv-to-rgb" role="function">
 
157
<title>gimp_hsv_to_rgb ()</title>
 
158
<indexterm zone="gimp-hsv-to-rgb"><primary>gimp_hsv_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsv_to_rgb                     (const <link linkend="GimpHSV">GimpHSV</link> *hsv,
162
159
                                                         <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
163
160
<para>
164
161
Converts a color value from HSV to RGB colorspace</para>
172
169
<listitem><simpara> The returned RGB value.
173
170
</simpara></listitem></varlistentry>
174
171
</variablelist></refsect2>
175
 
<refsect2>
176
 
<title><anchor id="gimp-hsl-to-rgb" role="function"/>gimp_hsl_to_rgb ()</title>
177
 
<indexterm><primary>gimp_hsl_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsl_to_rgb                     (const <link linkend="GimpHSL">GimpHSL</link> *hsl,
 
172
<refsect2 id="gimp-hsl-to-rgb" role="function">
 
173
<title>gimp_hsl_to_rgb ()</title>
 
174
<indexterm zone="gimp-hsl-to-rgb"><primary>gimp_hsl_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsl_to_rgb                     (const <link linkend="GimpHSL">GimpHSL</link> *hsl,
178
175
                                                         <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
179
176
<para>
180
177
Convert a HSL color value to an RGB color value.</para>
188
185
<listitem><simpara> The value converted to a value in the RGB colorspace
189
186
</simpara></listitem></varlistentry>
190
187
</variablelist></refsect2>
191
 
<refsect2>
192
 
<title><anchor id="gimp-cmyk-to-rgb" role="function"/>gimp_cmyk_to_rgb ()</title>
193
 
<indexterm><primary>gimp_cmyk_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_cmyk_to_rgb                    (const <link linkend="GimpCMYK">GimpCMYK</link> *cmyk,
 
188
<refsect2 id="gimp-cmyk-to-rgb" role="function">
 
189
<title>gimp_cmyk_to_rgb ()</title>
 
190
<indexterm zone="gimp-cmyk-to-rgb"><primary>gimp_cmyk_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_cmyk_to_rgb                    (const <link linkend="GimpCMYK">GimpCMYK</link> *cmyk,
194
191
                                                         <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
195
192
<para>
196
193
Does a simple transformation from the CMYK colorspace to the RGB
205
202
<listitem><simpara> The value converted to the RGB colorspace
206
203
</simpara></listitem></varlistentry>
207
204
</variablelist></refsect2>
208
 
<refsect2>
209
 
<title><anchor id="gimp-rgb-to-hwb" role="function"/>gimp_rgb_to_hwb ()</title>
210
 
<indexterm><primary>gimp_rgb_to_hwb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hwb                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
 
205
<refsect2 id="gimp-rgb-to-hwb" role="function">
 
206
<title>gimp_rgb_to_hwb ()</title>
 
207
<indexterm zone="gimp-rgb-to-hwb"><primary>gimp_rgb_to_hwb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hwb                     (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
211
208
                                                         <link linkend="gdouble">gdouble</link> *hue,
212
209
                                                         <link linkend="gdouble">gdouble</link> *whiteness,
213
210
                                                         <link linkend="gdouble">gdouble</link> *blackness);</programlisting>
236
233
<listitem><simpara> The blackness value of the above color, in the range 0 to 1
237
234
</simpara></listitem></varlistentry>
238
235
</variablelist></refsect2>
239
 
<refsect2>
240
 
<title><anchor id="gimp-hwb-to-rgb" role="function"/>gimp_hwb_to_rgb ()</title>
241
 
<indexterm><primary>gimp_hwb_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hwb_to_rgb                     (<link linkend="gdouble">gdouble</link> hue,
 
236
<refsect2 id="gimp-hwb-to-rgb" role="function">
 
237
<title>gimp_hwb_to_rgb ()</title>
 
238
<indexterm zone="gimp-hwb-to-rgb"><primary>gimp_hwb_to_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hwb_to_rgb                     (<link linkend="gdouble">gdouble</link> hue,
242
239
                                                         <link linkend="gdouble">gdouble</link> whiteness,
243
240
                                                         <link linkend="gdouble">gdouble</link> blackness,
244
241
                                                         <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
261
258
<listitem><simpara> The above color converted to the RGB colorspace
262
259
</simpara></listitem></varlistentry>
263
260
</variablelist></refsect2>
264
 
<refsect2>
265
 
<title><anchor id="gimp-rgb-to-hsv-int" role="function"/>gimp_rgb_to_hsv_int ()</title>
266
 
<indexterm><primary>gimp_rgb_to_hsv_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsv_int                 (<link linkend="gint">gint</link> *red,
 
261
<refsect2 id="gimp-rgb-to-hsv-int" role="function">
 
262
<title>gimp_rgb_to_hsv_int ()</title>
 
263
<indexterm zone="gimp-rgb-to-hsv-int"><primary>gimp_rgb_to_hsv_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsv_int                 (<link linkend="gint">gint</link> *red,
267
264
                                                         <link linkend="gint">gint</link> *green,
268
265
                                                         <link linkend="gint">gint</link> *blue);</programlisting>
269
266
<para>
288
285
<listitem><simpara> The blue channel value, returns the Value channel
289
286
</simpara></listitem></varlistentry>
290
287
</variablelist></refsect2>
291
 
<refsect2>
292
 
<title><anchor id="gimp-hsv-to-rgb-int" role="function"/>gimp_hsv_to_rgb_int ()</title>
293
 
<indexterm><primary>gimp_hsv_to_rgb_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsv_to_rgb_int                 (<link linkend="gint">gint</link> *hue,
 
288
<refsect2 id="gimp-hsv-to-rgb-int" role="function">
 
289
<title>gimp_hsv_to_rgb_int ()</title>
 
290
<indexterm zone="gimp-hsv-to-rgb-int"><primary>gimp_hsv_to_rgb_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsv_to_rgb_int                 (<link linkend="gint">gint</link> *hue,
294
291
                                                         <link linkend="gint">gint</link> *saturation,
295
292
                                                         <link linkend="gint">gint</link> *value);</programlisting>
296
293
<para>
313
310
<listitem><simpara> The value channel, returns the blue channel
314
311
</simpara></listitem></varlistentry>
315
312
</variablelist></refsect2>
316
 
<refsect2>
317
 
<title><anchor id="gimp-rgb-to-hsl-int" role="function"/>gimp_rgb_to_hsl_int ()</title>
318
 
<indexterm><primary>gimp_rgb_to_hsl_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsl_int                 (<link linkend="gint">gint</link> *red,
 
313
<refsect2 id="gimp-rgb-to-hsl-int" role="function">
 
314
<title>gimp_rgb_to_hsl_int ()</title>
 
315
<indexterm zone="gimp-rgb-to-hsl-int"><primary>gimp_rgb_to_hsl_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsl_int                 (<link linkend="gint">gint</link> *red,
319
316
                                                         <link linkend="gint">gint</link> *green,
320
317
                                                         <link linkend="gint">gint</link> *blue);</programlisting>
321
318
<para>
339
336
<listitem><simpara> Blue channel, returns Saturation channel
340
337
</simpara></listitem></varlistentry>
341
338
</variablelist></refsect2>
342
 
<refsect2>
343
 
<title><anchor id="gimp-rgb-to-cmyk-int" role="function"/>gimp_rgb_to_cmyk_int ()</title>
344
 
<indexterm><primary>gimp_rgb_to_cmyk_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_cmyk_int                (<link linkend="gint">gint</link> *red,
 
339
<refsect2 id="gimp-rgb-to-cmyk-int" role="function">
 
340
<title>gimp_rgb_to_cmyk_int ()</title>
 
341
<indexterm zone="gimp-rgb-to-cmyk-int"><primary>gimp_rgb_to_cmyk_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_cmyk_int                (<link linkend="gint">gint</link> *red,
345
342
                                                         <link linkend="gint">gint</link> *green,
346
343
                                                         <link linkend="gint">gint</link> *blue,
347
344
                                                         <link linkend="gint">gint</link> *pullout);</programlisting>
368
365
          the black value (0-255)
369
366
</simpara></listitem></varlistentry>
370
367
</variablelist></refsect2>
371
 
<refsect2>
372
 
<title><anchor id="gimp-cmyk-to-rgb-int" role="function"/>gimp_cmyk_to_rgb_int ()</title>
373
 
<indexterm><primary>gimp_cmyk_to_rgb_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_cmyk_to_rgb_int                (<link linkend="gint">gint</link> *cyan,
 
368
<refsect2 id="gimp-cmyk-to-rgb-int" role="function">
 
369
<title>gimp_cmyk_to_rgb_int ()</title>
 
370
<indexterm zone="gimp-cmyk-to-rgb-int"><primary>gimp_cmyk_to_rgb_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_cmyk_to_rgb_int                (<link linkend="gint">gint</link> *cyan,
374
371
                                                         <link linkend="gint">gint</link> *magenta,
375
372
                                                         <link linkend="gint">gint</link> *yellow,
376
373
                                                         <link linkend="gint">gint</link> *black);</programlisting>
393
390
<listitem><simpara>   the black channel (0-255); doesn't change
394
391
</simpara></listitem></varlistentry>
395
392
</variablelist></refsect2>
396
 
<refsect2>
397
 
<title><anchor id="gimp-rgb-to-l-int" role="function"/>gimp_rgb_to_l_int ()</title>
398
 
<indexterm><primary>gimp_rgb_to_l_int</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_rgb_to_l_int                   (<link linkend="gint">gint</link> red,
 
393
<refsect2 id="gimp-rgb-to-l-int" role="function">
 
394
<title>gimp_rgb_to_l_int ()</title>
 
395
<indexterm zone="gimp-rgb-to-l-int"><primary>gimp_rgb_to_l_int</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_rgb_to_l_int                   (<link linkend="gint">gint</link> red,
399
396
                                                         <link linkend="gint">gint</link> green,
400
397
                                                         <link linkend="gint">gint</link> blue);</programlisting>
401
398
<para>
416
413
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Luminance vaue corresponding to the input RGB value
417
414
</simpara></listitem></varlistentry>
418
415
</variablelist></refsect2>
419
 
<refsect2>
420
 
<title><anchor id="gimp-hsl-to-rgb-int" role="function"/>gimp_hsl_to_rgb_int ()</title>
421
 
<indexterm><primary>gimp_hsl_to_rgb_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsl_to_rgb_int                 (<link linkend="gint">gint</link> *hue,
 
416
<refsect2 id="gimp-hsl-to-rgb-int" role="function">
 
417
<title>gimp_hsl_to_rgb_int ()</title>
 
418
<indexterm zone="gimp-hsl-to-rgb-int"><primary>gimp_hsl_to_rgb_int</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsl_to_rgb_int                 (<link linkend="gint">gint</link> *hue,
422
419
                                                         <link linkend="gint">gint</link> *saturation,
423
420
                                                         <link linkend="gint">gint</link> *lightness);</programlisting>
424
421
<para>
441
438
<listitem><simpara> Lightness channel, returns Blue channel
442
439
</simpara></listitem></varlistentry>
443
440
</variablelist></refsect2>
444
 
<refsect2>
445
 
<title><anchor id="gimp-rgb-to-hsv4" role="function"/>gimp_rgb_to_hsv4 ()</title>
446
 
<indexterm><primary>gimp_rgb_to_hsv4</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsv4                    (const <link linkend="guchar">guchar</link> *rgb,
 
441
<refsect2 id="gimp-rgb-to-hsv4" role="function">
 
442
<title>gimp_rgb_to_hsv4 ()</title>
 
443
<indexterm zone="gimp-rgb-to-hsv4"><primary>gimp_rgb_to_hsv4</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_to_hsv4                    (const <link linkend="guchar">guchar</link> *rgb,
447
444
                                                         <link linkend="gdouble">gdouble</link> *hue,
448
445
                                                         <link linkend="gdouble">gdouble</link> *saturation,
449
446
                                                         <link linkend="gdouble">gdouble</link> *value);</programlisting>
466
463
<listitem><simpara>      Pointer to value channel (0..1)
467
464
</simpara></listitem></varlistentry>
468
465
</variablelist></refsect2>
469
 
<refsect2>
470
 
<title><anchor id="gimp-hsv-to-rgb4" role="function"/>gimp_hsv_to_rgb4 ()</title>
471
 
<indexterm><primary>gimp_hsv_to_rgb4</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsv_to_rgb4                    (<link linkend="guchar">guchar</link> *rgb,
 
466
<refsect2 id="gimp-hsv-to-rgb4" role="function">
 
467
<title>gimp_hsv_to_rgb4 ()</title>
 
468
<indexterm zone="gimp-hsv-to-rgb4"><primary>gimp_hsv_to_rgb4</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_hsv_to_rgb4                    (<link linkend="guchar">guchar</link> *rgb,
472
469
                                                         <link linkend="gdouble">gdouble</link> hue,
473
470
                                                         <link linkend="gdouble">gdouble</link> saturation,
474
471
                                                         <link linkend="gdouble">gdouble</link> value);</programlisting>
497
494
 
498
495
 
499
496
 
500
 
 
501
 
<refsect1><refsect2 /><refsect2 /></refsect1>
502
497
</refentry>