diff options
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimpregioniterator.html')
| -rw-r--r-- | devel-docs/libgimp/html/libgimp-gimpregioniterator.html | 330 |
1 files changed, 330 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpregioniterator.html b/devel-docs/libgimp/html/libgimp-gimpregioniterator.html new file mode 100644 index 0000000..ed68964 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpregioniterator.html @@ -0,0 +1,330 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimpregioniterator: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Library Reference Manual"> +<link rel="up" href="libgimp-image.html" title="Manipulating Images and 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.33.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimp-gimpregioniterator.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimp-gimppixelrgn.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpselection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimpregioniterator"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimp-gimpregioniterator.top_of_page"></a>gimpregioniterator</span></h2> +<p>gimpregioniterator — Functions to traverse a pixel regions.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimpregioniterator.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFunc1" title="GimpRgnFunc1 ()">*GimpRgnFunc1</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFunc2" title="GimpRgnFunc2 ()">*GimpRgnFunc2</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFuncSrc" title="GimpRgnFuncSrc ()">*GimpRgnFuncSrc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFuncDest" title="GimpRgnFuncDest ()">*GimpRgnFuncDest</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFuncSrcDest" title="GimpRgnFuncSrcDest ()">*GimpRgnFuncSrcDest</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="returnvalue">GimpRgnIterator</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-new" title="gimp_rgn_iterator_new ()">gimp_rgn_iterator_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-free" title="gimp_rgn_iterator_free ()">gimp_rgn_iterator_free</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-src" title="gimp_rgn_iterator_src ()">gimp_rgn_iterator_src</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-dest" title="gimp_rgn_iterator_dest ()">gimp_rgn_iterator_dest</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-src-dest" title="gimp_rgn_iterator_src_dest ()">gimp_rgn_iterator_src_dest</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterate1" title="gimp_rgn_iterate1 ()">gimp_rgn_iterate1</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterate2" title="gimp_rgn_iterate2 ()">gimp_rgn_iterate2</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpregioniterator.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator">GimpRgnIterator</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpregioniterator.description"></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"> +<a name="libgimp-gimpregioniterator.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="GimpRgnFunc1"></a><h3>GimpRgnFunc1 ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpRgnFunc1<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">guchar</span> *src</code></em>, + <em class="parameter"><code><span class="type">gint</span> bpp</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GimpRgnFunc2"></a><h3>GimpRgnFunc2 ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpRgnFunc2<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">guchar</span> *src</code></em>, + <em class="parameter"><code><span class="type">guchar</span> *dest</code></em>, + <em class="parameter"><code><span class="type">gint</span> bpp</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GimpRgnFuncSrc"></a><h3>GimpRgnFuncSrc ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpRgnFuncSrc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gint</span> x</code></em>, + <em class="parameter"><code><span class="type">gint</span> y</code></em>, + <em class="parameter"><code>const <span class="type">guchar</span> *src</code></em>, + <em class="parameter"><code><span class="type">gint</span> bpp</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GimpRgnFuncDest"></a><h3>GimpRgnFuncDest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpRgnFuncDest<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gint</span> x</code></em>, + <em class="parameter"><code><span class="type">gint</span> y</code></em>, + <em class="parameter"><code><span class="type">guchar</span> *dest</code></em>, + <em class="parameter"><code><span class="type">gint</span> bpp</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GimpRgnFuncSrcDest"></a><h3>GimpRgnFuncSrcDest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpRgnFuncSrcDest<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gint</span> x</code></em>, + <em class="parameter"><code><span class="type">gint</span> y</code></em>, + <em class="parameter"><code>const <span class="type">guchar</span> *src</code></em>, + <em class="parameter"><code><span class="type">guchar</span> *dest</code></em>, + <em class="parameter"><code><span class="type">gint</span> bpp</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-rgn-iterator-new"></a><h3>gimp_rgn_iterator_new ()</h3> +<pre class="programlisting"><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="returnvalue">GimpRgnIterator</span></a> * +gimp_rgn_iterator_new (<em class="parameter"><code><a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a> unused</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_rgn_iterator_new</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Creates a new <a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="type">GimpRgnIterator</span></a> for <em class="parameter"><code>drawable</code></em> +. The <a href="../html/libgimpbase-gimpbaseenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a> +parameter is ignored. Use <a class="link" href="libgimp-gimpregioniterator.html#gimp-rgn-iterator-free" title="gimp_rgn_iterator_free ()"><code class="function">gimp_rgn_iterator_free()</code></a> to free this +iterator.</p> +<div class="refsect3"> +<a name="gimp-rgn-iterator-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>drawable</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unused</p></td> +<td class="parameter_description"><p>ignored</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-rgn-iterator-new.returns"></a><h4>Returns</h4> +<p> a newly allocated <a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="type">GimpRgnIterator</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-rgn-iterator-free"></a><h3>gimp_rgn_iterator_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_rgn_iterator_free (<em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="type">GimpRgnIterator</span></a> *iter</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_rgn_iterator_free</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Frees the resources allocated for <em class="parameter"><code>iter</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-rgn-iterator-free.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>iter</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="type">GimpRgnIterator</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-rgn-iterator-src"></a><h3>gimp_rgn_iterator_src ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_rgn_iterator_src (<em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="type">GimpRgnIterator</span></a> *iter</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFuncSrc" title="GimpRgnFuncSrc ()"><span class="type">GimpRgnFuncSrc</span></a> func</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_rgn_iterator_src</code> is deprecated and should not be used in newly-written code.</p></div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-rgn-iterator-dest"></a><h3>gimp_rgn_iterator_dest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_rgn_iterator_dest (<em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="type">GimpRgnIterator</span></a> *iter</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFuncDest" title="GimpRgnFuncDest ()"><span class="type">GimpRgnFuncDest</span></a> func</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_rgn_iterator_dest</code> is deprecated and should not be used in newly-written code.</p></div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-rgn-iterator-src-dest"></a><h3>gimp_rgn_iterator_src_dest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_rgn_iterator_src_dest (<em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnIterator" title="GimpRgnIterator"><span class="type">GimpRgnIterator</span></a> *iter</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFuncSrcDest" title="GimpRgnFuncSrcDest ()"><span class="type">GimpRgnFuncSrcDest</span></a> func</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_rgn_iterator_src_dest</code> is deprecated and should not be used in newly-written code.</p></div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-rgn-iterate1"></a><h3>gimp_rgn_iterate1 ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_rgn_iterate1 (<em class="parameter"><code><a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a> unused</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFunc1" title="GimpRgnFunc1 ()"><span class="type">GimpRgnFunc1</span></a> func</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_rgn_iterate1</code> is deprecated and should not be used in newly-written code.</p></div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-rgn-iterate2"></a><h3>gimp_rgn_iterate2 ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_rgn_iterate2 (<em class="parameter"><code><a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpRunMode"><span class="type">GimpRunMode</span></a> unused</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimpregioniterator.html#GimpRgnFunc2" title="GimpRgnFunc2 ()"><span class="type">GimpRgnFunc2</span></a> func</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_rgn_iterate2</code> is deprecated and should not be used in newly-written code.</p></div> +</div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpregioniterator.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpRgnIterator"></a><h3>GimpRgnIterator</h3> +<pre class="programlisting">typedef struct _GimpRgnIterator GimpRgnIterator;</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |