callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.3.12

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:20:17 -04:00
parent 79785b4adf
commit a028e0b309
1105 changed files with 114178 additions and 65152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
devel-docs/libgimp/html/libgimp-gimplayer.html
View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimplayer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimpimage.html" title="gimpimage">
@ -32,16 +32,16 @@
<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="#id2595010" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2564207" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2639258" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2630713" 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="id2595010"></a><span class="refentrytitle">gimplayer</span>
<a name="id2564207"></a><span class="refentrytitle">gimplayer</span>
</h2>
<p>gimplayer &#8212; Operations on a single layer.</p>
</td>
@ -117,18 +117,18 @@ gboolean <a href="libgimp-gimplayer.html#gimp-layer-is-floating-sel">gimp_lay
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2639258"></a><h2>Description</h2>
<a name="id2630713"></a><h2>Description</h2>
<p>
Operations on a single layer.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2639273"></a><h2>Details</h2>
<a name="id2630728"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2639284"></a><h3>
<a name="id2630739"></a><h3>
<a name="gimp-layer-new"></a>gimp_layer_new ()</h3>
<a class="indexterm" name="id2639296"></a><pre class="programlisting">gint32 gimp_layer_new (gint32 image_ID,
<a class="indexterm" name="id2630752"></a><pre class="programlisting">gint32 gimp_layer_new (gint32 image_ID,
const gchar *name,
gint width,
gint height,
@ -206,9 +206,9 @@ should be set with explicit procedure calls.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2643593"></a><h3>
<a name="id2636144"></a><h3>
<a name="gimp-layer-copy"></a>gimp_layer_copy ()</h3>
<a class="indexterm" name="id2643605"></a><pre class="programlisting">gint32 gimp_layer_copy (gint32 layer_ID);</pre>
<a class="indexterm" name="id2636156"></a><pre class="programlisting">gint32 gimp_layer_copy (gint32 layer_ID);</pre>
<p>
Copy a layer.
</p>
@ -241,9 +241,9 @@ before you add the new layer to the image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2643673"></a><h3>
<a name="id2636224"></a><h3>
<a name="gimp-layer-scale"></a>gimp_layer_scale ()</h3>
<a class="indexterm" name="id2643686"></a><pre class="programlisting">gboolean gimp_layer_scale (gint32 layer_ID,
<a class="indexterm" name="id2636237"></a><pre class="programlisting">gboolean gimp_layer_scale (gint32 layer_ID,
gint new_width,
gint new_height,
gboolean local_origin);</pre>
@ -252,7 +252,7 @@ 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
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>
@ -297,9 +297,9 @@ to an image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2643818"></a><h3>
<a name="id2636369"></a><h3>
<a name="gimp-layer-resize"></a>gimp_layer_resize ()</h3>
<a class="indexterm" name="id2643830"></a><pre class="programlisting">gboolean gimp_layer_resize (gint32 layer_ID,
<a class="indexterm" name="id2636381"></a><pre class="programlisting">gboolean gimp_layer_resize (gint32 layer_ID,
gint new_width,
gint new_height,
gint offx,
@ -359,9 +359,9 @@ operation only works if the layer has been added to an image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2643985"></a><h3>
<a name="id2636536"></a><h3>
<a name="gimp-layer-resize-to-image-size"></a>gimp_layer_resize_to_image_size ()</h3>
<a class="indexterm" name="id2643996"></a><pre class="programlisting">gboolean gimp_layer_resize_to_image_size (gint32 layer_ID);</pre>
<a class="indexterm" name="id2636547"></a><pre class="programlisting">gboolean gimp_layer_resize_to_image_size (gint32 layer_ID);</pre>
<p>
Resize a layer to the image size.
</p>
@ -391,9 +391,9 @@ are equal to the width and height of its image container.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644061"></a><h3>
<a name="id2636611"></a><h3>
<a name="gimp-layer-translate"></a>gimp_layer_translate ()</h3>
<a class="indexterm" name="id2644072"></a><pre class="programlisting">gboolean gimp_layer_translate (gint32 layer_ID,
<a class="indexterm" name="id2636623"></a><pre class="programlisting">gboolean gimp_layer_translate (gint32 layer_ID,
gint offx,
gint offy);</pre>
<p>
@ -441,9 +441,9 @@ the specified offsets.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644183"></a><h3>
<a name="id2636734"></a><h3>
<a name="gimp-layer-add-alpha"></a>gimp_layer_add_alpha ()</h3>
<a class="indexterm" name="id2644194"></a><pre class="programlisting">gboolean gimp_layer_add_alpha (gint32 layer_ID);</pre>
<a class="indexterm" name="id2636745"></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>
@ -477,9 +477,9 @@ and INDEXED to INDEXEDA.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644264"></a><h3>
<a name="id2636815"></a><h3>
<a name="gimp-layer-set-offsets"></a>gimp_layer_set_offsets ()</h3>
<a class="indexterm" name="id2644275"></a><pre class="programlisting">gboolean gimp_layer_set_offsets (gint32 layer_ID,
<a class="indexterm" name="id2636826"></a><pre class="programlisting">gboolean gimp_layer_set_offsets (gint32 layer_ID,
gint offx,
gint offy);</pre>
<p>
@ -524,9 +524,9 @@ operation is valid only on layers which have been added to an image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644383"></a><h3>
<a name="id2636934"></a><h3>
<a name="gimp-layer-create-mask"></a>gimp_layer_create_mask ()</h3>
<a class="indexterm" name="id2644394"></a><pre class="programlisting">gint32 gimp_layer_create_mask (gint32 layer_ID,
<a class="indexterm" name="id2636945"></a><pre class="programlisting">gint32 gimp_layer_create_mask (gint32 layer_ID,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpAddMaskType"
>GimpAddMaskType</a> mask_type);</pre>
@ -573,9 +573,9 @@ to <a href="libgimp-gimplayer.html#gimp-layer-add-mask"><code class="function">g
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644498"></a><h3>
<a name="id2637050"></a><h3>
<a name="gimp-layer-from-mask"></a>gimp_layer_from_mask ()</h3>
<a class="indexterm" name="id2644512"></a><pre class="programlisting">gint32 gimp_layer_from_mask (gint32 mask_ID);</pre>
<a class="indexterm" name="id2637063"></a><pre class="programlisting">gint32 gimp_layer_from_mask (gint32 mask_ID);</pre>
<p>
Get the specified mask's layer.
</p>
@ -608,9 +608,9 @@ exists.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644580"></a><h3>
<a name="id2637133"></a><h3>
<a name="gimp-layer-get-mask"></a>gimp_layer_get_mask ()</h3>
<a class="indexterm" name="id2644592"></a><pre class="programlisting">gint32 gimp_layer_get_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2637145"></a><pre class="programlisting">gint32 gimp_layer_get_mask (gint32 layer_ID);</pre>
<p>
Get the specified layer's mask if it exists.
</p>
@ -640,9 +640,9 @@ exists.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644658"></a><h3>
<a name="id2637211"></a><h3>
<a name="gimp-layer-add-mask"></a>gimp_layer_add_mask ()</h3>
<a class="indexterm" name="id2644670"></a><pre class="programlisting">gboolean gimp_layer_add_mask (gint32 layer_ID,
<a class="indexterm" name="id2637223"></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.
@ -683,9 +683,9 @@ have been created for use with the specified image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644761"></a><h3>
<a name="id2637314"></a><h3>
<a name="gimp-layer-remove-mask"></a>gimp_layer_remove_mask ()</h3>
<a class="indexterm" name="id2644772"></a><pre class="programlisting">gboolean gimp_layer_remove_mask (gint32 layer_ID,
<a class="indexterm" name="id2637325"></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.
@ -722,9 +722,9 @@ the mask doesn't exist, an error is returned.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644860"></a><h3>
<a name="id2637414"></a><h3>
<a name="gimp-layer-new-from-drawable"></a>gimp_layer_new_from_drawable ()</h3>
<a class="indexterm" name="id2644872"></a><pre class="programlisting">gint32 gimp_layer_new_from_drawable (gint32 drawable_ID,
<a class="indexterm" name="id2637425"></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.
@ -764,9 +764,9 @@ modes, and offsets should be set with explicit procedure calls.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644972"></a><h3>
<a name="id2637526"></a><h3>
<a name="gimp-layer-get-lock-alpha"></a>gimp_layer_get_lock_alpha ()</h3>
<a class="indexterm" name="id2644984"></a><pre class="programlisting">gboolean gimp_layer_get_lock_alpha (gint32 layer_ID);</pre>
<a class="indexterm" name="id2637538"></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>
@ -796,9 +796,9 @@ setting.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645050"></a><h3>
<a name="id2637604"></a><h3>
<a name="gimp-layer-set-lock-alpha"></a>gimp_layer_set_lock_alpha ()</h3>
<a class="indexterm" name="id2645062"></a><pre class="programlisting">gboolean gimp_layer_set_lock_alpha (gint32 layer_ID,
<a class="indexterm" name="id2637616"></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.
@ -835,9 +835,9 @@ setting.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645150"></a><h3>
<a name="id2637704"></a><h3>
<a name="gimp-layer-get-preserve-trans"></a>gimp_layer_get_preserve_trans ()</h3>
<a class="indexterm" name="id2645165"></a><pre class="programlisting">gboolean gimp_layer_get_preserve_trans (gint32 layer_ID);</pre>
<a class="indexterm" name="id2637720"></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>
@ -867,9 +867,9 @@ This procedure is deprecated! Use <a href="libgimp-gimplayer.html#gimp-layer-get
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645249"></a><h3>
<a name="id2637803"></a><h3>
<a name="gimp-layer-set-preserve-trans"></a>gimp_layer_set_preserve_trans ()</h3>
<a class="indexterm" name="id2645264"></a><pre class="programlisting">gboolean gimp_layer_set_preserve_trans (gint32 layer_ID,
<a class="indexterm" name="id2637819"></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>
@ -906,9 +906,9 @@ This procedure is deprecated! Use <a href="libgimp-gimplayer.html#gimp-layer-set
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645369"></a><h3>
<a name="id2637924"></a><h3>
<a name="gimp-layer-get-apply-mask"></a>gimp_layer_get_apply_mask ()</h3>
<a class="indexterm" name="id2645381"></a><pre class="programlisting">gboolean gimp_layer_get_apply_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2637936"></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>
@ -939,9 +939,9 @@ being composited with the layer's alpha channel.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645449"></a><h3>
<a name="id2638003"></a><h3>
<a name="gimp-layer-set-apply-mask"></a>gimp_layer_set_apply_mask ()</h3>
<a class="indexterm" name="id2645461"></a><pre class="programlisting">gboolean gimp_layer_set_apply_mask (gint32 layer_ID,
<a class="indexterm" name="id2638015"></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.
@ -980,9 +980,9 @@ error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645550"></a><h3>
<a name="id2638105"></a><h3>
<a name="gimp-layer-get-show-mask"></a>gimp_layer_get_show_mask ()</h3>
<a class="indexterm" name="id2645562"></a><pre class="programlisting">gboolean gimp_layer_get_show_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2638116"></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>
@ -1014,9 +1014,9 @@ function returns an error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645630"></a><h3>
<a name="id2638185"></a><h3>
<a name="gimp-layer-set-show-mask"></a>gimp_layer_set_show_mask ()</h3>
<a class="indexterm" name="id2645641"></a><pre class="programlisting">gboolean gimp_layer_set_show_mask (gint32 layer_ID,
<a class="indexterm" name="id2638196"></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.
@ -1055,9 +1055,9 @@ error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645731"></a><h3>
<a name="id2638286"></a><h3>
<a name="gimp-layer-get-edit-mask"></a>gimp_layer_get_edit_mask ()</h3>
<a class="indexterm" name="id2645742"></a><pre class="programlisting">gboolean gimp_layer_get_edit_mask (gint32 layer_ID);</pre>
<a class="indexterm" name="id2638297"></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>
@ -1088,9 +1088,9 @@ active, and not the layer.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645810"></a><h3>
<a name="id2638364"></a><h3>
<a name="gimp-layer-set-edit-mask"></a>gimp_layer_set_edit_mask ()</h3>
<a class="indexterm" name="id2645821"></a><pre class="programlisting">gboolean gimp_layer_set_edit_mask (gint32 layer_ID,
<a class="indexterm" name="id2638375"></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.
@ -1129,9 +1129,9 @@ procedure will return an error.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645911"></a><h3>
<a name="id2638465"></a><h3>
<a name="gimp-layer-get-opacity"></a>gimp_layer_get_opacity ()</h3>
<a class="indexterm" name="id2645922"></a><pre class="programlisting">gdouble gimp_layer_get_opacity (gint32 layer_ID);</pre>
<a class="indexterm" name="id2638476"></a><pre class="programlisting">gdouble gimp_layer_get_opacity (gint32 layer_ID);</pre>
<p>
Get the opacity of the specified layer.
</p>
@ -1160,9 +1160,9 @@ This procedure returns the specified layer's opacity.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645987"></a><h3>
<a name="id2638541"></a><h3>
<a name="gimp-layer-set-opacity"></a>gimp_layer_set_opacity ()</h3>
<a class="indexterm" name="id2645998"></a><pre class="programlisting">gboolean gimp_layer_set_opacity (gint32 layer_ID,
<a class="indexterm" name="id2638552"></a><pre class="programlisting">gboolean gimp_layer_set_opacity (gint32 layer_ID,
gdouble opacity);</pre>
<p>
Set the opacity of the specified layer.
@ -1198,9 +1198,9 @@ This procedure sets the specified layer's opacity.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2646084"></a><h3>
<a name="id2638638"></a><h3>
<a name="gimp-layer-get-mode"></a>gimp_layer_get_mode ()</h3>
<a class="indexterm" name="id2646096"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_layer_get_mode (gint32 layer_ID);</pre>
<a class="indexterm" name="id2638651"></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>
@ -1229,9 +1229,9 @@ This procedure returns the specified layer's combination mode.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2646160"></a><h3>
<a name="id2638715"></a><h3>
<a name="gimp-layer-set-mode"></a>gimp_layer_set_mode ()</h3>
<a class="indexterm" name="id2646173"></a><pre class="programlisting">gboolean gimp_layer_set_mode (gint32 layer_ID,
<a class="indexterm" name="id2638727"></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.
@ -1267,9 +1267,9 @@ This procedure sets the specified layer's combination mode.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2646259"></a><h3>
<a name="id2638814"></a><h3>
<a name="gimp-layer-is-floating-sel"></a>gimp_layer_is_floating_sel ()</h3>
<a class="indexterm" name="id2646271"></a><pre class="programlisting">gboolean gimp_layer_is_floating_sel (gint32 layer_ID);</pre>
<a class="indexterm" name="id2638826"></a><pre class="programlisting">gboolean gimp_layer_is_floating_sel (gint32 layer_ID);</pre>
<p>
Is the specified layer a floating selection?
</p>