callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b8aa0b67d1328f370c1cc63d2794026a0f7d383f
gimp/devel-docs/libgimp/html/libgimp-gimplayer.html
Ari Pollak b8aa0b67d1 Imported Upstream version 2.8.10
2013-12-04 20:45:50 -05:00

1399 lines
70 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.78.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-gimpitemtransform.html" title="gimpitemtransform">
<link rel="next" href="libgimp-gimppaths.html" title="gimppaths">
<meta name="generator" content="GTK-Doc V1.19 (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-gimpitemtransform.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="/local/head/share/gtk-doc/html/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-new-from-pixbuf" title="gimp_layer_new_from_pixbuf ()">gimp_layer_new_from_pixbuf</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">GdkPixbuf</span> *pixbuf</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>,
<em class="parameter"><code><span class="type">gdouble</span> progress_start</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress_end</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-new-from-surface" title="gimp_layer_new_from_surface ()">gimp_layer_new_from_surface</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">cairo_surface_t</span> *surface</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress_start</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress_end</code></em>);
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimplayer.html#gimp-layer-group-new" title="gimp_layer_group_new ()">gimp_layer_group_new</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</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="/local/head/share/gtk-doc/html/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="/local/head/share/gtk-doc/html/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="/local/head/share/gtk-doc/html/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 <a class="link" href="libgimp-gimpimage.html#gimp-image-insert-layer" title="gimp_image_insert_layer ()"><code class="function">gimp_image_insert_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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-insert-layer" title="gimp_image_insert_layer ()"><code class="function">gimp_image_insert_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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-insert-layer" title="gimp_image_insert_layer ()"><code class="function">gimp_image_insert_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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-new-from-pixbuf"></a><h3>gimp_layer_new_from_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_new_from_pixbuf (<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">GdkPixbuf</span> *pixbuf</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>,
<em class="parameter"><code><span class="type">gdouble</span> progress_start</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress_end</code></em>);</pre>
<p>
Create a new layer from a <code class="literal">GdkPixbuf</code>.
</p>
<p>
This procedure creates a new layer from the given <code class="literal">GdkPixbuf</code>. The
image has to be an RGB image and just like with <a class="link" href="libgimp-gimplayer.html#gimp-layer-new" title="gimp_layer_new ()"><code class="function">gimp_layer_new()</code></a>
you will still need to add the layer to it.
</p>
<p>
If you pass <em class="parameter"><code>progress_end</code></em> &gt; <em class="parameter"><code>progress_start</code></em> to this function,
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-update" title="gimp_progress_update ()"><code class="function">gimp_progress_update()</code></a> will be called for. You have to call
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> beforehand then.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The RGB 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>pixbuf</code></em> :</span></p></td>
<td>A GdkPixbuf.</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"><em class="parameter"><code>progress_start</code></em> :</span></p></td>
<td>start of progress</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_end</code></em> :</span></p></td>
<td>end of progress</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.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-new-from-surface"></a><h3>gimp_layer_new_from_surface ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_new_from_surface (<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">cairo_surface_t</span> *surface</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress_start</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> progress_end</code></em>);</pre>
<p>
Create a new layer from a <span class="type">cairo_surface_t</span>.
</p>
<p>
This procedure creates a new layer from the given
<span class="type">cairo_surface_t</span>. The image has to be an RGB image and just like
with <a class="link" href="libgimp-gimplayer.html#gimp-layer-new" title="gimp_layer_new ()"><code class="function">gimp_layer_new()</code></a> you will still need to add the layer to it.
</p>
<p>
If you pass <em class="parameter"><code>progress_end</code></em> &gt; <em class="parameter"><code>progress_start</code></em> to this function,
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-update" title="gimp_progress_update ()"><code class="function">gimp_progress_update()</code></a> will be called for. You have to call
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> beforehand then.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td>The RGB 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>surface</code></em> :</span></p></td>
<td>A Cairo image surface.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_start</code></em> :</span></p></td>
<td>start of progress</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_end</code></em> :</span></p></td>
<td>end of progress</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.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-layer-group-new"></a><h3>gimp_layer_group_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span> gimp_layer_group_new (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre>
<p>
Create a new layer group.
</p>
<p>
This procedure creates a new layer group. Attributes such as layer
mode and opacity should be set with explicit procedure calls. Add
the new layer group (which is a kind of layer) with the
<a class="link" href="libgimp-gimpimage.html#gimp-image-insert-layer" title="gimp_image_insert_layer ()"><code class="function">gimp_image_insert_layer()</code></a> command.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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 group.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created layer group.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.8</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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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 interpolation method used can be set with
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-interpolation" title="gimp_context_set_interpolation ()"><code class="function">gimp_context_set_interpolation()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpInterpolationType"><span class="type">GimpInterpolationType</span></a> interpolation</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_scale_full</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="libgimp-gimplayer.html#gimp-layer-scale" title="gimp_layer_scale ()"><code class="function">gimp_layer_scale()</code></a> instead.</p>
</div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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="/local/head/share/gtk-doc/html/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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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.19</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink