Imported Upstream version 2.3.9

This commit is contained in:
Ari Pollak
2010-08-11 01:19:20 -04:00
parent 836308f327
commit 2a222e99d4
1588 changed files with 125210 additions and 92631 deletions

View File

@ -1,3 +1,4 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@ -7,7 +8,7 @@
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all 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.4 (XML mode)">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
@ -23,24 +24,29 @@
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<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></table>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" 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><span class="refentrytitle">gimplayer</span></h2>
<h2><span class="refentrytitle"><a name="top_of_page"></a>gimplayer</span></h2>
<p>gimplayer &#8212; Operations on a single layer.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
@ -109,18 +115,18 @@ gboolean <a href="libgimp-gimplayer.html#gimp-layer-is-floating-sel">gimp_lay
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2598722"></a><h2>Description</h2>
<a name="desc"></a><h2>Description</h2>
<p>
Operations on a single layer.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2598733"></a><h2>Details</h2>
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2598739"></a><h3>
<a name="id2600752"></a><h3>
<a name="gimp-layer-new"></a>gimp_layer_new ()</h3>
<a class="indexterm" name="id2598749"></a><pre class="programlisting">gint32 gimp_layer_new (gint32 image_ID,
<a class="indexterm" name="id2600764"></a><pre class="programlisting">gint32 gimp_layer_new (gint32 image_ID,
const gchar *name,
gint width,
gint height,
@ -198,9 +204,9 @@ should be set with explicit procedure calls.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601685"></a><h3>
<a name="id2604890"></a><h3>
<a name="gimp-layer-copy"></a>gimp_layer_copy ()</h3>
<a class="indexterm" name="id2601695"></a><pre class="programlisting">gint32 gimp_layer_copy (gint32 layer_ID);</pre>
<a class="indexterm" name="id2604903"></a><pre class="programlisting">gint32 gimp_layer_copy (gint32 layer_ID);</pre>
<p>
Copy a layer.
</p>
@ -233,9 +239,9 @@ before you add the new layer to the image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601763"></a><h3>
<a name="id2604971"></a><h3>
<a name="gimp-layer-scale"></a>gimp_layer_scale ()</h3>
<a class="indexterm" name="id2601773"></a><pre class="programlisting">gboolean gimp_layer_scale (gint32 layer_ID,
<a class="indexterm" name="id2604983"></a><pre class="programlisting">gboolean gimp_layer_scale (gint32 layer_ID,
gint new_width,
gint new_height,
gboolean local_origin);</pre>
@ -289,9 +295,9 @@ to an image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601905"></a><h3>
<a name="id2605115"></a><h3>
<a name="gimp-layer-resize"></a>gimp_layer_resize ()</h3>
<a class="indexterm" name="id2601916"></a><pre class="programlisting">gboolean gimp_layer_resize (gint32 layer_ID,
<a class="indexterm" name="id2605128"></a><pre class="programlisting">gboolean gimp_layer_resize (gint32 layer_ID,
gint new_width,
gint new_height,
gint offx,
@ -351,9 +357,9 @@ operation only works if the layer has been added to an image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602070"></a><h3>
<a name="id2605282"></a><h3>
<a name="gimp-layer-resize-to-image-size"></a>gimp_layer_resize_to_image_size ()</h3>
<a class="indexterm" name="id2602079"></a><pre class="programlisting">gboolean gimp_layer_resize_to_image_size (gint32 layer_ID);</pre>
<a class="indexterm" name="id2605294"></a><pre class="programlisting">gboolean gimp_layer_resize_to_image_size (gint32 layer_ID);</pre>
<p>
Resize a layer to the image size.
</p>
@ -383,9 +389,9 @@ are equal to the width and height of its image container.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602143"></a><h3>
<a name="id2605358"></a><h3>
<a name="gimp-layer-translate"></a>gimp_layer_translate ()</h3>
<a class="indexterm" name="id2602152"></a><pre class="programlisting">gboolean gimp_layer_translate (gint32 layer_ID,
<a class="indexterm" name="id2605369"></a><pre class="programlisting">gboolean gimp_layer_translate (gint32 layer_ID,
gint offx,
gint offy);</pre>
<p>
@ -433,9 +439,9 @@ the specified offsets.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602264"></a><h3>
<a name="id2605480"></a><h3>
<a name="gimp-layer-add-alpha"></a>gimp_layer_add_alpha ()</h3>
<a class="indexterm" name="id2602273"></a><pre class="programlisting">gboolean gimp_layer_add_alpha (gint32 layer_ID);</pre>
<a class="indexterm" name="id2605492"></a><pre class="programlisting">gboolean gimp_layer_add_alpha (gint32 layer_ID);</pre>
<p>
Add an alpha channel to the layer if it doesn't already have one.
</p>
@ -469,9 +475,9 @@ and INDEXED to INDEXEDA.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602342"></a><h3>
<a name="id2605562"></a><h3>
<a name="gimp-layer-set-offsets"></a>gimp_layer_set_offsets ()</h3>
<a class="indexterm" name="id2602351"></a><pre class="programlisting">gboolean gimp_layer_set_offsets (gint32 layer_ID,
<a class="indexterm" name="id2605574"></a><pre class="programlisting">gboolean gimp_layer_set_offsets (gint32 layer_ID,
gint offx,
gint offy);</pre>
<p>
@ -516,9 +522,9 @@ operation is valid only on layers which have been added to an image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602459"></a><h3>
<a name="id2605682"></a><h3>
<a name="gimp-layer-create-mask"></a>gimp_layer_create_mask ()</h3>
<a class="indexterm" name="id2602468"></a><pre class="programlisting">gint32 gimp_layer_create_mask (gint32 layer_ID,
<a class="indexterm" name="id2605693"></a><pre class="programlisting">gint32 gimp_layer_create_mask (gint32 layer_ID,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpAddMaskType"
>GimpAddMaskType</a> mask_type);</pre>
@ -565,9 +571,9 @@ to 'gimp_layer_add_mask'.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602563"></a><h3>
<a name="id2605790"></a><h3>
<a name="gimp-layer-from-mask"></a>gimp_layer_from_mask ()</h3>
<a class="indexterm" name="id2602572"></a><pre class="programlisting">gint32 gimp_layer_from_mask (gint32 mask_ID);</pre>
<a class="indexterm" name="id2605803"></a><pre class="programlisting">gint32 gimp_layer_from_mask (gint32 mask_ID);</pre>
<p>
Get the specified mask's layer.
</p>
@ -600,9 +606,9 @@ exists.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602640"></a><h3>
<a name="id2605873"></a><h3>
<a name="gimp-layer-get-mask"></a>gimp_layer_get_mask ()</h3>
<a class="indexterm" name="id2602650"></a><pre class="programlisting">gint32 gimp_layer_get_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2605885"></a><pre class="programlisting">gint32 gimp_layer_get_mask (gint32 layer_ID);</pre>
<p>
Get the specified layer's mask if it exists.
</p>
@ -632,9 +638,9 @@ exists.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602715"></a><h3>
<a name="id2605951"></a><h3>
<a name="gimp-layer-add-mask"></a>gimp_layer_add_mask ()</h3>
<a class="indexterm" name="id2602725"></a><pre class="programlisting">gboolean gimp_layer_add_mask (gint32 layer_ID,
<a class="indexterm" name="id2605963"></a><pre class="programlisting">gboolean gimp_layer_add_mask (gint32 layer_ID,
gint32 mask_ID);</pre>
<p>
Add a layer mask to the specified layer.
@ -675,9 +681,9 @@ have been created for use with the specified image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602815"></a><h3>
<a name="id2606054"></a><h3>
<a name="gimp-layer-remove-mask"></a>gimp_layer_remove_mask ()</h3>
<a class="indexterm" name="id2602824"></a><pre class="programlisting">gboolean gimp_layer_remove_mask (gint32 layer_ID,
<a class="indexterm" name="id2606066"></a><pre class="programlisting">gboolean gimp_layer_remove_mask (gint32 layer_ID,
<a href="libgimp-gimpenums.html#GimpMaskApplyMode">GimpMaskApplyMode</a> mode);</pre>
<p>
Remove the specified layer mask from the layer.
@ -714,9 +720,9 @@ the mask doesn't exist, an error is returned.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602912"></a><h3>
<a name="id2606154"></a><h3>
<a name="gimp-layer-new-from-drawable"></a>gimp_layer_new_from_drawable ()</h3>
<a class="indexterm" name="id2602921"></a><pre class="programlisting">gint32 gimp_layer_new_from_drawable (gint32 drawable_ID,
<a class="indexterm" name="id2606165"></a><pre class="programlisting">gint32 gimp_layer_new_from_drawable (gint32 drawable_ID,
gint32 dest_image_ID);</pre>
<p>
Create a new layer by copying an existing drawable.
@ -756,9 +762,9 @@ modes, and offsets should be set with explicit procedure calls.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603014"></a><h3>
<a name="id2606257"></a><h3>
<a name="gimp-layer-get-lock-alpha"></a>gimp_layer_get_lock_alpha ()</h3>
<a class="indexterm" name="id2603023"></a><pre class="programlisting">gboolean gimp_layer_get_lock_alpha (gint32 layer_ID);</pre>
<a class="indexterm" name="id2606268"></a><pre class="programlisting">gboolean gimp_layer_get_lock_alpha (gint32 layer_ID);</pre>
<p>
Get the lock alpha channel setting of the specified layer.
</p>
@ -788,9 +794,9 @@ setting.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603090"></a><h3>
<a name="id2606334"></a><h3>
<a name="gimp-layer-set-lock-alpha"></a>gimp_layer_set_lock_alpha ()</h3>
<a class="indexterm" name="id2603099"></a><pre class="programlisting">gboolean gimp_layer_set_lock_alpha (gint32 layer_ID,
<a class="indexterm" name="id2606346"></a><pre class="programlisting">gboolean gimp_layer_set_lock_alpha (gint32 layer_ID,
gboolean lock_alpha);</pre>
<p>
Set the lock alpha channel setting of the specified layer.
@ -827,9 +833,9 @@ setting.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603187"></a><h3>
<a name="id2606433"></a><h3>
<a name="gimp-layer-get-preserve-trans"></a>gimp_layer_get_preserve_trans ()</h3>
<a class="indexterm" name="id2603198"></a><pre class="programlisting">gboolean gimp_layer_get_preserve_trans (gint32 layer_ID);</pre>
<a class="indexterm" name="id2606447"></a><pre class="programlisting">gboolean gimp_layer_get_preserve_trans (gint32 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>
@ -859,9 +865,9 @@ This procedure is deprecated! Use <a href="libgimp-gimplayer.html#gimp-layer-get
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603282"></a><h3>
<a name="id2606531"></a><h3>
<a name="gimp-layer-set-preserve-trans"></a>gimp_layer_set_preserve_trans ()</h3>
<a class="indexterm" name="id2603292"></a><pre class="programlisting">gboolean gimp_layer_set_preserve_trans (gint32 layer_ID,
<a class="indexterm" name="id2606546"></a><pre class="programlisting">gboolean gimp_layer_set_preserve_trans (gint32 layer_ID,
gboolean preserve_trans);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
@ -898,9 +904,9 @@ This procedure is deprecated! Use <a href="libgimp-gimplayer.html#gimp-layer-set
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603398"></a><h3>
<a name="id2606652"></a><h3>
<a name="gimp-layer-get-apply-mask"></a>gimp_layer_get_apply_mask ()</h3>
<a class="indexterm" name="id2603407"></a><pre class="programlisting">gboolean gimp_layer_get_apply_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2606663"></a><pre class="programlisting">gboolean gimp_layer_get_apply_mask (gint32 layer_ID);</pre>
<p>
Get the apply mask setting of the specified layer.
</p>
@ -931,9 +937,9 @@ being composited with the layer's alpha channel.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603475"></a><h3>
<a name="id2606731"></a><h3>
<a name="gimp-layer-set-apply-mask"></a>gimp_layer_set_apply_mask ()</h3>
<a class="indexterm" name="id2603485"></a><pre class="programlisting">gboolean gimp_layer_set_apply_mask (gint32 layer_ID,
<a class="indexterm" name="id2606743"></a><pre class="programlisting">gboolean gimp_layer_set_apply_mask (gint32 layer_ID,
gboolean apply_mask);</pre>
<p>
Set the apply mask setting of the specified layer.
@ -972,9 +978,9 @@ error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603574"></a><h3>
<a name="id2606833"></a><h3>
<a name="gimp-layer-get-show-mask"></a>gimp_layer_get_show_mask ()</h3>
<a class="indexterm" name="id2603583"></a><pre class="programlisting">gboolean gimp_layer_get_show_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2606844"></a><pre class="programlisting">gboolean gimp_layer_get_show_mask (gint32 layer_ID);</pre>
<p>
Get the show mask setting of the specified layer.
</p>
@ -1006,9 +1012,9 @@ function returns an error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603652"></a><h3>
<a name="id2606913"></a><h3>
<a name="gimp-layer-set-show-mask"></a>gimp_layer_set_show_mask ()</h3>
<a class="indexterm" name="id2603661"></a><pre class="programlisting">gboolean gimp_layer_set_show_mask (gint32 layer_ID,
<a class="indexterm" name="id2606924"></a><pre class="programlisting">gboolean gimp_layer_set_show_mask (gint32 layer_ID,
gboolean show_mask);</pre>
<p>
Set the show mask setting of the specified layer.
@ -1047,9 +1053,9 @@ error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603750"></a><h3>
<a name="id2607013"></a><h3>
<a name="gimp-layer-get-edit-mask"></a>gimp_layer_get_edit_mask ()</h3>
<a class="indexterm" name="id2603759"></a><pre class="programlisting">gboolean gimp_layer_get_edit_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2607025"></a><pre class="programlisting">gboolean gimp_layer_get_edit_mask (gint32 layer_ID);</pre>
<p>
Get the edit mask setting of the specified layer.
</p>
@ -1080,9 +1086,9 @@ active, and not the layer.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603827"></a><h3>
<a name="id2607092"></a><h3>
<a name="gimp-layer-set-edit-mask"></a>gimp_layer_set_edit_mask ()</h3>
<a class="indexterm" name="id2603836"></a><pre class="programlisting">gboolean gimp_layer_set_edit_mask (gint32 layer_ID,
<a class="indexterm" name="id2607103"></a><pre class="programlisting">gboolean gimp_layer_set_edit_mask (gint32 layer_ID,
gboolean edit_mask);</pre>
<p>
Set the edit mask setting of the specified layer.
@ -1121,9 +1127,9 @@ procedure will return an error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603925"></a><h3>
<a name="id2607193"></a><h3>
<a name="gimp-layer-get-opacity"></a>gimp_layer_get_opacity ()</h3>
<a class="indexterm" name="id2603934"></a><pre class="programlisting">gdouble gimp_layer_get_opacity (gint32 layer_ID);</pre>
<a class="indexterm" name="id2607204"></a><pre class="programlisting">gdouble gimp_layer_get_opacity (gint32 layer_ID);</pre>
<p>
Get the opacity of the specified layer.
</p>
@ -1152,9 +1158,9 @@ This procedure returns the specified layer's opacity.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603999"></a><h3>
<a name="id2607269"></a><h3>
<a name="gimp-layer-set-opacity"></a>gimp_layer_set_opacity ()</h3>
<a class="indexterm" name="id2604008"></a><pre class="programlisting">gboolean gimp_layer_set_opacity (gint32 layer_ID,
<a class="indexterm" name="id2607280"></a><pre class="programlisting">gboolean gimp_layer_set_opacity (gint32 layer_ID,
gdouble opacity);</pre>
<p>
Set the opacity of the specified layer.
@ -1190,9 +1196,9 @@ This procedure sets the specified layer's opacity.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604094"></a><h3>
<a name="id2607366"></a><h3>
<a name="gimp-layer-get-mode"></a>gimp_layer_get_mode ()</h3>
<a class="indexterm" name="id2604104"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_layer_get_mode (gint32 layer_ID);</pre>
<a class="indexterm" name="id2607378"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_layer_get_mode (gint32 layer_ID);</pre>
<p>
Get the combination mode of the specified layer.
</p>
@ -1221,9 +1227,9 @@ This procedure returns the specified layer's combination mode.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604168"></a><h3>
<a name="id2607443"></a><h3>
<a name="gimp-layer-set-mode"></a>gimp_layer_set_mode ()</h3>
<a class="indexterm" name="id2604179"></a><pre class="programlisting">gboolean gimp_layer_set_mode (gint32 layer_ID,
<a class="indexterm" name="id2607455"></a><pre class="programlisting">gboolean gimp_layer_set_mode (gint32 layer_ID,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> mode);</pre>
<p>
Set the combination mode of the specified layer.
@ -1259,9 +1265,9 @@ This procedure sets the specified layer's combination mode.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604265"></a><h3>
<a name="id2607542"></a><h3>
<a name="gimp-layer-is-floating-sel"></a>gimp_layer_is_floating_sel ()</h3>
<a class="indexterm" name="id2604275"></a><pre class="programlisting">gboolean gimp_layer_is_floating_sel (gint32 layer_ID);</pre>
<a class="indexterm" name="id2607554"></a><pre class="programlisting">gboolean gimp_layer_is_floating_sel (gint32 layer_ID);</pre>
<p>
Is the specified layer a floating selection?
</p>
@ -1292,9 +1298,5 @@ to a specific drawable.</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimp-gimpimage.html"><b>&lt;&lt;&#160;gimpimage</b></a></td>
<td align="right"><a accesskey="n" href="libgimp-gimppaths.html"><b>gimppaths&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>