143 lines
15 KiB
HTML
143 lines
15 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpchannel</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><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"><link rel="next" href="libgimp-gimpcolor.html" title="gimpcolor"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants"><link rel="part" href="libgimp.html" title="Part II. 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 all 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 III. GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></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"><td><a accesskey="p" href="libgimp-image.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-gimpcolor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></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><span class="refentrytitle">gimpchannel</span></h2><p>gimpchannel — Functions for manipulating channels.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||
|
||
|
||
|
||
gint32 <a href="libgimp-gimpchannel.html#gimp-channel-new">gimp_channel_new</a> (gint32 image_ID,
|
||
const gchar *name,
|
||
guint width,
|
||
guint height,
|
||
gdouble opacity,
|
||
const <a
|
||
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
||
>GimpRGB</a> *color);
|
||
gint32 <a href="libgimp-gimpchannel.html#gimp-channel-copy">gimp_channel_copy</a> (gint32 channel_ID);
|
||
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-get-show-masked">gimp_channel_get_show_masked</a> (gint32 channel_ID);
|
||
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-show-masked">gimp_channel_set_show_masked</a> (gint32 channel_ID,
|
||
gboolean show_masked);
|
||
gdouble <a href="libgimp-gimpchannel.html#gimp-channel-get-opacity">gimp_channel_get_opacity</a> (gint32 channel_ID);
|
||
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-opacity">gimp_channel_set_opacity</a> (gint32 channel_ID,
|
||
gdouble opacity);
|
||
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-get-color">gimp_channel_get_color</a> (gint32 channel_ID,
|
||
<a
|
||
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
||
>GimpRGB</a> *color);
|
||
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-set-color">gimp_channel_set_color</a> (gint32 channel_ID,
|
||
const <a
|
||
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
||
>GimpRGB</a> *color);
|
||
gboolean <a href="libgimp-gimpchannel.html#gimp-channel-combine-masks">gimp_channel_combine_masks</a> (gint32 channel1_ID,
|
||
gint32 channel2_ID,
|
||
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation,
|
||
gint offx,
|
||
gint offy);
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2584434"></a><h2>Description</h2><p>
|
||
Functions for manipulating channels.
|
||
</p></div><div class="refsect1" lang="en"><a name="id2584444"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2584449"></a><h3><a name="gimp-channel-new"></a>gimp_channel_new ()</h3><a class="indexterm" name="id2584457"></a><pre class="programlisting">gint32 gimp_channel_new (gint32 image_ID,
|
||
const gchar *name,
|
||
guint width,
|
||
guint height,
|
||
gdouble opacity,
|
||
const <a
|
||
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
||
>GimpRGB</a> *color);</pre><p>
|
||
Create a new channel.
|
||
</p><p>
|
||
This procedure creates a new channel with the specified width and
|
||
height. Name, opacity, and color are also supplied parameters. The
|
||
new channel still needs to be added to the image, as this is not
|
||
automatic. Add the new channel with the 'gimp_image_add_channel'
|
||
command. Other attributes such as channel show masked, should be set
|
||
with explicit procedure calls. The channel's contents are undefined
|
||
initially.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>image_ID</tt></i> :</span></td><td> The image to which to add the channel.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The channel name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i> :</span></td><td> The channel width.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i> :</span></td><td> The channel height.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td> The channel opacity.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color</tt></i> :</span></td><td> The channel compositing color.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The newly created channel.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2591180"></a><h3><a name="gimp-channel-copy"></a>gimp_channel_copy ()</h3><a class="indexterm" name="id2591189"></a><pre class="programlisting">gint32 gimp_channel_copy (gint32 channel_ID);</pre><p>
|
||
Copy a channel.
|
||
</p><p>
|
||
This procedure copies the specified channel and returns the copy.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel_ID</tt></i> :</span></td><td> The channel to copy.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The newly copied channel.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2591240"></a><h3><a name="gimp-channel-get-show-masked"></a>gimp_channel_get_show_masked ()</h3><a class="indexterm" name="id2591251"></a><pre class="programlisting">gboolean gimp_channel_get_show_masked (gint32 channel_ID);</pre><p>
|
||
Get the composite method of the specified channel.
|
||
</p><p>
|
||
This procedure returns the specified channel's composite method. If
|
||
it is non-zero, then the channel is composited with the image so
|
||
that masked regions are shown. Otherwise, selected regions are
|
||
shown.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel_ID</tt></i> :</span></td><td> The channel.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The channel composite method.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2591307"></a><h3><a name="gimp-channel-set-show-masked"></a>gimp_channel_set_show_masked ()</h3><a class="indexterm" name="id2591318"></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.
|
||
</p><p>
|
||
This procedure sets the specified channel's composite method. If it
|
||
is non-zero, then the channel is composited with the image so that
|
||
masked regions are shown. Otherwise, selected regions are shown.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel_ID</tt></i> :</span></td><td> The channel.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>show_masked</tt></i> :</span></td><td> The new channel composite method.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2589753"></a><h3><a name="gimp-channel-get-opacity"></a>gimp_channel_get_opacity ()</h3><a class="indexterm" name="id2589762"></a><pre class="programlisting">gdouble gimp_channel_get_opacity (gint32 channel_ID);</pre><p>
|
||
Get the opacity of the specified channel.
|
||
</p><p>
|
||
This procedure returns the specified channel's opacity.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel_ID</tt></i> :</span></td><td> The channel.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The channel opacity.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2589814"></a><h3><a name="gimp-channel-set-opacity"></a>gimp_channel_set_opacity ()</h3><a class="indexterm" name="id2589822"></a><pre class="programlisting">gboolean gimp_channel_set_opacity (gint32 channel_ID,
|
||
gdouble opacity);</pre><p>
|
||
Set the opacity of the specified channel.
|
||
</p><p>
|
||
This procedure sets the specified channel's opacity.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel_ID</tt></i> :</span></td><td> The channel.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td> The new channel opacity.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2589892"></a><h3><a name="gimp-channel-get-color"></a>gimp_channel_get_color ()</h3><a class="indexterm" name="id2589900"></a><pre class="programlisting">gboolean gimp_channel_get_color (gint32 channel_ID,
|
||
<a
|
||
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
||
>GimpRGB</a> *color);</pre><p>
|
||
Get the compositing color of the specified channel.
|
||
</p><p>
|
||
This procedure returns the specified channel's compositing color.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel_ID</tt></i> :</span></td><td> The channel.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color</tt></i> :</span></td><td> The channel compositing color.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2589970"></a><h3><a name="gimp-channel-set-color"></a>gimp_channel_set_color ()</h3><a class="indexterm" name="id2589979"></a><pre class="programlisting">gboolean gimp_channel_set_color (gint32 channel_ID,
|
||
const <a
|
||
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
||
>GimpRGB</a> *color);</pre><p>
|
||
Set the compositing color of the specified channel.
|
||
</p><p>
|
||
This procedure sets the specified channel's compositing color.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel_ID</tt></i> :</span></td><td> The channel.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color</tt></i> :</span></td><td> The new channel compositing color.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2595067"></a><h3><a name="gimp-channel-combine-masks"></a>gimp_channel_combine_masks ()</h3><a class="indexterm" name="id2595076"></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,
|
||
gint offy);</pre><p>
|
||
Combine two channel masks.
|
||
</p><p>
|
||
This procedure combines two channel masks. The result is stored in
|
||
the first channel.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel1_ID</tt></i> :</span></td><td> The channel1.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>channel2_ID</tt></i> :</span></td><td> The channel2.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>operation</tt></i> :</span></td><td> The selection operation.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>offx</tt></i> :</span></td><td> x offset between upper left corner of channels: (second - first).
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>offy</tt></i> :</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> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></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-image.html"><b><< Manupulating Images and all their Properties</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpcolor.html"><b>gimpcolor >></b></a></td></tr></table></body></html>
|