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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpcolor">
<refmeta>
<refentrytitle role="top_of_page">gimpcolor</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpcolor</refname>
<refpurpose>Functions for manipulating color.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brightness-contrast">gimp_brightness_contrast</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> brightness,
<link linkend="gint">gint</link> contrast);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-levels">gimp_levels</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> low_input,
<link linkend="gint">gint</link> high_input,
<link linkend="gdouble">gdouble</link> gamma,
<link linkend="gint">gint</link> low_output,
<link linkend="gint">gint</link> high_output);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-levels-auto">gimp_levels_auto</link> (<link linkend="gint32">gint32</link> drawable_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-levels-stretch">gimp_levels_stretch</link> (<link linkend="gint32">gint32</link> drawable_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-posterize">gimp_posterize</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> levels);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-desaturate">gimp_desaturate</link> (<link linkend="gint32">gint32</link> drawable_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-equalize">gimp_equalize</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gboolean">gboolean</link> mask_only);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-invert">gimp_invert</link> (<link linkend="gint32">gint32</link> drawable_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-curves-spline">gimp_curves_spline</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> num_points,
const <link linkend="guint8">guint8</link> *control_pts);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-curves-explicit">gimp_curves_explicit</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> num_bytes,
const <link linkend="guint8">guint8</link> *curve);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-balance">gimp_color_balance</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpTransferMode">GimpTransferMode</link> transfer_mode,
<link linkend="gboolean">gboolean</link> preserve_lum,
<link linkend="gdouble">gdouble</link> cyan_red,
<link linkend="gdouble">gdouble</link> magenta_green,
<link linkend="gdouble">gdouble</link> yellow_blue);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-colorize">gimp_colorize</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gdouble">gdouble</link> hue,
<link linkend="gdouble">gdouble</link> saturation,
<link linkend="gdouble">gdouble</link> lightness);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-histogram">gimp_histogram</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> start_range,
<link linkend="gint">gint</link> end_range,
<link linkend="gdouble">gdouble</link> *mean,
<link linkend="gdouble">gdouble</link> *std_dev,
<link linkend="gdouble">gdouble</link> *median,
<link linkend="gdouble">gdouble</link> *pixels,
<link linkend="gdouble">gdouble</link> *count,
<link linkend="gdouble">gdouble</link> *percentile);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-hue-saturation">gimp_hue_saturation</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHueRange">GimpHueRange</link> hue_range,
<link linkend="gdouble">gdouble</link> hue_offset,
<link linkend="gdouble">gdouble</link> lightness,
<link linkend="gdouble">gdouble</link> saturation);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-threshold">gimp_threshold</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> low_threshold,
<link linkend="gint">gint</link> high_threshold);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions for manipulating color, including curves and histograms.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-brightness-contrast" role="function"/>gimp_brightness_contrast ()</title>
<indexterm><primary>gimp_brightness_contrast</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brightness_contrast (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> brightness,
<link linkend="gint">gint</link> contrast);</programlisting>
<para>
Modify brightness/contrast in the specified drawable.
</para>
<para>
This procedures allows the brightness and contrast of the specified
drawable to be modified. Both 'brightness' and 'contrast' parameters
are defined between -127 and 127.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>brightness</parameter> :</term>
<listitem><simpara> Brightness adjustment.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contrast</parameter> :</term>
<listitem><simpara> Contrast adjustment.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-levels" role="function"/>gimp_levels ()</title>
<indexterm><primary>gimp_levels</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_levels (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> low_input,
<link linkend="gint">gint</link> high_input,
<link linkend="gdouble">gdouble</link> gamma,
<link linkend="gint">gint</link> low_output,
<link linkend="gint">gint</link> high_output);</programlisting>
<para>
Modifies intensity levels in the specified drawable.
</para>
<para>
This tool allows intensity levels in the specified drawable to be
remapped according to a set of parameters. The low/high input levels
specify an initial mapping from the source intensities. The gamma
value determines how intensities between the low and high input
intensities are interpolated. A gamma value of 1.0 results in a
linear interpolation. Higher gamma values result in more high-level
intensities. Lower gamma values result in more low-level
intensities. The low/high output levels constrain the final
intensity mapping--that is, no final intensity will be lower than
the low output level and no final intensity will be higher than the
high output level. This tool is only valid on RGB color and
grayscale images. It will not operate on indexed drawables.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>channel</parameter> :</term>
<listitem><simpara> The channel to modify.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>low_input</parameter> :</term>
<listitem><simpara> Intensity of lowest input.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>high_input</parameter> :</term>
<listitem><simpara> Intensity of highest input.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>gamma</parameter> :</term>
<listitem><simpara> Gamma correction factor.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>low_output</parameter> :</term>
<listitem><simpara> Intensity of lowest output.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>high_output</parameter> :</term>
<listitem><simpara> Intensity of highest output.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-levels-auto" role="function" condition="deprecated:"/>gimp_levels_auto ()</title>
<indexterm role="deprecated"><primary>gimp_levels_auto</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_levels_auto (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
<warning><para><literal>gimp_levels_auto</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-levels-stretch"><function>gimp_levels_stretch()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-levels-stretch" role="function"/>gimp_levels_stretch ()</title>
<indexterm><primary>gimp_levels_stretch</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_levels_stretch (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
<para>
Automatically modifies intensity levels in the specified drawable.
</para>
<para>
This procedure allows intensity levels in the specified drawable to
be remapped according to a set of guessed parameters. It is
equivalent to clicking the \"Auto\" button in the Levels tool. This
procedure is only valid on RGB color and grayscale images. It will
not operate on indexed drawables.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-posterize" role="function"/>gimp_posterize ()</title>
<indexterm><primary>gimp_posterize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_posterize (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> levels);</programlisting>
<para>
Posterize the specified drawable.
</para>
<para>
This procedures reduces the number of shades allows in each
intensity channel to the specified 'levels' parameter.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>levels</parameter> :</term>
<listitem><simpara> Levels of posterization.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-desaturate" role="function"/>gimp_desaturate ()</title>
<indexterm><primary>gimp_desaturate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_desaturate (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
<para>
Desaturate the contents of the specified drawable.
</para>
<para>
This procedure desaturates the contents of the specified drawable.
This procedure only works on drawables of type RGB color.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-equalize" role="function"/>gimp_equalize ()</title>
<indexterm><primary>gimp_equalize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_equalize (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gboolean">gboolean</link> mask_only);</programlisting>
<para>
Equalize the contents of the specified drawable.
</para>
<para>
This procedure equalizes the contents of the specified drawable.
Each intensity channel is equalizeed independently. The equalized
intensity is given as inten' = (255 - inten). Indexed color
drawables are not valid for this operation. The 'mask_only' option
specifies whether to adjust only the area of the image within the
selection bounds, or the entire image based on the histogram of the
selected area. If there is no selection, the entire image is
adjusted based on the histogram for the entire image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_only</parameter> :</term>
<listitem><simpara> Equalization option.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-invert" role="function"/>gimp_invert ()</title>
<indexterm><primary>gimp_invert</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_invert (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
<para>
Invert the contents of the specified drawable.
</para>
<para>
This procedure inverts the contents of the specified drawable. Each
intensity channel is inverted independently. The inverted intensity
is given as inten' = (255 - inten). Indexed color drawables are not
valid for this operation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-curves-spline" role="function"/>gimp_curves_spline ()</title>
<indexterm><primary>gimp_curves_spline</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_curves_spline (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> num_points,
const <link linkend="guint8">guint8</link> *control_pts);</programlisting>
<para>
Modifies the intensity curve(s) for specified drawable.
</para>
<para>
Modifies the intensity mapping for one channel in the specified
drawable. The drawable must be either grayscale or RGB, and the
channel can be either an intensity component, or the value. The
'control_pts' parameter is an array of integers which define a set
of control points which describe a Catmull Rom spline which yields
the final intensity curve. Use the 'gimp_curves_explicit' function
to explicitly modify intensity levels.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>channel</parameter> :</term>
<listitem><simpara> The channel to modify.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_points</parameter> :</term>
<listitem><simpara> The number of values in the control point array.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>control_pts</parameter> :</term>
<listitem><simpara> The spline control points: { cp1.x, cp1.y, cp2.x, cp2.y, ... }.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-curves-explicit" role="function"/>gimp_curves_explicit ()</title>
<indexterm><primary>gimp_curves_explicit</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_curves_explicit (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> num_bytes,
const <link linkend="guint8">guint8</link> *curve);</programlisting>
<para>
Modifies the intensity curve(s) for specified drawable.
</para>
<para>
Modifies the intensity mapping for one channel in the specified
drawable. The drawable must be either grayscale or RGB, and the
channel can be either an intensity component, or the value. The
'curve' parameter is an array of bytes which explicitly defines how
each pixel value in the drawable will be modified. Use the
'gimp_curves_spline' function to modify intensity levels with
Catmull Rom splines.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>channel</parameter> :</term>
<listitem><simpara> The channel to modify.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_bytes</parameter> :</term>
<listitem><simpara> The number of bytes in the new curve (always 256).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>curve</parameter> :</term>
<listitem><simpara> The explicit curve.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-color-balance" role="function"/>gimp_color_balance ()</title>
<indexterm><primary>gimp_color_balance</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_balance (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpTransferMode">GimpTransferMode</link> transfer_mode,
<link linkend="gboolean">gboolean</link> preserve_lum,
<link linkend="gdouble">gdouble</link> cyan_red,
<link linkend="gdouble">gdouble</link> magenta_green,
<link linkend="gdouble">gdouble</link> yellow_blue);</programlisting>
<para>
Modify the color balance of the specified drawable.
</para>
<para>
Modify the color balance of the specified drawable. There are three
axis which can be modified: cyan-red, magenta-green, and
yellow-blue. Negative values increase the amount of the former,
positive values increase the amount of the latter. Color balance can
be controlled with the 'transfer_mode' setting, which allows
shadows, midtones, and highlights in an image to be affected
differently. The 'preserve_lum' parameter, if non-zero, ensures that
the luminosity of each pixel remains fixed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>transfer_mode</parameter> :</term>
<listitem><simpara> Transfer mode.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>preserve_lum</parameter> :</term>
<listitem><simpara> Preserve luminosity values at each pixel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cyan_red</parameter> :</term>
<listitem><simpara> Cyan-Red color balance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>magenta_green</parameter> :</term>
<listitem><simpara> Magenta-Green color balance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>yellow_blue</parameter> :</term>
<listitem><simpara> Yellow-Blue color balance.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-colorize" role="function" condition="since:GIMP 2.2"/>gimp_colorize ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_colorize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_colorize (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gdouble">gdouble</link> hue,
<link linkend="gdouble">gdouble</link> saturation,
<link linkend="gdouble">gdouble</link> lightness);</programlisting>
<para>
Render the drawable as a grayscale image seen through a colored
glass.
</para>
<para>
Desatures the drawable, then tints it with the specified color. This
tool is only valid on RGB color images. It will not operate on
grayscale or indexed drawables.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hue</parameter> :</term>
<listitem><simpara> Hue in degrees.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>saturation</parameter> :</term>
<listitem><simpara> Saturation in percent.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>lightness</parameter> :</term>
<listitem><simpara> Lightness in percent.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-histogram" role="function"/>gimp_histogram ()</title>
<indexterm><primary>gimp_histogram</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_histogram (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHistogramChannel">GimpHistogramChannel</link> channel,
<link linkend="gint">gint</link> start_range,
<link linkend="gint">gint</link> end_range,
<link linkend="gdouble">gdouble</link> *mean,
<link linkend="gdouble">gdouble</link> *std_dev,
<link linkend="gdouble">gdouble</link> *median,
<link linkend="gdouble">gdouble</link> *pixels,
<link linkend="gdouble">gdouble</link> *count,
<link linkend="gdouble">gdouble</link> *percentile);</programlisting>
<para>
Returns information on the intensity histogram for the specified
drawable.
</para>
<para>
This tool makes it possible to gather information about the
intensity histogram of a drawable. A channel to examine is first
specified. This can be either value, red, green, or blue, depending
on whether the drawable is of type color or grayscale. The drawable
may not be indexed. Second, a range of intensities are specified.
The gimp_histogram function returns statistics based on the pixels
in the drawable that fall under this range of values. Mean, standard
deviation, median, number of pixels, and percentile are all
returned. Additionally, the total count of pixels in the image is
returned. Counts of pixels are weighted by any associated alpha
values and by the current selection mask. That is, pixels that lie
outside an active selection mask will not be counted. Similarly,
pixels with transparent alpha values will not be counted.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>channel</parameter> :</term>
<listitem><simpara> The channel to modify.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_range</parameter> :</term>
<listitem><simpara> Start of the intensity measurement range.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_range</parameter> :</term>
<listitem><simpara> End of the intensity measurement range.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mean</parameter> :</term>
<listitem><simpara> Mean intensity value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>std_dev</parameter> :</term>
<listitem><simpara> Standard deviation of intensity values.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>median</parameter> :</term>
<listitem><simpara> Median intensity value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixels</parameter> :</term>
<listitem><simpara> Alpha-weighted pixel count for entire image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter> :</term>
<listitem><simpara> Alpha-weighted pixel count for range.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>percentile</parameter> :</term>
<listitem><simpara> Percentile that range falls under.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-hue-saturation" role="function"/>gimp_hue_saturation ()</title>
<indexterm><primary>gimp_hue_saturation</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_hue_saturation (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="GimpHueRange">GimpHueRange</link> hue_range,
<link linkend="gdouble">gdouble</link> hue_offset,
<link linkend="gdouble">gdouble</link> lightness,
<link linkend="gdouble">gdouble</link> saturation);</programlisting>
<para>
Modify hue, lightness, and saturation in the specified drawable.
</para>
<para>
This procedures allows the hue, lightness, and saturation in the
specified drawable to be modified. The 'hue_range' parameter
provides the capability to limit range of affected hues.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hue_range</parameter> :</term>
<listitem><simpara> Range of affected hues.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hue_offset</parameter> :</term>
<listitem><simpara> Hue offset in degrees.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>lightness</parameter> :</term>
<listitem><simpara> lightness modification.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>saturation</parameter> :</term>
<listitem><simpara> saturation modification.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-threshold" role="function"/>gimp_threshold ()</title>
<indexterm><primary>gimp_threshold</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_threshold (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> low_threshold,
<link linkend="gint">gint</link> high_threshold);</programlisting>
<para>
Threshold the specified drawable.
</para>
<para>
This procedures generates a threshold map of the specified drawable.
All pixels between the values of 'low_threshold' and
'high_threshold' are replaced with white, and all other pixels with
black.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>low_threshold</parameter> :</term>
<listitem><simpara> The low threshold value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>high_threshold</parameter> :</term>
<listitem><simpara> The high threshold value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
