← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpchannel.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpchannel.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>gimpchannel</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
 
7
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
8
<link rel="prev" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
9
<link rel="next" href="libgimp-gimpcolor.html" title="gimpcolor">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
 
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
</head>
 
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
22
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
23
<td><a accesskey="p" href="libgimp-image.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
26
<th width="100%" align="center">GIMP Library Reference Manual</th>
 
27
<td><a accesskey="n" href="libgimp-gimpcolor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
28
</tr></table>
 
29
<div class="refentry" lang="en">
 
30
<a name="libgimp-gimpchannel"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle">gimpchannel</span></h2>
 
34
<p>gimpchannel &#8212; Functions for manipulating channels.</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
 
 
42
 
 
43
 
 
44
gint32      <a href="libgimp-gimpchannel.html#gimp-channel-new">gimp_channel_new</a>                (gint32 image_ID,
 
45
                                             const gchar *name,
 
46
                                             guint width,
 
47
                                             guint height,
 
48
                                             gdouble opacity,
 
49
                                             const <a
 
50
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
51
>GimpRGB</a> *color);
 
52
gint32      <a href="libgimp-gimpchannel.html#gimp-channel-copy">gimp_channel_copy</a>               (gint32 channel_ID);
 
53
gboolean    <a href="libgimp-gimpchannel.html#gimp-channel-get-show-masked">gimp_channel_get_show_masked</a>    (gint32 channel_ID);
 
54
gboolean    <a href="libgimp-gimpchannel.html#gimp-channel-set-show-masked">gimp_channel_set_show_masked</a>    (gint32 channel_ID,
 
55
                                             gboolean show_masked);
 
56
gdouble     <a href="libgimp-gimpchannel.html#gimp-channel-get-opacity">gimp_channel_get_opacity</a>        (gint32 channel_ID);
 
57
gboolean    <a href="libgimp-gimpchannel.html#gimp-channel-set-opacity">gimp_channel_set_opacity</a>        (gint32 channel_ID,
 
58
                                             gdouble opacity);
 
59
gboolean    <a href="libgimp-gimpchannel.html#gimp-channel-get-color">gimp_channel_get_color</a>          (gint32 channel_ID,
 
60
                                             <a
 
61
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
62
>GimpRGB</a> *color);
 
63
gboolean    <a href="libgimp-gimpchannel.html#gimp-channel-set-color">gimp_channel_set_color</a>          (gint32 channel_ID,
 
64
                                             const <a
 
65
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
66
>GimpRGB</a> *color);
 
67
gboolean    <a href="libgimp-gimpchannel.html#gimp-channel-combine-masks">gimp_channel_combine_masks</a>      (gint32 channel1_ID,
 
68
                                             gint32 channel2_ID,
 
69
                                             <a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation,
 
70
                                             gint offx,
 
71
                                             gint offy);
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1" lang="en">
 
75
<a name="id2567303"></a><h2>Description</h2>
 
76
<p>
 
77
Functions for manipulating channels.
 
78
</p>
 
79
</div>
 
80
<div class="refsect1" lang="en">
 
81
<a name="id2567314"></a><h2>Details</h2>
 
82
<div class="refsect2" lang="en">
 
83
<a name="id2567320"></a><h3>
 
84
<a name="gimp-channel-new"></a>gimp_channel_new ()</h3>
 
85
<a class="indexterm" name="id2567331"></a><pre class="programlisting">gint32      gimp_channel_new                (gint32 image_ID,
 
86
                                             const gchar *name,
 
87
                                             guint width,
 
88
                                             guint height,
 
89
                                             gdouble opacity,
 
90
                                             const <a
 
91
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
92
>GimpRGB</a> *color);</pre>
 
93
<p>
 
94
Create a new channel.
 
95
</p>
 
96
<p>
 
97
This procedure creates a new channel with the specified width and
 
98
height. Name, opacity, and color are also supplied parameters. The
 
99
new channel still needs to be added to the image, as this is not
 
100
automatic. Add the new channel with the 'gimp_image_add_channel'
 
101
command. Other attributes such as channel show masked, should be set
 
102
with explicit procedure calls. The channel's contents are undefined
 
