/usr/share/gtk-doc/html/libgimp/libgimp-gimplayer.html is in libgimp2.0-doc 2.6.12-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimplayer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="prev" href="libgimp-gimpimage.html" title="gimpimage">
<link rel="next" href="libgimp-gimppaths.html" title="gimppaths">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpimage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimppaths.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimp-gimplayer.synopsis" class="shortcut">Top</a>
|
<a href="#libgimp-gimplayer.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgimp-gimplayer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimplayer.top_of_page"></a>gimplayer</span></h2>
<p>gimplayer — Operations on a single layer.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgimp-gimplayer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-new" title="gimp_layer_new ()">gimp_layer_new</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"><span class="type">GimpImageType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects" title="enum GimpLayerModeEffects"><span class="type">GimpLayerModeEffects</span></a> mode</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-new-from-drawable" title="gimp_layer_new_from_drawable ()">gimp_layer_new_from_drawable</a> (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> dest_image_ID</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-new-from-visible" title="gimp_layer_new_from_visible ()">gimp_layer_new_from_visible</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> dest_image_ID</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-copy" title="gimp_layer_copy ()">gimp_layer_copy</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-scale" title="gimp_layer_scale ()">gimp_layer_scale</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> local_origin</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-scale-full" title="gimp_layer_scale_full ()">gimp_layer_scale_full</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> local_origin</code></em>,
<em class="parameter"><code><a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpInterpolationType"><span class="type">GimpInterpolationType</span></a> interpolation</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-resize" title="gimp_layer_resize ()">gimp_layer_resize</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-resize-to-image-size" title="gimp_layer_resize_to_image_size ()">gimp_layer_resize_to_image_size</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-translate" title="gimp_layer_translate ()">gimp_layer_translate</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-add-alpha" title="gimp_layer_add_alpha ()">gimp_layer_add_alpha</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-flatten" title="gimp_layer_flatten ()">gimp_layer_flatten</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-offsets" title="gimp_layer_set_offsets ()">gimp_layer_set_offsets</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-create-mask" title="gimp_layer_create_mask ()">gimp_layer_create_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpAddMaskType"><span class="type">GimpAddMaskType</span></a> mask_type</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-from-mask" title="gimp_layer_from_mask ()">gimp_layer_from_mask</a> (<em class="parameter"><code><span class="type">gint32</span> mask_ID</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-mask" title="gimp_layer_get_mask ()">gimp_layer_get_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-add-mask" title="gimp_layer_add_mask ()">gimp_layer_add_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> mask_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-remove-mask" title="gimp_layer_remove_mask ()">gimp_layer_remove_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpMaskApplyMode" title="enum GimpMaskApplyMode"><span class="type">GimpMaskApplyMode</span></a> mode</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-lock-alpha" title="gimp_layer_get_lock_alpha ()">gimp_layer_get_lock_alpha</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-lock-alpha" title="gimp_layer_set_lock_alpha ()">gimp_layer_set_lock_alpha</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> lock_alpha</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-preserve-trans" title="gimp_layer_get_preserve_trans ()">gimp_layer_get_preserve_trans</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-preserve-trans" title="gimp_layer_set_preserve_trans ()">gimp_layer_set_preserve_trans</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> preserve_trans</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-apply-mask" title="gimp_layer_get_apply_mask ()">gimp_layer_get_apply_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-apply-mask" title="gimp_layer_set_apply_mask ()">gimp_layer_set_apply_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> apply_mask</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-show-mask" title="gimp_layer_get_show_mask ()">gimp_layer_get_show_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-show-mask" title="gimp_layer_set_show_mask ()">gimp_layer_set_show_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show_mask</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-edit-mask" title="gimp_layer_get_edit_mask ()">gimp_layer_get_edit_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-edit-mask" title="gimp_layer_set_edit_mask ()">gimp_layer_set_edit_mask</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> edit_mask</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-opacity" title="gimp_layer_get_opacity ()">gimp_layer_get_opacity</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-opacity" title="gimp_layer_set_opacity ()">gimp_layer_set_opacity</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>);
<a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects" title="enum GimpLayerModeEffects"><span class="returnvalue">GimpLayerModeEffects</span></a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-mode" title="gimp_layer_get_mode ()">gimp_layer_get_mode</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-mode" title="gimp_layer_set_mode ()">gimp_layer_set_mode</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects" title="enum GimpLayerModeEffects"><span class="type">GimpLayerModeEffects</span></a> mode</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-is-floating-sel" title="gimp_layer_is_floating_sel ()">gimp_layer_is_floating_sel</a> (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgimp-gimplayer.description"></a><h2>Description</h2>
<p>
Operations on a single layer.
</p>
</div>
<div class="refsect1">
<a name="libgimp-gimplayer.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gimp-layer-new"></a><h3>gimp_layer_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_new (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"><span class="type">GimpImageType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects" title="enum GimpLayerModeEffects"><span class="type">GimpLayerModeEffects</span></a> mode</code></em>);</pre>
<p>
Create a new layer.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The image to which to add the layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The layer name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>The layer width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>The layer height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The layer type.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opacity</code></em> :</span></p></td>
<td>The layer opacity.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>The layer combination mode.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created layer.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-new-from-drawable"></a><h3>gimp_layer_new_from_drawable ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_new_from_drawable (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> dest_image_ID</code></em>);</pre>
<p>
Create a new layer by copying an existing drawable.
</p>
<p>
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
<a class="link" href="libgimp-gimpimage.html#gimp-image-add-layer" title="gimp_image_add_layer ()"><code class="function">gimp_image_add_layer()</code></a> command. Other attributes such as layer mask
modes, and offsets should be set with explicit procedure calls.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></p></td>
<td>The source drawable from where the new layer is copied.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_image_ID</code></em> :</span></p></td>
<td>The destination image to which to add the layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly copied layer.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-new-from-visible"></a><h3>gimp_layer_new_from_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_new_from_visible (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> dest_image_ID</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Create a new layer from what is visible in an image.
</p>
<p>
This procedure creates a new layer from what is visible in the given
image. The new layer still needs to be added to the destination
image, as this is not automatic. Add the new layer with the
<a class="link" href="libgimp-gimpimage.html#gimp-image-add-layer" title="gimp_image_add_layer ()"><code class="function">gimp_image_add_layer()</code></a> command. Other attributes such as layer mask
modes, and offsets should be set with explicit procedure calls.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The source image from where the content is copied.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_image_ID</code></em> :</span></p></td>
<td>The destination image to which to add the layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The layer name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created layer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-copy"></a><h3>gimp_layer_copy ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_copy (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Copy a layer.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer to copy.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly copied layer.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-scale"></a><h3>gimp_layer_scale ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_scale (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> local_origin</code></em>);</pre>
<p>
Scale the layer using the default interpolation method.
</p>
<p>
This procedure scales the layer so that its 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. The default interpolation method is used for scaling.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_width</code></em> :</span></p></td>
<td>New layer width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_height</code></em> :</span></p></td>
<td>New layer height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>local_origin</code></em> :</span></p></td>
<td>Use a local origin (as opposed to the image origin).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-scale-full"></a><h3>gimp_layer_scale_full ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_scale_full (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> local_origin</code></em>,
<em class="parameter"><code><a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpInterpolationType"><span class="type">GimpInterpolationType</span></a> interpolation</code></em>);</pre>
<p>
Scale the layer using a specific interpolation method.
</p>
<p>
This procedure scales the layer so that its 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. This procedure allows you to specify the interpolation
method explicitly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_width</code></em> :</span></p></td>
<td>New layer width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_height</code></em> :</span></p></td>
<td>New layer height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>local_origin</code></em> :</span></p></td>
<td>Use a local origin (as opposed to the image origin).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interpolation</code></em> :</span></p></td>
<td>Type of interpolation.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-resize"></a><h3>gimp_layer_resize ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_resize (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);</pre>
<p>
Resize the layer to the specified extents.
</p>
<p>
This procedure resizes the layer so that its 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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_width</code></em> :</span></p></td>
<td>New layer width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_height</code></em> :</span></p></td>
<td>New layer height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offx</code></em> :</span></p></td>
<td>x offset between upper left corner of old and new layers: (old - new).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offy</code></em> :</span></p></td>
<td>y offset between upper left corner of old and new layers: (old - new).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-resize-to-image-size"></a><h3>gimp_layer_resize_to_image_size ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_resize_to_image_size (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Resize a layer to the image size.
</p>
<p>
This procedure resizes the layer so that it's new width and height
are equal to the width and height of its image container.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer to resize.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-translate"></a><h3>gimp_layer_translate ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_translate (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);</pre>
<p>
Translate the layer by the specified offsets.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offx</code></em> :</span></p></td>
<td>Offset in x direction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offy</code></em> :</span></p></td>
<td>Offset in y direction.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-add-alpha"></a><h3>gimp_layer_add_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_add_alpha (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Add an alpha channel to the layer if it doesn't already have one.
</p>
<p>
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 clear and erase to transparency, instead of the
background color. This transforms layers of type RGB to RGBA, GRAY
to GRAYA, and INDEXED to INDEXEDA.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-flatten"></a><h3>gimp_layer_flatten ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_flatten (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Remove the alpha channel from the layer if it has one.
</p>
<p>
This procedure removes the alpha channel from a layer, blending all
(partially) transparent pixels in the layer against the background
color. This transforms layers of type RGBA to RGB, GRAYA to GRAY,
and INDEXEDA to INDEXED.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-offsets"></a><h3>gimp_layer_set_offsets ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_offsets (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);</pre>
<p>
Set the layer offsets.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offx</code></em> :</span></p></td>
<td>Offset in x direction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offy</code></em> :</span></p></td>
<td>Offset in y direction.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-create-mask"></a><h3>gimp_layer_create_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_create_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpAddMaskType"><span class="type">GimpAddMaskType</span></a> mask_type</code></em>);</pre>
<p>
Create a layer mask for the specified specified layer.
</p>
<p>
This procedure creates a layer mask for the specified layer. Layer
masks serve as an additional alpha channel for a layer. A number of
different 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 <a class="link" href="libgimp-gimplayer.html#gimp-layer-add-mask" title="gimp_layer_add_mask ()"><code class="function">gimp_layer_add_mask()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer to which to add the mask.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_type</code></em> :</span></p></td>
<td>The type of mask.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created mask.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-from-mask"></a><h3>gimp_layer_from_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_from_mask (<em class="parameter"><code><span class="type">gint32</span> mask_ID</code></em>);</pre>
<p>
Get the specified mask's layer.
</p>
<p>
This procedure returns the specified mask's layer , or -1 if none
exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_ID</code></em> :</span></p></td>
<td>Mask for which to return the layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The mask's layer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-mask"></a><h3>gimp_layer_get_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_get_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Get the specified layer's mask if it exists.
</p>
<p>
This procedure returns the specified layer's mask, or -1 if none
exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer mask.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-add-mask"></a><h3>gimp_layer_add_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_add_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> mask_ID</code></em>);</pre>
<p>
Add a layer mask to the specified layer.
</p>
<p>
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. The layer must have been created
for use with the specified image and the mask must have been created
with the procedure 'gimp-layer-create-mask'.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer to receive the mask.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_ID</code></em> :</span></p></td>
<td>The mask to add to the layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-remove-mask"></a><h3>gimp_layer_remove_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_remove_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpMaskApplyMode" title="enum GimpMaskApplyMode"><span class="type">GimpMaskApplyMode</span></a> mode</code></em>);</pre>
<p>
Remove the specified layer mask from the layer.
</p>
<p>
This procedure removes the specified layer mask from the layer. If
the mask doesn't exist, an error is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer from which to remove mask.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>Removal mode.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-lock-alpha"></a><h3>gimp_layer_get_lock_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_get_lock_alpha (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Get the lock alpha channel setting of the specified layer.
</p>
<p>
This procedure returns the specified layer's lock alpha channel
setting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer's lock alpha channel setting.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-lock-alpha"></a><h3>gimp_layer_set_lock_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_lock_alpha (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> lock_alpha</code></em>);</pre>
<p>
Set the lock alpha channel setting of the specified layer.
</p>
<p>
This procedure sets the specified layer's lock alpha channel
setting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lock_alpha</code></em> :</span></p></td>
<td>The new layer's lock alpha channel setting.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-preserve-trans"></a><h3>gimp_layer_get_preserve_trans ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_get_preserve_trans (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_layer_get_preserve_trans</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-lock-alpha" title="gimp_layer_get_lock_alpha ()"><code class="function">gimp_layer_get_lock_alpha()</code></a> instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer's preserve transperancy setting.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-preserve-trans"></a><h3>gimp_layer_set_preserve_trans ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_preserve_trans (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> preserve_trans</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_layer_set_preserve_trans</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-lock-alpha" title="gimp_layer_set_lock_alpha ()"><code class="function">gimp_layer_set_lock_alpha()</code></a> instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>preserve_trans</code></em> :</span></p></td>
<td>The new layer's preserve transperancy setting.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-apply-mask"></a><h3>gimp_layer_get_apply_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_get_apply_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Get the apply mask setting of the specified layer.
</p>
<p>
This procedure returns the specified layer's apply mask setting. If
the value is TRUE, then the layer mask for this layer is currently
being composited with the layer's alpha channel.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer's apply mask setting.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-apply-mask"></a><h3>gimp_layer_set_apply_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_apply_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> apply_mask</code></em>);</pre>
<p>
Set the apply mask setting of the specified layer.
</p>
<p>
This procedure sets the specified layer's apply mask setting. 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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>apply_mask</code></em> :</span></p></td>
<td>The new layer's apply mask setting.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-show-mask"></a><h3>gimp_layer_get_show_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_get_show_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Get the show mask setting of the specified layer.
</p>
<p>
This procedure returns the specified layer's show mask setting. This
controls whether the layer or its mask is visible. TRUE indicates
that the mask should be visible. If the layer has no mask, then this
function returns an error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer's show mask setting.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-show-mask"></a><h3>gimp_layer_set_show_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_show_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show_mask</code></em>);</pre>
<p>
Set the show mask setting of the specified layer.
</p>
<p>
This procedure sets the specified layer's show mask setting. This
controls whether the layer or its mask is visible. TRUE indicates
that the mask should be visible. If there is no layer mask, this
function will return an error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show_mask</code></em> :</span></p></td>
<td>The new layer's show mask setting.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-edit-mask"></a><h3>gimp_layer_get_edit_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_get_edit_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Get the edit mask setting of the specified layer.
</p>
<p>
This procedure returns the specified layer's edit mask setting. If
the value is TRUE, then the layer mask for this layer is currently
active, and not the layer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer's edit mask setting.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-edit-mask"></a><h3>gimp_layer_set_edit_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_edit_mask (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> edit_mask</code></em>);</pre>
<p>
Set the edit mask setting of the specified layer.
</p>
<p>
This procedure sets the specified layer's edit mask setting. 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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>edit_mask</code></em> :</span></p></td>
<td>The new layer's edit mask setting.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-opacity"></a><h3>gimp_layer_get_opacity ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_layer_get_opacity (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Get the opacity of the specified layer.
</p>
<p>
This procedure returns the specified layer's opacity.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer opacity.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-opacity"></a><h3>gimp_layer_set_opacity ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_opacity (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>);</pre>
<p>
Set the opacity of the specified layer.
</p>
<p>
This procedure sets the specified layer's opacity.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opacity</code></em> :</span></p></td>
<td>The new layer opacity.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-get-mode"></a><h3>gimp_layer_get_mode ()</h3>
<pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects" title="enum GimpLayerModeEffects"><span class="returnvalue">GimpLayerModeEffects</span></a> gimp_layer_get_mode (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Get the combination mode of the specified layer.
</p>
<p>
This procedure returns the specified layer's combination mode.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The layer combination mode.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-set-mode"></a><h3>gimp_layer_set_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_set_mode (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects" title="enum GimpLayerModeEffects"><span class="type">GimpLayerModeEffects</span></a> mode</code></em>);</pre>
<p>
Set the combination mode of the specified layer.
</p>
<p>
This procedure sets the specified layer's combination mode.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>The new layer combination mode.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-is-floating-sel"></a><h3>gimp_layer_is_floating_sel ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_layer_is_floating_sel (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre>
<p>
Is the specified layer a floating selection?
</p>
<p>
This procedure returns whether the layer is a floating selection.
Floating selections are special cases of layers which are attached
to a specific drawable.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
<td>The layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the layer is a floating selection.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|