4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpchannel</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
9
<link rel="prev" href="libgimp-image.html" title="Manupulating Images and all their Properties">
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
9
<link rel="prev" href="libgimp-image.html" title="Manupulating Images and their Properties">
10
10
<link rel="next" href="libgimp-gimpcolor.html" title="gimpcolor">
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
14
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
13
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
18
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
20
<link rel="index" href="libgimp-index.html" title="Index">
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimpcolor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2562582" class="shortcut">Top</a>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2560828" class="shortcut">Top</a>
33
<a href="#id2545541" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2570510" class="shortcut">Description</a></nobr></td></tr>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpchannel"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
40
<a name="id2562582"></a><span class="refentrytitle">gimpchannel</span>
43
<a name="id2560828"></a><span class="refentrytitle">gimpchannel</span>
42
45
<p>gimpchannel — Functions for manipulating channels.</p>
52
gint32 <a href="libgimp-gimpchannel.html#gimp-channel-new">gimp_channel_new</a> (gint32 image_ID,
58
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
60
gint32 <a href="libgimp-gimpchannel.html#gimp-channel-copy">gimp_channel_copy</a> (gint32 channel_ID);
61
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-get-show-masked">gimp_channel_get_show_masked</a> (gint32 channel_ID);
62
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-show-masked">gimp_channel_set_show_masked</a> (gint32 channel_ID,
63
gboolean show_masked);
64
gdouble <a href="libgimp-gimpchannel.html#gimp-channel-get-opacity">gimp_channel_get_opacity</a> (gint32 channel_ID);
65
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-opacity">gimp_channel_set_opacity</a> (gint32 channel_ID,
67
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-get-color">gimp_channel_get_color</a> (gint32 channel_ID,
69
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
71
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-color">gimp_channel_set_color</a> (gint32 channel_ID,
73
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
75
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-combine-masks">gimp_channel_combine_masks</a> (gint32 channel1_ID,
77
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation,
55
gint32 <a href="libgimp-gimpchannel.html#gimp-channel-new">gimp_channel_new</a> (gint32 image_ID,
61
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
63
gint32 <a href="libgimp-gimpchannel.html#gimp-channel-new-from-component">gimp_channel_new_from_component</a> (gint32 image_ID,
65
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
66
>GimpChannelType</a> component,
68
gint32 <a href="libgimp-gimpchannel.html#gimp-channel-copy">gimp_channel_copy</a> (gint32 channel_ID);
69
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-get-show-masked">gimp_channel_get_show_masked</a> (gint32 channel_ID);
70
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-show-masked">gimp_channel_set_show_masked</a> (gint32 channel_ID,
71
gboolean show_masked);
72
gdouble <a href="libgimp-gimpchannel.html#gimp-channel-get-opacity">gimp_channel_get_opacity</a> (gint32 channel_ID);
73
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-opacity">gimp_channel_set_opacity</a> (gint32 channel_ID,
75
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-get-color">gimp_channel_get_color</a> (gint32 channel_ID,
77
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
79
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-color">gimp_channel_set_color</a> (gint32 channel_ID,
81
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
83
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-combine-masks">gimp_channel_combine_masks</a> (gint32 channel1_ID,
86
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
87
>GimpChannelOps</a> operation,
82
92
<div class="refsect1" lang="en">
83
<a name="id2545541"></a><h2>Description</h2>
93
<a name="id2570510"></a><h2>Description</h2>
85
95
Functions for manipulating channels.
88
98
<div class="refsect1" lang="en">
89
<a name="id2545556"></a><h2>Details</h2>
99
<a name="id2570526"></a><h2>Details</h2>
90
100
<div class="refsect2" lang="en">
91
<a name="id2545567"></a><h3>
101
<a name="id2570536"></a><h3>
92
102
<a name="gimp-channel-new"></a>gimp_channel_new ()</h3>
93
<a class="indexterm" name="id2545579"></a><pre class="programlisting">gint32 gimp_channel_new (gint32 image_ID,
103
<a class="indexterm" name="id2570549"></a><pre class="programlisting">gint32 gimp_channel_new (gint32 image_ID,
99
109
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
100
110
>GimpRGB</a> *color);</pre>
116
126
<col align="left" valign="top">
120
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
129
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
121
130
<td> The image to which to add the channel.
126
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
134
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
127
135
<td> The channel name.
132
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
139
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
133
140
<td> The channel width.
138
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
144
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
139
145
<td> The channel height.
144
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
149
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
145
150
<td> The channel opacity.
150
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
154
<td><span class="term"><em class="parameter"><code>color</code></em> :</span></td>
151
155
<td> The channel compositing color.
156
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
157
<td> The newly created channel.
164
<div class="refsect2" lang="en">
165
<a name="id2575443"></a><h3>
159
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
160
<td> The newly created channel.
167
<div class="refsect2" lang="en">
168
<a name="id2609667"></a><h3>
169
<a name="gimp-channel-new-from-component"></a>gimp_channel_new_from_component ()</h3>
170
<a class="indexterm" name="id2609681"></a><pre class="programlisting">gint32 gimp_channel_new_from_component (gint32 image_ID,
172
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
173
>GimpChannelType</a> component,
174
const gchar *name);</pre>
176
Create a new channel from a color component
179
This procedure creates a new channel from a color component.</p>
183
<div class="variablelist"><table border="0">
184
<col align="left" valign="top">
187
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
188
<td> The image to which to add the channel.
192
<td><span class="term"><em class="parameter"><code>component</code></em> :</span></td>
193
<td> The image component.
197
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
198
<td> The channel name.
202
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
203
<td> The newly created channel.
209
<p class="since">Since GIMP 2.4
213
<div class="refsect2" lang="en">
214
<a name="id2608287"></a><h3>
166
215
<a name="gimp-channel-copy"></a>gimp_channel_copy ()</h3>
167
<a class="indexterm" name="id2575455"></a><pre class="programlisting">gint32 gimp_channel_copy (gint32 channel_ID);</pre>
216
<a class="indexterm" name="id2608300"></a><pre class="programlisting">gint32 gimp_channel_copy (gint32 channel_ID);</pre>
195
242
<div class="refsect2" lang="en">
196
<a name="id2575519"></a><h3>
243
<a name="id2608364"></a><h3>
197
244
<a name="gimp-channel-get-show-masked"></a>gimp_channel_get_show_masked ()</h3>
198
<a class="indexterm" name="id2575530"></a><pre class="programlisting">gboolean gimp_channel_get_show_masked (gint32 channel_ID);</pre>
245
<a class="indexterm" name="id2608377"></a><pre class="programlisting">gboolean gimp_channel_get_show_masked (gint32 channel_ID);</pre>
200
247
Get the composite method of the specified channel.
203
250
This procedure returns the specified channel's composite method. If
204
it is non-zero, then the channel is composited with the image so
205
that masked regions are shown. Otherwise, selected regions are
251
it is TRUE, then the channel is composited with the image so that
252
masked regions are shown. Otherwise, selected regions are shown.</p>
229
273
<div class="refsect2" lang="en">
230
<a name="id2567759"></a><h3>
274
<a name="id2608446"></a><h3>
231
275
<a name="gimp-channel-set-show-masked"></a>gimp_channel_set_show_masked ()</h3>
232
<a class="indexterm" name="id2567770"></a><pre class="programlisting">gboolean gimp_channel_set_show_masked (gint32 channel_ID,
233
gboolean show_masked);</pre>
276
<a class="indexterm" name="id2608459"></a><pre class="programlisting">gboolean gimp_channel_set_show_masked (gint32 channel_ID,
277
gboolean show_masked);</pre>
235
279
Set the composite method of the specified channel.
238
282
This procedure sets the specified channel's composite method. If it
239
is non-zero, then the channel is composited with the image so that
283
is TRUE, then the channel is composited with the image so that
240
284
masked regions are shown. Otherwise, selected regions are shown.</p>
245
289
<col align="left" valign="top">
249
<span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
292
<td><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
250
293
<td> The channel.
255
<span class="term"><em class="parameter"><code>show_masked</code></em> :</span></td>
297
<td><span class="term"><em class="parameter"><code>show_masked</code></em> :</span></td>
256
298
<td> The new channel composite method.
261
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
302
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
262
303
<td> TRUE on success.
314
353
<col align="left" valign="top">
318
<span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
356
<td><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
319
357
<td> The channel.
324
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
361
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
325
362
<td> The new channel opacity.
330
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
366
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
331
367
<td> TRUE on success.
338
374
<div class="refsect2" lang="en">
339
<a name="id2579003"></a><h3>
375
<a name="id2570298"></a><h3>
340
376
<a name="gimp-channel-get-color"></a>gimp_channel_get_color ()</h3>
341
<a class="indexterm" name="id2579013"></a><pre class="programlisting">gboolean gimp_channel_get_color (gint32 channel_ID,
377
<a class="indexterm" name="id2570309"></a><pre class="programlisting">gboolean gimp_channel_get_color (gint32 channel_ID,
343
379
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
344
380
>GimpRGB</a> *color);</pre>
354
390
<col align="left" valign="top">
358
<span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
393
<td><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
359
394
<td> The channel.
364
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
398
<td><span class="term"><em class="parameter"><code>color</code></em> :</span></td>
365
399
<td> The channel compositing color.
370
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
403
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
371
404
<td> TRUE on success.
378
411
<div class="refsect2" lang="en">
379
<a name="id2579091"></a><h3>
412
<a name="id2614590"></a><h3>
380
413
<a name="gimp-channel-set-color"></a>gimp_channel_set_color ()</h3>
381
<a class="indexterm" name="id2579101"></a><pre class="programlisting">gboolean gimp_channel_set_color (gint32 channel_ID,
414
<a class="indexterm" name="id2614600"></a><pre class="programlisting">gboolean gimp_channel_set_color (gint32 channel_ID,
383
416
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
384
417
>GimpRGB</a> *color);</pre>
394
427
<col align="left" valign="top">
398
<span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
430
<td><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></td>
399
431
<td> The channel.
404
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
435
<td><span class="term"><em class="parameter"><code>color</code></em> :</span></td>
405
436
<td> The new channel compositing color.
410
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
440
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
411
441
<td> TRUE on success.
418
448
<div class="refsect2" lang="en">
419
<a name="id2579187"></a><h3>
449
<a name="id2614679"></a><h3>
420
450
<a name="gimp-channel-combine-masks"></a>gimp_channel_combine_masks ()</h3>
421
<a class="indexterm" name="id2579199"></a><pre class="programlisting">gboolean gimp_channel_combine_masks (gint32 channel1_ID,
423
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation,
451
<a class="indexterm" name="id2614689"></a><pre class="programlisting">gboolean gimp_channel_combine_masks (gint32 channel1_ID,
454
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
455
>GimpChannelOps</a> operation,
427
459
Combine two channel masks.
436
468
<col align="left" valign="top">
440
<span class="term"><em class="parameter"><code>channel1_ID</code></em> :</span></td>
471
<td><span class="term"><em class="parameter"><code>channel1_ID</code></em> :</span></td>
441
472
<td> The channel1.
446
<span class="term"><em class="parameter"><code>channel2_ID</code></em> :</span></td>
476
<td><span class="term"><em class="parameter"><code>channel2_ID</code></em> :</span></td>
447
477
<td> The channel2.
452
<span class="term"><em class="parameter"><code>operation</code></em> :</span></td>
481
<td><span class="term"><em class="parameter"><code>operation</code></em> :</span></td>
453
482
<td> The selection operation.
458
<span class="term"><em class="parameter"><code>offx</code></em> :</span></td>
486
<td><span class="term"><em class="parameter"><code>offx</code></em> :</span></td>
459
487
<td> x offset between upper left corner of channels: (second - first).
464
<span class="term"><em class="parameter"><code>offy</code></em> :</span></td>
491
<td><span class="term"><em class="parameter"><code>offy</code></em> :</span></td>
465
492
<td> y offset between upper left corner of channels: (second - first).
470
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
496
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
471
497
<td> TRUE on success.