103
initially.</p>
 
104
<p>
 
105
 
 
106
</p>
 
107
<div class="variablelist"><table border="0">
 
108
<col align="left" valign="top">
 
109
<tbody>
 
110
<tr>
 
111
<td>
 
112
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
113
<td> The image to which to add the channel.
 
114
</td>
 
115
</tr>
 
116
<tr>
 
117
<td>
 
118
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
119
<td> The channel name.
 
120
</td>
 
121
</tr>
 
122
<tr>
 
123
<td>
 
124
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
125
<td> The channel width.
 
126
</td>
 
127
</tr>
 
128
<tr>
 
129
<td>
 
130
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
131
<td> The channel height.
 
132
</td>
 
133
</tr>
 
134
<tr>
 
135
<td>
 
136
<span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
 
137
<td> The channel opacity.
 
138
</td>
 
139
</tr>
 
140
<tr>
 
141
<td>
 
142
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
 
143
<td> The channel compositing color.
 
144
</td>
 
145
</tr>
 
146
<tr>
 
147
<td>
 
148
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
149
<td> The newly created channel.
 
150
</td>
 
151
</tr>
 
152
</tbody>
 
153
</table></div>
 
154
</div>
 
155
<hr>
 
156
<div class="refsect2" lang="en">
 
157
<a name="id2537965"></a><h3>
 
158
<a name="gimp-channel-copy"></a>gimp_channel_copy ()</h3>
 
159
<a class="indexterm" name="id2537975"></a><pre class="programlisting">gint32      gimp_channel_copy               (gint32 channel_ID);</pre>
 
160
<p>
 
161
Copy a channel.
 
162
</p>
 
163
<p>
 
164
This procedure copies the specified channel and returns the copy.</p>
 
165
<p>
 
166
 
 
167
</p>
 
168
<div class="variablelist"><table border="0">
 
169
<col align="left" valign="top">
 
170
<tbody>
 
171
<tr>
 
172
<td>
 
173
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
174
<td> The channel to copy.
 
175
</td>
 
176
</tr>
 
177
<tr>
 
178
<td>
 
179
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
180
<td> The newly copied channel.
 
181
</td>
 
182
</tr>
 
183
</tbody>
 
184
</table></div>
 
185
</div>
 
186
<hr>
 
187
<div class="refsect2" lang="en">
 
188
<a name="id2538038"></a><h3>
 
189
<a name="gimp-channel-get-show-masked"></a>gimp_channel_get_show_masked ()</h3>
 
190
<a class="indexterm" name="id2538047"></a><pre class="programlisting">gboolean    gimp_channel_get_show_masked    (gint32 channel_ID);</pre>
 
191
<p>
 
192
Get the composite method of the specified channel.
 
193
</p>
 
194
<p>
 
195
This procedure returns the specified channel's composite method. If
 
196
it is non-zero, then the channel is composited with the image so
 
197
that masked regions are shown. Otherwise, selected regions are
 
198
shown.</p>
 
199
<p>
 
200
 
 
201
</p>
 
202
<div class="variablelist"><table border="0">
 
203
<col align="left" valign="top">
 
204
<tbody>
 
205
<tr>
 
206
<td>
 
207
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
208
<td> The channel.
 
209
</td>
 
210
</tr>
 
211
<tr>
 
212
<td>
 
213
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
214
<td> The channel composite method.
 
215
</td>
 
216
</tr>
 
217
</tbody>
 
218
</table></div>
 
219
</div>
 
220
<hr>
 
221
<div class="refsect2" lang="en">
 
222
<a name="id2567905"></a><h3>
 
223
<a name="gimp-channel-set-show-masked"></a>gimp_channel_set_show_masked ()</h3>
 
224
<a class="indexterm" name="id2567916"></a><pre class="programlisting">gboolean    gimp_channel_set_show_masked    (gint32 channel_ID,
 
225
                                             gboolean show_masked);</pre>
 
226
<p>
 
227
Set the composite method of the specified channel.
 
228
</p>
 
229
<p>
 
230
This procedure sets the specified channel's composite method. If it
 
231
is non-zero, then the channel is composited with the image so that
 
