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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
|
<?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-gimplayer">
<refmeta>
<refentrytitle role="top_of_page">gimplayer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimplayer</refname>
<refpurpose>Operations on a single layer.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-new">gimp_layer_new</link> (<link linkend="gint32">gint32</link> image_ID,
const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
<link linkend="GimpImageType">GimpImageType</link> type,
<link linkend="gdouble">gdouble</link> opacity,
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-copy">gimp_layer_copy</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-scale">gimp_layer_scale</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> new_width,
<link linkend="gint">gint</link> new_height,
<link linkend="gboolean">gboolean</link> local_origin);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-resize">gimp_layer_resize</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> new_width,
<link linkend="gint">gint</link> new_height,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-resize-to-image-size">gimp_layer_resize_to_image_size</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-translate">gimp_layer_translate</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-add-alpha">gimp_layer_add_alpha</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-offsets">gimp_layer_set_offsets</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-create-mask">gimp_layer_create_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="GimpAddMaskType">GimpAddMaskType</link> mask_type);
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-from-mask">gimp_layer_from_mask</link> (<link linkend="gint32">gint32</link> mask_ID);
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-get-mask">gimp_layer_get_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-add-mask">gimp_layer_add_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint32">gint32</link> mask_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-remove-mask">gimp_layer_remove_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="GimpMaskApplyMode">GimpMaskApplyMode</link> mode);
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-new-from-drawable">gimp_layer_new_from_drawable</link> (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint32">gint32</link> dest_image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-preserve-trans">gimp_layer_get_preserve_trans</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-preserve-trans">gimp_layer_set_preserve_trans</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> preserve_trans);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-apply-mask">gimp_layer_get_apply_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-apply-mask">gimp_layer_set_apply_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> apply_mask);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-show-mask">gimp_layer_get_show_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-show-mask">gimp_layer_set_show_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> show_mask);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-edit-mask">gimp_layer_get_edit_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-edit-mask">gimp_layer_set_edit_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> edit_mask);
<link linkend="gdouble">gdouble</link> <link linkend="gimp-layer-get-opacity">gimp_layer_get_opacity</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-opacity">gimp_layer_set_opacity</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gdouble">gdouble</link> opacity);
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> <link linkend="gimp-layer-get-mode">gimp_layer_get_mode</link> (<link linkend="gint32">gint32</link> layer_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-mode">gimp_layer_set_mode</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-is-floating-sel">gimp_layer_is_floating_sel</link> (<link linkend="gint32">gint32</link> layer_ID);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Operations on a single layer.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-layer-new" role="function"/>gimp_layer_new ()</title>
<indexterm><primary>gimp_layer_new</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_new (<link linkend="gint32">gint32</link> image_ID,
const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
<link linkend="GimpImageType">GimpImageType</link> type,
<link linkend="gdouble">gdouble</link> opacity,
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);</programlisting>
<para>
Create a new layer.
</para>
<para>
This procedure creates a new layer with the specified width, height,
and type. Name, opacity, and mode are also supplied parameters. The
new layer still needs to be added to the image, as this is not
automatic. Add the new layer with the 'gimp_image_add_layer'
command. Other attributes such as layer mask modes, and offsets
should be set with explicit procedure calls.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image to which to add the layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The layer name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The layer width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> The layer height.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> The layer type.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opacity</parameter> :</term>
<listitem><simpara> The layer opacity.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> The layer combination mode.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created layer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-copy" role="function"/>gimp_layer_copy ()</title>
<indexterm><primary>gimp_layer_copy</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_copy (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Copy a layer.
</para>
<para>
This procedure copies the specified layer and returns the copy. The
newly copied layer is for use within the original layer's image. It
should not be subsequently added to any other image. If you create
a copy of the background layer, remember to add an alpha channel
before you add the new layer to the image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer to copy.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly copied layer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-scale" role="function"/>gimp_layer_scale ()</title>
<indexterm><primary>gimp_layer_scale</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_scale (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> new_width,
<link linkend="gint">gint</link> new_height,
<link linkend="gboolean">gboolean</link> local_origin);</programlisting>
<para>
Scale the layer to the specified extents.
</para>
<para>
This procedure scales the layer so that it's new width and height
are equal to the supplied parameters. The \"local_origin\" parameter
specifies whether to scale from the center of the layer, or from the
image origin. This operation only works if the layer has been added
to an image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_width</parameter> :</term>
<listitem><simpara> New layer width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_height</parameter> :</term>
<listitem><simpara> New layer height.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>local_origin</parameter> :</term>
<listitem><simpara> Use a local origin (as opposed to the image origin).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-resize" role="function"/>gimp_layer_resize ()</title>
<indexterm><primary>gimp_layer_resize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_resize (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> new_width,
<link linkend="gint">gint</link> new_height,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);</programlisting>
<para>
Resize the layer to the specified extents.
</para>
<para>
This procedure resizes the layer so that it's new width and height
are equal to the supplied parameters. Offsets are also provided
which describe the position of the previous layer's content. This
operation only works if the layer has been added to an image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_width</parameter> :</term>
<listitem><simpara> New layer width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_height</parameter> :</term>
<listitem><simpara> New layer height.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offx</parameter> :</term>
<listitem><simpara> x offset between upper left corner of old and new layers: (old - new).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offy</parameter> :</term>
<listitem><simpara> y offset between upper left corner of old and new layers: (old - new).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-resize-to-image-size" role="function"/>gimp_layer_resize_to_image_size ()</title>
<indexterm><primary>gimp_layer_resize_to_image_size</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_resize_to_image_size (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Resize a layer to the image size.
</para>
<para>
This procedure resizes the layer so that it's new width and height
are equal to the width and height of its image container.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer to resize.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-translate" role="function"/>gimp_layer_translate ()</title>
<indexterm><primary>gimp_layer_translate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_translate (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);</programlisting>
<para>
Translate the layer by the specified offsets.
</para>
<para>
This procedure translates the layer by the amounts specified in the
x and y arguments. These can be negative, and are considered offsets
from the current position. This command only works if the layer has
been added to an image. All additional layers contained in the image
which have the linked flag set to TRUE w ill also be translated by
the specified offsets.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offx</parameter> :</term>
<listitem><simpara> Offset in x direction.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offy</parameter> :</term>
<listitem><simpara> Offset in y direction.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-add-alpha" role="function"/>gimp_layer_add_alpha ()</title>
<indexterm><primary>gimp_layer_add_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_add_alpha (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Add an alpha channel to the layer if it doesn't already have one.
</para>
<para>
This procedure adds an additional component to the specified layer
if it does not already possess an alpha channel. An alpha channel
makes it possible to move a layer from the bottom of the layer stack
and to clear and erase to transparency, instead of the background
color. This transforms images of type RGB to RGBA, GRAY to GRAYA,
and INDEXED to INDEXEDA.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-set-offsets" role="function"/>gimp_layer_set_offsets ()</title>
<indexterm><primary>gimp_layer_set_offsets</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_offsets (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);</programlisting>
<para>
Set the layer offsets.
</para>
<para>
This procedure sets the offsets for the specified layer. The offsets
are relative to the image origin and can be any values. This
operation is valid only on layers which have been added to an image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offx</parameter> :</term>
<listitem><simpara> Offset in x direction.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offy</parameter> :</term>
<listitem><simpara> Offset in y direction.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-create-mask" role="function"/>gimp_layer_create_mask ()</title>
<indexterm><primary>gimp_layer_create_mask</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_create_mask (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="GimpAddMaskType">GimpAddMaskType</link> mask_type);</programlisting>
<para>
Create a layer mask for the specified specified layer.
</para>
<para>
This procedure creates a layer mask for the specified layer. Layer
masks serve as an additional alpha channel for a layer. A number of
ifferent types of masks are allowed for initialisation: completely
white masks (which will leave the layer fully visible), completely
black masks (which will give the layer complete transparency, the
layer's already existing alpha channel (which will leave the layer
fully visible, but which may be more useful than a white mask), the
current selection or a grayscale copy of the layer. The layer mask
still needs to be added to the layer. This can be done with a call
to 'gimp_layer_add_mask'.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer to which to add the mask.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_type</parameter> :</term>
<listitem><simpara> The type of mask.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created mask.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-from-mask" role="function" condition="since:GIMP 2.2"/>gimp_layer_from_mask ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_layer_from_mask</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_from_mask (<link linkend="gint32">gint32</link> mask_ID);</programlisting>
<para>
Get the specified mask's layer.
</para>
<para>
This procedure returns the specified mask's layer , or -1 if none
exists.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mask_ID</parameter> :</term>
<listitem><simpara> Mask for which to return the layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The mask's layer.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-layer-get-mask" role="function"/>gimp_layer_get_mask ()</title>
<indexterm><primary>gimp_layer_get_mask</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_get_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Get the specified layer's mask if it exists.
</para>
<para>
This procedure returns the specified layer's mask, or -1 if none
exists.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer mask.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-add-mask" role="function"/>gimp_layer_add_mask ()</title>
<indexterm><primary>gimp_layer_add_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_add_mask (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint32">gint32</link> mask_ID);</programlisting>
<para>
Add a layer mask to the specified layer.
</para>
<para>
This procedure adds a layer mask to the specified layer. Layer masks
serve as an additional alpha channel for a layer. This procedure
will fail if a number of prerequisites aren't met. The layer cannot
already have a layer mask. The specified mask must exist and have
the same dimensions as the layer. Both the mask and the layer must
have been created for use with the specified image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer to receive the mask.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_ID</parameter> :</term>
<listitem><simpara> The mask to add to the layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-remove-mask" role="function"/>gimp_layer_remove_mask ()</title>
<indexterm><primary>gimp_layer_remove_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_remove_mask (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="GimpMaskApplyMode">GimpMaskApplyMode</link> mode);</programlisting>
<para>
Remove the specified layer mask from the layer.
</para>
<para>
This procedure removes the specified layer mask from the layer. If
the mask doesn't exist, an error is returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer from which to remove mask.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> Removal mode.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-new-from-drawable" role="function"/>gimp_layer_new_from_drawable ()</title>
<indexterm><primary>gimp_layer_new_from_drawable</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_new_from_drawable (<link linkend="gint32">gint32</link> drawable_ID,
<link linkend="gint32">gint32</link> dest_image_ID);</programlisting>
<para>
Create a new layer by copying an existing drawable.
</para>
<para>
This procedure creates a new layer as a copy of the specified
drawable. The new layer still needs to be added to the image, as
this is not automatic. Add the new layer with the
'gimp_image_add_layer' command. Other attributes such as layer mask
modes, and offsets should be set with explicit procedure calls.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The source drawable from where the new layer is copied.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_image_ID</parameter> :</term>
<listitem><simpara> The destination image to which to add the layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly copied layer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-get-preserve-trans" role="function"/>gimp_layer_get_preserve_trans ()</title>
<indexterm><primary>gimp_layer_get_preserve_trans</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_preserve_trans (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Get the preserve transperancy setting of the specified layer.
</para>
<para>
This procedure returns the specified layer's preserve transperancy
setting.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer's preserve transperancy setting.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-set-preserve-trans" role="function"/>gimp_layer_set_preserve_trans ()</title>
<indexterm><primary>gimp_layer_set_preserve_trans</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_preserve_trans (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> preserve_trans);</programlisting>
<para>
Set the preserve transperancy setting of the specified layer.
</para>
<para>
This procedure sets the specified layer's preserve transperancy
setting.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>preserve_trans</parameter> :</term>
<listitem><simpara> The new layer's preserve transperancy setting.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-get-apply-mask" role="function"/>gimp_layer_get_apply_mask ()</title>
<indexterm><primary>gimp_layer_get_apply_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_apply_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Get the apply mask of the specified layer.
</para>
<para>
This procedure returns the specified layer's apply mask. If the
value is non-zero, then the layer mask for this layer is currently
being composited with the layer's alpha channel.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer apply mask.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-set-apply-mask" role="function"/>gimp_layer_set_apply_mask ()</title>
<indexterm><primary>gimp_layer_set_apply_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_apply_mask (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> apply_mask);</programlisting>
<para>
Set the apply mask of the specified layer.
</para>
<para>
This procedure sets the specified layer's apply mask. This controls
whether the layer's mask is currently affecting the alpha channel.
If there is no layer mask, this function will return an error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>apply_mask</parameter> :</term>
<listitem><simpara> The new layer apply mask.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-get-show-mask" role="function"/>gimp_layer_get_show_mask ()</title>
<indexterm><primary>gimp_layer_get_show_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_show_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Get the show mask of the specified layer.
</para>
<para>
This procedure returns the specified layer's show mask. If the value
is non-zero, then the layer mask for this layer is currently being
shown instead of the layer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer show mask.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-set-show-mask" role="function"/>gimp_layer_set_show_mask ()</title>
<indexterm><primary>gimp_layer_set_show_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_show_mask (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> show_mask);</programlisting>
<para>
Set the show mask of the specified layer.
</para>
<para>
This procedure sets the specified layer's show mask. This controls
whether the layer or it's mask is visible. Non-zero values indicate
that the mask should be visible. If the layer has no mask, then this
function returns an error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show_mask</parameter> :</term>
<listitem><simpara> The new layer show mask.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-get-edit-mask" role="function"/>gimp_layer_get_edit_mask ()</title>
<indexterm><primary>gimp_layer_get_edit_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_edit_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Get the show mask of the specified layer.
</para>
<para>
This procedure returns the specified layer's show mask. If the value
is non-zero, then the layer mask for this layer is currently active,
and not the layer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer show mask.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-set-edit-mask" role="function"/>gimp_layer_set_edit_mask ()</title>
<indexterm><primary>gimp_layer_set_edit_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_edit_mask (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gboolean">gboolean</link> edit_mask);</programlisting>
<para>
Set the show mask of the specified layer.
</para>
<para>
This procedure sets the specified layer's show mask. This controls
whether the layer or it's mask is currently active for editing. If
the specified layer has no layer mask, then this procedure will
return an error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>edit_mask</parameter> :</term>
<listitem><simpara> The new layer show mask.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-get-opacity" role="function"/>gimp_layer_get_opacity ()</title>
<indexterm><primary>gimp_layer_get_opacity</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_layer_get_opacity (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Get the opacity of the specified layer.
</para>
<para>
This procedure returns the specified layer's opacity.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer opacity.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-set-opacity" role="function"/>gimp_layer_set_opacity ()</title>
<indexterm><primary>gimp_layer_set_opacity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_opacity (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gdouble">gdouble</link> opacity);</programlisting>
<para>
Set the opacity of the specified layer.
</para>
<para>
This procedure sets the specified layer's opacity.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opacity</parameter> :</term>
<listitem><simpara> The new layer opacity.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-get-mode" role="function"/>gimp_layer_get_mode ()</title>
<indexterm><primary>gimp_layer_get_mode</primary></indexterm><programlisting><link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> gimp_layer_get_mode (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Get the combination mode of the specified layer.
</para>
<para>
This procedure returns the specified layer's combination mode.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer combination mode.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-set-mode" role="function"/>gimp_layer_set_mode ()</title>
<indexterm><primary>gimp_layer_set_mode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_mode (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);</programlisting>
<para>
Set the combination mode of the specified layer.
</para>
<para>
This procedure sets the specified layer's combination mode.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> The new layer combination mode.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-layer-is-floating-sel" role="function"/>gimp_layer_is_floating_sel ()</title>
<indexterm><primary>gimp_layer_is_floating_sel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_is_floating_sel (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
<para>
Is the specified layer a floating selection?
</para>
<para>
This procedure returns whether the layer is a floating selection.
Floating selections are special cases of layers which are attached
to a specific drawable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Non-zero if the layer is a floating selection.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
