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
|
<?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-gimpselection">
<refmeta>
<refentrytitle role="top_of_page">gimpselection</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpselection</refname>
<refpurpose>Functions for manipulating selections.</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-selection-bounds">gimp_selection_bounds</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gboolean">gboolean</link> *non_empty,
<link linkend="gint">gint</link> *x1,
<link linkend="gint">gint</link> *y1,
<link linkend="gint">gint</link> *x2,
<link linkend="gint">gint</link> *y2);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-all">gimp_selection_all</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-none">gimp_selection_none</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-clear">gimp_selection_clear</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-is-empty">gimp_selection_is_empty</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gint32">gint32</link> <link linkend="gimp-selection-float">gimp_selection_float</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-load">gimp_selection_load</link> (<link linkend="gint32">gint32</link> channel_ID);
<link linkend="gint32">gint32</link> <link linkend="gimp-selection-save">gimp_selection_save</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gint">gint</link> <link linkend="gimp-selection-value">gimp_selection_value</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-grow">gimp_selection_grow</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> steps);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-shrink">gimp_selection_shrink</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> radius);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-invert">gimp_selection_invert</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-feather">gimp_selection_feather</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gdouble">gdouble</link> radius);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-sharpen">gimp_selection_sharpen</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-border">gimp_selection_border</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> radius);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-translate">gimp_selection_translate</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-layer-alpha">gimp_selection_layer_alpha</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-selection-combine">gimp_selection_combine</link> (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="GimpChannelOps">GimpChannelOps</link> operation);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions for manipulating selections.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-selection-bounds" role="function"/>gimp_selection_bounds ()</title>
<indexterm><primary>gimp_selection_bounds</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_bounds (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gboolean">gboolean</link> *non_empty,
<link linkend="gint">gint</link> *x1,
<link linkend="gint">gint</link> *y1,
<link linkend="gint">gint</link> *x2,
<link linkend="gint">gint</link> *y2);</programlisting>
<para>
Find the bounding box of the current selection.
</para>
<para>
This procedure returns whether there is a selection for the
specified image. If there is one, the upper left and lower right
corners of the bounding box are returned. These coordinates are
relative to the image. Please note that the pixel specified by the
lower righthand coordinate of the bounding box is not part of the
selection. The selection ends at the upper left corner of this
pixel. This means the width of the selection can be calculated as
(x2 - x1), its height as (y2 - y1).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>non_empty</parameter> :</term>
<listitem><simpara> True if there is a selection.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x1</parameter> :</term>
<listitem><simpara> x coordinate of upper left corner of selection bounds.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y1</parameter> :</term>
<listitem><simpara> y coordinate of upper left corner of selection bounds.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x2</parameter> :</term>
<listitem><simpara> x coordinate of lower right corner of selection bounds.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y2</parameter> :</term>
<listitem><simpara> y coordinate of lower right corner of selection bounds.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-all" role="function"/>gimp_selection_all ()</title>
<indexterm><primary>gimp_selection_all</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_all (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Select all of the image.
</para>
<para>
This procedure sets the selection mask to completely encompass the
image. Every pixel in the selection channel is set to 255.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-none" role="function"/>gimp_selection_none ()</title>
<indexterm><primary>gimp_selection_none</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_none (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Deselect the entire image.
</para>
<para>
This procedure deselects the entire image. Every pixel in the
selection channel is set to 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-clear" role="function" condition="deprecated:"/>gimp_selection_clear ()</title>
<indexterm role="deprecated"><primary>gimp_selection_clear</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_clear (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<warning><para><literal>gimp_selection_clear</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-selection-none"><function>gimp_selection_none()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-is-empty" role="function"/>gimp_selection_is_empty ()</title>
<indexterm><primary>gimp_selection_is_empty</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_is_empty (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Determine whether the selection is empty.
</para>
<para>
This procedure returns non-zero if the selection for the specified
image is not empty.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Is the selection empty?
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-float" role="function"/>gimp_selection_float ()</title>
<indexterm><primary>gimp_selection_float</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_selection_float (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);</programlisting>
<para>
Float the selection from the specified drawable with initial offsets
as specified.
</para>
<para>
This procedure determines the region of the specified drawable that
lies beneath the current selection. The region is then cut from the
drawable and the resulting data is made into a new layer which is
instantiated as a floating selection. The offsets allow initial
positioning of the new floating selection.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> ignored
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable from which to float selection.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offx</parameter> :</term>
<listitem><simpara> x offset for translation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offy</parameter> :</term>
<listitem><simpara> y offset for translation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The floated layer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-load" role="function"/>gimp_selection_load ()</title>
<indexterm><primary>gimp_selection_load</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_load (<link linkend="gint32">gint32</link> channel_ID);</programlisting>
<para>
Transfer the specified channel to the selection mask.
</para>
<para>
This procedure loads the specified channel into the selection mask.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-save" role="function"/>gimp_selection_save ()</title>
<indexterm><primary>gimp_selection_save</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_selection_save (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Copy the selection mask to a new channel.
</para>
<para>
This procedure copies the selection mask and stores the content in a
new channel. The new channel is automatically inserted into the
image's list of channels.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new channel.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-value" role="function"/>gimp_selection_value ()</title>
<indexterm><primary>gimp_selection_value</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_selection_value (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y);</programlisting>
<para>
Find the value of the selection at the specified coordinates.
</para>
<para>
This procedure returns the value of the selection at the specified
coordinates. If the coordinates lie out of bounds, 0 is returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> x coordinate of value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> y coordinate of value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Value of the selection.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-grow" role="function"/>gimp_selection_grow ()</title>
<indexterm><primary>gimp_selection_grow</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_grow (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> steps);</programlisting>
<para>
Grow the image's selection
</para>
<para>
This procedure grows the selection. Growing involves expanding the
boundary in all directions by the specified pixel amount.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>steps</parameter> :</term>
<listitem><simpara> Steps of grow (in pixels).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-shrink" role="function"/>gimp_selection_shrink ()</title>
<indexterm><primary>gimp_selection_shrink</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_shrink (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> radius);</programlisting>
<para>
Shrink the image's selection
</para>
<para>
This procedure shrinks the selection. Shrinking invovles trimming
the existing selection boundary on all sides by the specified number
of pixels.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>radius</parameter> :</term>
<listitem><simpara> Radius of shrink (in pixels).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-invert" role="function"/>gimp_selection_invert ()</title>
<indexterm><primary>gimp_selection_invert</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_invert (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Invert the selection mask.
</para>
<para>
This procedure inverts the selection mask. For every pixel in the
selection channel, its new value is calculated as (255 - old_value).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-feather" role="function"/>gimp_selection_feather ()</title>
<indexterm><primary>gimp_selection_feather</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_feather (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gdouble">gdouble</link> radius);</programlisting>
<para>
Feather the image's selection
</para>
<para>
This procedure feathers the selection. Feathering is implemented
using a gaussian blur.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>radius</parameter> :</term>
<listitem><simpara> Radius of feather (in pixels).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-sharpen" role="function"/>gimp_selection_sharpen ()</title>
<indexterm><primary>gimp_selection_sharpen</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_sharpen (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Sharpen the selection mask.
</para>
<para>
This procedure sharpens the selection mask. For every pixel in the
selection channel, if the value is > 0, the new pixel is assigned
a value of 255. This removes any \"anti-aliasing\" that might exist
in the selection mask's boundary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-border" role="function"/>gimp_selection_border ()</title>
<indexterm><primary>gimp_selection_border</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_border (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> radius);</programlisting>
<para>
Border the image's selection
</para>
<para>
This procedure borders the selection. Bordering creates a new
selection which is defined along the boundary of the previous
selection at every point within the specified radius.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>radius</parameter> :</term>
<listitem><simpara> Radius of border (in pixels).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-translate" role="function"/>gimp_selection_translate ()</title>
<indexterm><primary>gimp_selection_translate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_translate (<link linkend="gint32">gint32</link> image_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);</programlisting>
<para>
Translate the selection by the specified offsets.
</para>
<para>
This procedure actually translates the selection for the specified
image by the specified offsets. Regions that are translated from
beyond the bounds of the image are set to empty. Valid regions of
the selection which are translated beyond the bounds of the image
because of this call are lost.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offx</parameter> :</term>
<listitem><simpara> x offset for translation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offy</parameter> :</term>
<listitem><simpara> y offset for translation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-layer-alpha" role="function"/>gimp_selection_layer_alpha ()</title>
<indexterm><primary>gimp_selection_layer_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_layer_alpha (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Transfer the specified layer's alpha channel to the selection mask.
</para>
<para>
This procedure requires a layer with an alpha channel. The alpha
channel information is used to create a selection mask such that for
any pixel in the image defined in the specified layer, that layer
pixel's alpha value is transferred to the selection mask. If the
layer is undefined at a particular image pixel, the associated
selection mask value is set to 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> Layer with alpha.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-selection-combine" role="function"/>gimp_selection_combine ()</title>
<indexterm><primary>gimp_selection_combine</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_selection_combine (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="GimpChannelOps">GimpChannelOps</link> operation);</programlisting>
<para>
Combines the specified channel with the selection mask.
</para>
<para>
This procedure combines the specified channel into the selection
mask.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>operation</parameter> :</term>
<listitem><simpara> The selection operation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