232
masked regions are shown. Otherwise, selected regions are shown.</p>
 
233
<p>
 
234
 
 
235
</p>
 
236
<div class="variablelist"><table border="0">
 
237
<col align="left" valign="top">
 
238
<tbody>
 
239
<tr>
 
240
<td>
 
241
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
242
<td> The channel.
 
243
</td>
 
244
</tr>
 
245
<tr>
 
246
<td>
 
247
<span class="term"><em class="parameter"><code>show_masked</code></em>&#160;:</span></td>
 
248
<td> The new channel composite method.
 
249
</td>
 
250
</tr>
 
251
<tr>
 
252
<td>
 
253
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
254
<td> TRUE on success.
 
255
</td>
 
256
</tr>
 
257
</tbody>
 
258
</table></div>
 
259
</div>
 
260
<hr>
 
261
<div class="refsect2" lang="en">
 
262
<a name="id2568006"></a><h3>
 
263
<a name="gimp-channel-get-opacity"></a>gimp_channel_get_opacity ()</h3>
 
264
<a class="indexterm" name="id2568015"></a><pre class="programlisting">gdouble     gimp_channel_get_opacity        (gint32 channel_ID);</pre>
 
265
<p>
 
266
Get the opacity of the specified channel.
 
267
</p>
 
268
<p>
 
269
This procedure returns the specified channel's opacity.</p>
 
270
<p>
 
271
 
 
272
</p>
 
273
<div class="variablelist"><table border="0">
 
274
<col align="left" valign="top">
 
275
<tbody>
 
276
<tr>
 
277
<td>
 
278
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
279
<td> The channel.
 
280
</td>
 
281
</tr>
 
282
<tr>
 
283
<td>
 
284
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
285
<td> The channel opacity.
 
286
</td>
 
287
</tr>
 
288
</tbody>
 
289
</table></div>
 
290
</div>
 
291
<hr>
 
292
<div class="refsect2" lang="en">
 
293
<a name="id2568080"></a><h3>
 
294
<a name="gimp-channel-set-opacity"></a>gimp_channel_set_opacity ()</h3>
 
295
<a class="indexterm" name="id2568089"></a><pre class="programlisting">gboolean    gimp_channel_set_opacity        (gint32 channel_ID,
 
296
                                             gdouble opacity);</pre>
 
297
<p>
 
298
Set the opacity of the specified channel.
 
299
</p>
 
300
<p>
 
301
This procedure sets the specified channel's opacity.</p>
 
302
<p>
 
303
 
 
304
</p>
 
305
<div class="variablelist"><table border="0">
 
306
<col align="left" valign="top">
 
307
<tbody>
 
308
<tr>
 
309
<td>
 
310
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
311
<td> The channel.
 
312
</td>
 
313
</tr>
 
314
<tr>
 
315
<td>
 
316
<span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
 
317
<td> The new channel opacity.
 
318
</td>
 
319
</tr>
 
320
<tr>
 
321
<td>
 
322
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
323
<td> TRUE on success.
 
324
</td>
 
325
</tr>
 
326
</tbody>
 
327
</table></div>
 
328
</div>
 
329
<hr>
 
330
<div class="refsect2" lang="en">
 
331
<a name="id2570632"></a><h3>
 
332
<a name="gimp-channel-get-color"></a>gimp_channel_get_color ()</h3>
 
333
<a class="indexterm" name="id2570640"></a><pre class="programlisting">gboolean    gimp_channel_get_color          (gint32 channel_ID,
 
334
                                             <a
 
335
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
336
>GimpRGB</a> *color);</pre>
 
337
<p>
 
338
Get the compositing color of the specified channel.
 
339
</p>
 
340
<p>
 
341
This procedure returns the specified channel's compositing color.</p>
 
342
<p>
 
343
 
 
344
</p>
 
345
<div class="variablelist"><table border="0">
 
346
<col align="left" valign="top">
 
347
<tbody>
 
348
<tr>
 
349
<td>
 
350
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
351
<td> The channel.
 
352
</td>
 
353
</tr>
 
354
<tr>
 
355
<td>
 
356
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
 
