1582 lines
54 KiB
HTML
1582 lines
54 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>gimplayer</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
|
<link rel="start" 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.8 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
|
|
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
|
|
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
|
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
|
|
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
|
|
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
|
|
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="index" href="libgimp-index.html" title="Index">
|
|
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
|
|
</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"><nobr><a href="#id2617819" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2657306" class="shortcut">Description</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="libgimp-gimplayer"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2617819"></a><span class="refentrytitle">gimplayer</span>
|
|
</h2>
|
|
<p>gimplayer — Operations on a single layer.</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-new">gimp_layer_new</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> image_ID,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *name,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gdouble"
|
|
>gdouble</a> opacity,
|
|
<a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> mode);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-copy">gimp_layer_copy</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-scale">gimp_layer_scale</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_height,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> local_origin);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-resize">gimp_layer_resize</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_height,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offx,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offy);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-resize-to-image-size">gimp_layer_resize_to_image_size</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-translate">gimp_layer_translate</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offx,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offy);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-add-alpha">gimp_layer_add_alpha</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-flatten">gimp_layer_flatten</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-offsets">gimp_layer_set_offsets</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offx,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offy);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-create-mask">gimp_layer_create_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpAddMaskType"
|
|
>GimpAddMaskType</a> mask_type);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-from-mask">gimp_layer_from_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> mask_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-mask">gimp_layer_get_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-add-mask">gimp_layer_add_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> mask_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-remove-mask">gimp_layer_remove_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a class="link" href="libgimp-gimpenums.html#GimpMaskApplyMode">GimpMaskApplyMode</a> mode);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-new-from-drawable">gimp_layer_new_from_drawable</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> drawable_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> dest_image_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-lock-alpha">gimp_layer_get_lock_alpha</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-lock-alpha">gimp_layer_set_lock_alpha</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> lock_alpha);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-preserve-trans">gimp_layer_get_preserve_trans</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-preserve-trans">gimp_layer_set_preserve_trans</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> preserve_trans);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-apply-mask">gimp_layer_get_apply_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-apply-mask">gimp_layer_set_apply_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> apply_mask);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-show-mask">gimp_layer_get_show_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-show-mask">gimp_layer_set_show_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> show_mask);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-edit-mask">gimp_layer_get_edit_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-edit-mask">gimp_layer_set_edit_mask</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> edit_mask);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gdouble"
|
|
>gdouble</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-opacity">gimp_layer_get_opacity</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-opacity">gimp_layer_set_opacity</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gdouble"
|
|
>gdouble</a> opacity);
|
|
<a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-get-mode">gimp_layer_get_mode</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-set-mode">gimp_layer_set_mode</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> mode);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimplayer.html#gimp-layer-is-floating-sel">gimp_layer_is_floating_sel</a> (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2657306"></a><h2>Description</h2>
|
|
<p>
|
|
Operations on a single layer.
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2657321"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2657332"></a><h3>
|
|
<a name="gimp-layer-new"></a>gimp_layer_new ()</h3>
|
|
<a class="indexterm" name="id2657344"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> gimp_layer_new (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> image_ID,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *name,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gdouble"
|
|
>gdouble</a> opacity,
|
|
<a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> mode);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2662748"></a><h3>
|
|
<a name="gimp-layer-copy"></a>gimp_layer_copy ()</h3>
|
|
<a class="indexterm" name="id2662760"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> gimp_layer_copy (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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. If you create
|
|
a copy of the background layer, remember to add an alpha channel
|
|
before you add the new layer to the image.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2662829"></a><h3>
|
|
<a name="gimp-layer-scale"></a>gimp_layer_scale ()</h3>
|
|
<a class="indexterm" name="id2662842"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_scale (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_height,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> local_origin);</pre>
|
|
<p>
|
|
Scale the layer to the specified extents.
|
|
</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.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2662976"></a><h3>
|
|
<a name="gimp-layer-resize"></a>gimp_layer_resize ()</h3>
|
|
<a class="indexterm" name="id2662988"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_resize (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> new_height,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offx,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offy);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663144"></a><h3>
|
|
<a name="gimp-layer-resize-to-image-size"></a>gimp_layer_resize_to_image_size ()</h3>
|
|
<a class="indexterm" name="id2663156"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_resize_to_image_size (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663221"></a><h3>
|
|
<a name="gimp-layer-translate"></a>gimp_layer_translate ()</h3>
|
|
<a class="indexterm" name="id2663232"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_translate (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offx,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offy);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663345"></a><h3>
|
|
<a name="gimp-layer-add-alpha"></a>gimp_layer_add_alpha ()</h3>
|
|
<a class="indexterm" name="id2663356"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_add_alpha (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663426"></a><h3>
|
|
<a name="gimp-layer-flatten"></a>gimp_layer_flatten ()</h3>
|
|
<a class="indexterm" name="id2663440"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_flatten (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663516"></a><h3>
|
|
<a name="gimp-layer-set-offsets"></a>gimp_layer_set_offsets ()</h3>
|
|
<a class="indexterm" name="id2663527"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_offsets (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offx,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> offy);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663636"></a><h3>
|
|
<a name="gimp-layer-create-mask"></a>gimp_layer_create_mask ()</h3>
|
|
<a class="indexterm" name="id2663648"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> gimp_layer_create_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpAddMaskType"
|
|
>GimpAddMaskType</a> mask_type);</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"><code class="function">gimp_layer_add_mask()</code></a>.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663753"></a><h3>
|
|
<a name="gimp-layer-from-mask"></a>gimp_layer_from_mask ()</h3>
|
|
<a class="indexterm" name="id2663766"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> gimp_layer_from_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> mask_ID);</pre>
|
|
<p>
|
|
Get the specified mask's layer.
|
|
</p>
|
|
<p>
|
|
This procedure returns the specified mask's layer , or -1 if none
|
|
exists.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663837"></a><h3>
|
|
<a name="gimp-layer-get-mask"></a>gimp_layer_get_mask ()</h3>
|
|
<a class="indexterm" name="id2663850"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> gimp_layer_get_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2663915"></a><h3>
|
|
<a name="gimp-layer-add-mask"></a>gimp_layer_add_mask ()</h3>
|
|
<a class="indexterm" name="id2663928"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_add_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> mask_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664020"></a><h3>
|
|
<a name="gimp-layer-remove-mask"></a>gimp_layer_remove_mask ()</h3>
|
|
<a class="indexterm" name="id2664031"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_remove_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a class="link" href="libgimp-gimpenums.html#GimpMaskApplyMode">GimpMaskApplyMode</a> mode);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664118"></a><h3>
|
|
<a name="gimp-layer-new-from-drawable"></a>gimp_layer_new_from_drawable ()</h3>
|
|
<a class="indexterm" name="id2664130"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> gimp_layer_new_from_drawable (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> drawable_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> dest_image_ID);</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"><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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664230"></a><h3>
|
|
<a name="gimp-layer-get-lock-alpha"></a>gimp_layer_get_lock_alpha ()</h3>
|
|
<a class="indexterm" name="id2664242"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_get_lock_alpha (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664308"></a><h3>
|
|
<a name="gimp-layer-set-lock-alpha"></a>gimp_layer_set_lock_alpha ()</h3>
|
|
<a class="indexterm" name="id2664319"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_lock_alpha (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> lock_alpha);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664407"></a><h3>
|
|
<a name="gimp-layer-get-preserve-trans"></a>gimp_layer_get_preserve_trans ()</h3>
|
|
<a class="indexterm" name="id2664423"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_get_preserve_trans (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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"><code class="function">gimp_layer_get_lock_alpha()</code></a> instead.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664506"></a><h3>
|
|
<a name="gimp-layer-set-preserve-trans"></a>gimp_layer_set_preserve_trans ()</h3>
|
|
<a class="indexterm" name="id2664522"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_preserve_trans (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> preserve_trans);</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"><code class="function">gimp_layer_set_lock_alpha()</code></a> instead.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664627"></a><h3>
|
|
<a name="gimp-layer-get-apply-mask"></a>gimp_layer_get_apply_mask ()</h3>
|
|
<a class="indexterm" name="id2664639"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_get_apply_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664707"></a><h3>
|
|
<a name="gimp-layer-set-apply-mask"></a>gimp_layer_set_apply_mask ()</h3>
|
|
<a class="indexterm" name="id2664719"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_apply_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> apply_mask);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664809"></a><h3>
|
|
<a name="gimp-layer-get-show-mask"></a>gimp_layer_get_show_mask ()</h3>
|
|
<a class="indexterm" name="id2664820"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_get_show_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664889"></a><h3>
|
|
<a name="gimp-layer-set-show-mask"></a>gimp_layer_set_show_mask ()</h3>
|
|
<a class="indexterm" name="id2664900"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_show_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> show_mask);</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's mask is currently affecting the alpha
|
|
channel. If there is no layer mask, this function will return an
|
|
error.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2664990"></a><h3>
|
|
<a name="gimp-layer-get-edit-mask"></a>gimp_layer_get_edit_mask ()</h3>
|
|
<a class="indexterm" name="id2665002"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_get_edit_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2665069"></a><h3>
|
|
<a name="gimp-layer-set-edit-mask"></a>gimp_layer_set_edit_mask ()</h3>
|
|
<a class="indexterm" name="id2665080"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_edit_mask (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> edit_mask);</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>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2665170"></a><h3>
|
|
<a name="gimp-layer-get-opacity"></a>gimp_layer_get_opacity ()</h3>
|
|
<a class="indexterm" name="id2665182"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gdouble"
|
|
>gdouble</a> gimp_layer_get_opacity (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</pre>
|
|
<p>
|
|
Get the opacity of the specified layer.
|
|
</p>
|
|
<p>
|
|
This procedure returns the specified layer's opacity.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2665247"></a><h3>
|
|
<a name="gimp-layer-set-opacity"></a>gimp_layer_set_opacity ()</h3>
|
|
<a class="indexterm" name="id2665258"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_opacity (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gdouble"
|
|
>gdouble</a> opacity);</pre>
|
|
<p>
|
|
Set the opacity of the specified layer.
|
|
</p>
|
|
<p>
|
|
This procedure sets the specified layer's opacity.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2665344"></a><h3>
|
|
<a name="gimp-layer-get-mode"></a>gimp_layer_get_mode ()</h3>
|
|
<a class="indexterm" name="id2665356"></a><pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_layer_get_mode (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</pre>
|
|
<p>
|
|
Get the combination mode of the specified layer.
|
|
</p>
|
|
<p>
|
|
This procedure returns the specified layer's combination mode.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2665422"></a><h3>
|
|
<a name="gimp-layer-set-mode"></a>gimp_layer_set_mode ()</h3>
|
|
<a class="indexterm" name="id2665434"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_set_mode (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID,
|
|
<a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> mode);</pre>
|
|
<p>
|
|
Set the combination mode of the specified layer.
|
|
</p>
|
|
<p>
|
|
This procedure sets the specified layer's combination mode.</p>
|
|
<p>
|
|
|
|
</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" lang="en">
|
|
<a name="id2665521"></a><h3>
|
|
<a name="gimp-layer-is-floating-sel"></a>gimp_layer_is_floating_sel ()</h3>
|
|
<a class="indexterm" name="id2665533"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_layer_is_floating_sel (<a
|
|
href="../glib/glib-Basic-Types.html#gint32"
|
|
>gint32</a> layer_ID);</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>
|
|
<p>
|
|
|
|
</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>
|
|
</body>
|
|
</html>
|