Imported Upstream version 2.2.14

This commit is contained in:
Ari Pollak
2010-08-11 01:17:12 -04:00
parent 70ad8213cf
commit a2f097051e
490 changed files with 35329 additions and 58398 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpchannel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.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-image.html" title="Manupulating Images and all their Properties">
@ -28,16 +28,16 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpcolor.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="#id2562582" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2574210" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2545541" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2600904" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpchannel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2562582"></a><span class="refentrytitle">gimpchannel</span>
<a name="id2574210"></a><span class="refentrytitle">gimpchannel</span>
</h2>
<p>gimpchannel &#8212; Functions for manipulating channels.</p>
</td>
@ -80,17 +80,17 @@ gboolean <a href="libgimp-gimpchannel.html#gimp-channel-combine-masks">gimp_c
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2545541"></a><h2>Description</h2>
<a name="id2600904"></a><h2>Description</h2>
<p>
Functions for manipulating channels.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2545556"></a><h2>Details</h2>
<a name="id2600919"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2545567"></a><h3>
<a name="id2600930"></a><h3>
<a name="gimp-channel-new"></a>gimp_channel_new ()</h3>
<a class="indexterm" name="id2545579"></a><pre class="programlisting">gint32 gimp_channel_new (gint32 image_ID,
<a class="indexterm" name="id2600942"></a><pre class="programlisting">gint32 gimp_channel_new (gint32 image_ID,
const gchar *name,
guint width,
guint height,
@ -116,44 +116,37 @@ initially.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image to which to add the channel.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The channel name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The channel width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The channel height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td> The channel opacity.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td> The channel compositing color.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The newly created channel.
</td>
</tr>
@ -162,9 +155,9 @@ initially.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575443"></a><h3>
<a name="id2608453"></a><h3>
<a name="gimp-channel-copy"></a>gimp_channel_copy ()</h3>
<a class="indexterm" name="id2575455"></a><pre class="programlisting">gint32 gimp_channel_copy (gint32 channel_ID);</pre>
<a class="indexterm" name="id2608465"></a><pre class="programlisting">gint32 gimp_channel_copy (gint32 channel_ID);</pre>
<p>
Copy a channel.
</p>
@ -177,14 +170,12 @@ This procedure copies the specified channel and returns the copy.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td> The channel to copy.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The newly copied channel.
</td>
</tr>
@ -193,9 +184,9 @@ This procedure copies the specified channel and returns the copy.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575519"></a><h3>
<a name="id2608529"></a><h3>
<a name="gimp-channel-get-show-masked"></a>gimp_channel_get_show_masked ()</h3>
<a class="indexterm" name="id2575530"></a><pre class="programlisting">gboolean gimp_channel_get_show_masked (gint32 channel_ID);</pre>
<a class="indexterm" name="id2608540"></a><pre class="programlisting">gboolean gimp_channel_get_show_masked (gint32 channel_ID);</pre>
<p>
Get the composite method of the specified channel.
</p>
@ -211,14 +202,12 @@ shown.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td> The channel.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The channel composite method.
</td>
</tr>
@ -227,9 +216,9 @@ shown.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567759"></a><h3>
<a name="id2567122"></a><h3>
<a name="gimp-channel-set-show-masked"></a>gimp_channel_set_show_masked ()</h3>
<a class="indexterm" name="id2567770"></a><pre class="programlisting">gboolean gimp_channel_set_show_masked (gint32 channel_ID,
<a class="indexterm" name="id2567135"></a><pre class="programlisting">gboolean gimp_channel_set_show_masked (gint32 channel_ID,
gboolean show_masked);</pre>
<p>
Set the composite method of the specified channel.
@ -245,20 +234,17 @@ masked regions are shown. Otherwise, selected regions are shown.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td> The channel.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>show_masked</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>show_masked</code></em>&#160;:</span></td>
<td> The new channel composite method.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -267,9 +253,9 @@ masked regions are shown. Otherwise, selected regions are shown.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567859"></a><h3>
<a name="id2567225"></a><h3>
<a name="gimp-channel-get-opacity"></a>gimp_channel_get_opacity ()</h3>
<a class="indexterm" name="id2567870"></a><pre class="programlisting">gdouble gimp_channel_get_opacity (gint32 channel_ID);</pre>
<a class="indexterm" name="id2567236"></a><pre class="programlisting">gdouble gimp_channel_get_opacity (gint32 channel_ID);</pre>
<p>
Get the opacity of the specified channel.
</p>
@ -282,14 +268,12 @@ This procedure returns the specified channel's opacity.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td> The channel.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The channel opacity.
</td>
</tr>
@ -298,9 +282,9 @@ This procedure returns the specified channel's opacity.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567935"></a><h3>
<a name="id2567301"></a><h3>
<a name="gimp-channel-set-opacity"></a>gimp_channel_set_opacity ()</h3>
<a class="indexterm" name="id2567946"></a><pre class="programlisting">gboolean gimp_channel_set_opacity (gint32 channel_ID,
<a class="indexterm" name="id2567312"></a><pre class="programlisting">gboolean gimp_channel_set_opacity (gint32 channel_ID,
gdouble opacity);</pre>
<p>
Set the opacity of the specified channel.
@ -314,20 +298,17 @@ This procedure sets the specified channel's opacity.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td> The channel.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td> The new channel opacity.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -336,9 +317,9 @@ This procedure sets the specified channel's opacity.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2579003"></a><h3>
<a name="id2611977"></a><h3>
<a name="gimp-channel-get-color"></a>gimp_channel_get_color ()</h3>
<a class="indexterm" name="id2579013"></a><pre class="programlisting">gboolean gimp_channel_get_color (gint32 channel_ID,
<a class="indexterm" name="id2611987"></a><pre class="programlisting">gboolean gimp_channel_get_color (gint32 channel_ID,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre>
@ -354,20 +335,17 @@ This procedure returns the specified channel's compositing color.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td> The channel.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td> The channel compositing color.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -376,9 +354,9 @@ This procedure returns the specified channel's compositing color.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2579091"></a><h3>
<a name="id2612066"></a><h3>
<a name="gimp-channel-set-color"></a>gimp_channel_set_color ()</h3>
<a class="indexterm" name="id2579101"></a><pre class="programlisting">gboolean gimp_channel_set_color (gint32 channel_ID,
<a class="indexterm" name="id2612077"></a><pre class="programlisting">gboolean gimp_channel_set_color (gint32 channel_ID,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre>
@ -394,20 +372,17 @@ This procedure sets the specified channel's compositing color.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
<td> The channel.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td> The new channel compositing color.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -416,9 +391,9 @@ This procedure sets the specified channel's compositing color.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2579187"></a><h3>
<a name="id2612165"></a><h3>
<a name="gimp-channel-combine-masks"></a>gimp_channel_combine_masks ()</h3>
<a class="indexterm" name="id2579199"></a><pre class="programlisting">gboolean gimp_channel_combine_masks (gint32 channel1_ID,
<a class="indexterm" name="id2612177"></a><pre class="programlisting">gboolean gimp_channel_combine_masks (gint32 channel1_ID,
gint32 channel2_ID,
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation,
gint offx,
@ -436,38 +411,32 @@ the first channel.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel1_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel1_ID</code></em>&#160;:</span></td>
<td> The channel1.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>channel2_ID</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>channel2_ID</code></em>&#160;:</span></td>
<td> The channel2.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>operation</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>operation</code></em>&#160;:</span></td>
<td> The selection operation.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
<td> x offset between upper left corner of channels: (second - first).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
<td> y offset between upper left corner of channels: (second - first).
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>