357
<td> The channel compositing color.
 
358
</td>
 
359
</tr>
 
360
<tr>
 
361
<td>
 
362
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
363
<td> TRUE on success.
 
364
</td>
 
365
</tr>
 
366
</tbody>
 
367
</table></div>
 
368
</div>
 
369
<hr>
 
370
<div class="refsect2" lang="en">
 
371
<a name="id2538103"></a><h3>
 
372
<a name="gimp-channel-set-color"></a>gimp_channel_set_color ()</h3>
 
373
<a class="indexterm" name="id2543018"></a><pre class="programlisting">gboolean    gimp_channel_set_color          (gint32 channel_ID,
 
374
                                             const <a
 
375
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
376
>GimpRGB</a> *color);</pre>
 
377
<p>
 
378
Set the compositing color of the specified channel.
 
379
</p>
 
380
<p>
 
381
This procedure sets the specified channel's compositing color.</p>
 
382
<p>
 
383
 
 
384
</p>
 
385
<div class="variablelist"><table border="0">
 
386
<col align="left" valign="top">
 
387
<tbody>
 
388
<tr>
 
389
<td>
 
390
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
391
<td> The channel.
 
392
</td>
 
393
</tr>
 
394
<tr>
 
395
<td>
 
396
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
 
397
<td> The new channel compositing color.
 
398
</td>
 
399
</tr>
 
400
<tr>
 
401
<td>
 
402
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
403
<td> TRUE on success.
 
404
</td>
 
405
</tr>
 
406
</tbody>
 
407
</table></div>
 
408
</div>
 
409
<hr>
 
410
<div class="refsect2" lang="en">
 
411
<a name="id2570782"></a><h3>
 
412
<a name="gimp-channel-combine-masks"></a>gimp_channel_combine_masks ()</h3>
 
413
<a class="indexterm" name="id2570791"></a><pre class="programlisting">gboolean    gimp_channel_combine_masks      (gint32 channel1_ID,
 
414
                                             gint32 channel2_ID,
 
415
                                             <a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation,
 
416
                                             gint offx,
 
417
                                             gint offy);</pre>
 
418
<p>
 
419
Combine two channel masks.
 
420
</p>
 
421
<p>
 
422
This procedure combines two channel masks. The result is stored in
 
423
the first channel.</p>
 
424
<p>
 
425
 
 
426
</p>
 
427
<div class="variablelist"><table border="0">
 
428
<col align="left" valign="top">
 
429
<tbody>
 
430
<tr>
 
431
<td>
 
432
<span class="term"><em class="parameter"><code>channel1_ID</code></em>&#160;:</span></td>
 
433
<td> The channel1.
 
434
</td>
 
435
</tr>
 
436
<tr>
 
437
<td>
 
438
<span class="term"><em class="parameter"><code>channel2_ID</code></em>&#160;:</span></td>
 
439
<td> The channel2.
 
440
</td>
 
441
</tr>
 
442
<tr>
 
443
<td>
 
444
<span class="term"><em class="parameter"><code>operation</code></em>&#160;:</span></td>
 
445
<td> The selection operation.
 
446
</td>
 
447
</tr>
 
448
<tr>
 
449
<td>
 
450
<span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
 
451
<td> x offset between upper left corner of channels: (second - first).
 
452
</td>
 
453
</tr>
 
454
<tr>
 
455
<td>
 
456
<span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
 
457
<td> y offset between upper left corner of channels: (second - first).
 
458
</td>
 
459
</tr>
 
460
<tr>
 
461
<td>
 
462
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
463
<td> TRUE on success.
 
464
</td>
 
465
</tr>
 
466
</tbody>
 
467
</table></div>
 
468
</div>
 
469
</div>
 
470
</div>
 
471
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
472
<td align="left"><a accesskey="p" href="libgimp-image.html"><b>&lt;&lt;&#160;Manupulating Images and all their Properties</b></a></td>
 
473
<td align="right"><a accesskey="n" href="libgimp-gimpcolor.html"><b>gimpcolor&#160;&gt;&gt;</b></a></td>
 
474
</tr></table>
 
475
</body>
 
476
</html>