Files
gimp/devel-docs/libgimp/html/libgimp-gimpregioniterator.html
2010-08-11 01:13:56 -04:00

178 lines
20 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpregioniterator</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-gimppixelrgn.html" title="gimppixelrgn"><link rel="next" href="libgimp-gimpselection.html" title="gimpselection"><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-gimppixelrgn.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-gimpselection.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-gimpregioniterator"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpregioniterator</span></h2><p>gimpregioniterator &#8212; Functions to traverse a pixel regions.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a>;
void (<a href="libgimp-gimpregioniterator.html#GimpRgnFunc1">*GimpRgnFunc1</a>) (const guchar *src,
gint bpp,
gpointer data);
void (<a href="libgimp-gimpregioniterator.html#GimpRgnFunc2">*GimpRgnFunc2</a>) (const guchar *src,
guchar *dest,
gint bpp,
gpointer data);
void (<a href="libgimp-gimpregioniterator.html#GimpRgnFuncSrc">*GimpRgnFuncSrc</a>) (gint x,
gint y,
const guchar *src,
gint bpp,
gpointer data);
void (<a href="libgimp-gimpregioniterator.html#GimpRgnFuncDest">*GimpRgnFuncDest</a>) (gint x,
gint y,
guchar *dest,
gint bpp,
gpointer data);
void (<a href="libgimp-gimpregioniterator.html#GimpRgnFuncSrcDest">*GimpRgnFuncSrcDest</a>) (gint x,
gint y,
const guchar *src,
guchar *dest,
gint bpp,
gpointer data);
<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a>* <a href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-new">gimp_rgn_iterator_new</a> (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> unused);
void <a href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-free">gimp_rgn_iterator_free</a> (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter);
void <a href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-src">gimp_rgn_iterator_src</a> (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter,
<a href="libgimp-gimpregioniterator.html#GimpRgnFuncSrc">GimpRgnFuncSrc</a> func,
gpointer data);
void <a href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-dest">gimp_rgn_iterator_dest</a> (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter,
<a href="libgimp-gimpregioniterator.html#GimpRgnFuncDest">GimpRgnFuncDest</a> func,
gpointer data);
void <a href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-src-dest">gimp_rgn_iterator_src_dest</a> (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter,
<a href="libgimp-gimpregioniterator.html#GimpRgnFuncSrcDest">GimpRgnFuncSrcDest</a> func,
gpointer data);
void <a href="libgimp-gimpregioniterator.html#gimp-rgn-iterate1">gimp_rgn_iterate1</a> (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> unused,
<a href="libgimp-gimpregioniterator.html#GimpRgnFunc1">GimpRgnFunc1</a> func,
gpointer data);
void <a href="libgimp-gimpregioniterator.html#gimp-rgn-iterate2">gimp_rgn_iterate2</a> (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> unused,
<a href="libgimp-gimpregioniterator.html#GimpRgnFunc2">GimpRgnFunc2</a> func,
gpointer data);
</pre></div><div class="refsect1" lang="en"><a name="id2633332"></a><h2>Description</h2><p>
The GimpRgnIterator functions provide a variety
of common ways to traverse a PixelRegion,
using a pre-defined function pointer per pixel.
</p></div><div class="refsect1" lang="en"><a name="id2633344"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2633349"></a><h3><a name="GimpRgnIterator"></a>GimpRgnIterator</h3><a class="indexterm" name="id2633358"></a><pre class="programlisting">typedef struct _GimpRgnIterator GimpRgnIterator;</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2633368"></a><h3><a name="GimpRgnFunc1"></a>GimpRgnFunc1 ()</h3><a class="indexterm" name="id2633377"></a><pre class="programlisting">void (*GimpRgnFunc1) (const guchar *src,
gint bpp,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>src</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>bpp</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2633445"></a><h3><a name="GimpRgnFunc2"></a>GimpRgnFunc2 ()</h3><a class="indexterm" name="id2633453"></a><pre class="programlisting">void (*GimpRgnFunc2) (const guchar *src,
guchar *dest,
gint bpp,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>src</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dest</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>bpp</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2616190"></a><h3><a name="GimpRgnFuncSrc"></a>GimpRgnFuncSrc ()</h3><a class="indexterm" name="id2616198"></a><pre class="programlisting">void (*GimpRgnFuncSrc) (gint x,
gint y,
const guchar *src,
gint bpp,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>x</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>src</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>bpp</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2616299"></a><h3><a name="GimpRgnFuncDest"></a>GimpRgnFuncDest ()</h3><a class="indexterm" name="id2616308"></a><pre class="programlisting">void (*GimpRgnFuncDest) (gint x,
gint y,
guchar *dest,
gint bpp,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>x</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dest</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>bpp</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2616409"></a><h3><a name="GimpRgnFuncSrcDest"></a>GimpRgnFuncSrcDest ()</h3><a class="indexterm" name="id2616417"></a><pre class="programlisting">void (*GimpRgnFuncSrcDest) (gint x,
gint y,
const guchar *src,
guchar *dest,
gint bpp,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>x</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>src</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dest</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>bpp</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637665"></a><h3><a name="gimp-rgn-iterator-new"></a>gimp_rgn_iterator_new ()</h3><a class="indexterm" name="id2637673"></a><pre class="programlisting"><a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a>* gimp_rgn_iterator_new (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> unused);</pre><p>
Creates a new <a href="libgimp-gimpregioniterator.html#GimpRgnIterator"><span class="type">GimpRgnIterator</span></a> for <i class="parameter"><tt>drawable</tt></i>. The <a href="libgimp-gimpenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a>
parameter is ignored.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>drawable</tt></i> :</span></td><td> a <a href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>unused</tt></i> :</span></td><td> ignored
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a newly allocated <a href="libgimp-gimpregioniterator.html#GimpRgnIterator"><span class="type">GimpRgnIterator</span></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637732"></a><h3><a name="gimp-rgn-iterator-free"></a>gimp_rgn_iterator_free ()</h3><a class="indexterm" name="id2637740"></a><pre class="programlisting">void gimp_rgn_iterator_free (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter);</pre><p>
Frees the resources allocated for <i class="parameter"><tt>iter</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>iter</tt></i> :</span></td><td> a <a href="libgimp-gimpregioniterator.html#GimpRgnIterator"><span class="type">GimpRgnIterator</span></a>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637783"></a><h3><a name="gimp-rgn-iterator-src"></a>gimp_rgn_iterator_src ()</h3><a class="indexterm" name="id2637790"></a><pre class="programlisting">void gimp_rgn_iterator_src (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter,
<a href="libgimp-gimpregioniterator.html#GimpRgnFuncSrc">GimpRgnFuncSrc</a> func,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>iter</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637853"></a><h3><a name="gimp-rgn-iterator-dest"></a>gimp_rgn_iterator_dest ()</h3><a class="indexterm" name="id2637860"></a><pre class="programlisting">void gimp_rgn_iterator_dest (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter,
<a href="libgimp-gimpregioniterator.html#GimpRgnFuncDest">GimpRgnFuncDest</a> func,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>iter</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637925"></a><h3><a name="gimp-rgn-iterator-src-dest"></a>gimp_rgn_iterator_src_dest ()</h3><a class="indexterm" name="id2637934"></a><pre class="programlisting">void gimp_rgn_iterator_src_dest (<a href="libgimp-gimpregioniterator.html#GimpRgnIterator">GimpRgnIterator</a> *iter,
<a href="libgimp-gimpregioniterator.html#GimpRgnFuncSrcDest">GimpRgnFuncSrcDest</a> func,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>iter</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2638001"></a><h3><a name="gimp-rgn-iterate1"></a>gimp_rgn_iterate1 ()</h3><a class="indexterm" name="id2638010"></a><pre class="programlisting">void gimp_rgn_iterate1 (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> unused,
<a href="libgimp-gimpregioniterator.html#GimpRgnFunc1">GimpRgnFunc1</a> func,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>drawable</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>unused</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2638094"></a><h3><a name="gimp-rgn-iterate2"></a>gimp_rgn_iterate2 ()</h3><a class="indexterm" name="id2638103"></a><pre class="programlisting">void gimp_rgn_iterate2 (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> unused,
<a href="libgimp-gimpregioniterator.html#GimpRgnFunc2">GimpRgnFunc2</a> func,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>drawable</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>unused</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</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-gimppixelrgn.html"><b>&lt;&lt; gimppixelrgn</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpselection.html"><b>gimpselection &gt;&gt;</b></a></td></tr></table></body></html>