376 lines
20 KiB
XML
376 lines
20 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="libgimp-gimpregioniterator">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">gimpregioniterator</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpregioniterator</refname>
|
|
<refpurpose>Functions to traverse a pixel regions.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GimpRgnIterator">GimpRgnIterator</link>;
|
|
<link linkend="void">void</link> (<link linkend="GimpRgnFunc1">*GimpRgnFunc1</link>) (const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> (<link linkend="GimpRgnFunc2">*GimpRgnFunc2</link>) (const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="guchar">guchar</link> *dest,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> (<link linkend="GimpRgnFuncSrc">*GimpRgnFuncSrc</link>) (<link linkend="gint">gint</link> x,
|
|
<link linkend="gint">gint</link> y,
|
|
const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> (<link linkend="GimpRgnFuncDest">*GimpRgnFuncDest</link>) (<link linkend="gint">gint</link> x,
|
|
<link linkend="gint">gint</link> y,
|
|
<link linkend="guchar">guchar</link> *dest,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> (<link linkend="GimpRgnFuncSrcDest">*GimpRgnFuncSrcDest</link>) (<link linkend="gint">gint</link> x,
|
|
<link linkend="gint">gint</link> y,
|
|
const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="guchar">guchar</link> *dest,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="GimpRgnIterator">GimpRgnIterator</link>* <link linkend="gimp-rgn-iterator-new">gimp_rgn_iterator_new</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="GimpRunMode">GimpRunMode</link> unused);
|
|
<link linkend="void">void</link> <link linkend="gimp-rgn-iterator-free">gimp_rgn_iterator_free</link> (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter);
|
|
<link linkend="void">void</link> <link linkend="gimp-rgn-iterator-src">gimp_rgn_iterator_src</link> (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter,
|
|
<link linkend="GimpRgnFuncSrc">GimpRgnFuncSrc</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> <link linkend="gimp-rgn-iterator-dest">gimp_rgn_iterator_dest</link> (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter,
|
|
<link linkend="GimpRgnFuncDest">GimpRgnFuncDest</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> <link linkend="gimp-rgn-iterator-src-dest">gimp_rgn_iterator_src_dest</link> (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter,
|
|
<link linkend="GimpRgnFuncSrcDest">GimpRgnFuncSrcDest</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> <link linkend="gimp-rgn-iterate1">gimp_rgn_iterate1</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="GimpRunMode">GimpRunMode</link> unused,
|
|
<link linkend="GimpRgnFunc1">GimpRgnFunc1</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> <link linkend="gimp-rgn-iterate2">gimp_rgn_iterate2</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="GimpRunMode">GimpRunMode</link> unused,
|
|
<link linkend="GimpRgnFunc2">GimpRgnFunc2</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
The GimpRgnIterator functions provide a variety
|
|
of common ways to traverse a PixelRegion,
|
|
using a pre-defined function pointer per pixel.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpRgnIterator" role="struct"/>GimpRgnIterator</title>
|
|
<indexterm><primary>GimpRgnIterator</primary></indexterm><programlisting>typedef struct _GimpRgnIterator GimpRgnIterator;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpRgnFunc1" role="function"/>GimpRgnFunc1 ()</title>
|
|
<indexterm><primary>GimpRgnFunc1</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRgnFunc1) (const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>src</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bpp</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpRgnFunc2" role="function"/>GimpRgnFunc2 ()</title>
|
|
<indexterm><primary>GimpRgnFunc2</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRgnFunc2) (const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="guchar">guchar</link> *dest,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>src</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dest</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bpp</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpRgnFuncSrc" role="function"/>GimpRgnFuncSrc ()</title>
|
|
<indexterm><primary>GimpRgnFuncSrc</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRgnFuncSrc) (<link linkend="gint">gint</link> x,
|
|
<link linkend="gint">gint</link> y,
|
|
const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>x</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>y</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>src</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bpp</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpRgnFuncDest" role="function"/>GimpRgnFuncDest ()</title>
|
|
<indexterm><primary>GimpRgnFuncDest</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRgnFuncDest) (<link linkend="gint">gint</link> x,
|
|
<link linkend="gint">gint</link> y,
|
|
<link linkend="guchar">guchar</link> *dest,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>x</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>y</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dest</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bpp</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpRgnFuncSrcDest" role="function"/>GimpRgnFuncSrcDest ()</title>
|
|
<indexterm><primary>GimpRgnFuncSrcDest</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRgnFuncSrcDest) (<link linkend="gint">gint</link> x,
|
|
<link linkend="gint">gint</link> y,
|
|
const <link linkend="guchar">guchar</link> *src,
|
|
<link linkend="guchar">guchar</link> *dest,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>x</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>y</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>src</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dest</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bpp</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-rgn-iterator-new" role="function"/>gimp_rgn_iterator_new ()</title>
|
|
<indexterm><primary>gimp_rgn_iterator_new</primary></indexterm><programlisting><link linkend="GimpRgnIterator">GimpRgnIterator</link>* gimp_rgn_iterator_new (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="GimpRunMode">GimpRunMode</link> unused);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpRgnIterator"><type>GimpRgnIterator</type></link> for <parameter>drawable</parameter>. The <link linkend="GimpRunMode"><type>GimpRunMode</type></link>
|
|
parameter is ignored. Use <link linkend="gimp-rgn-iterator-free"><function>gimp_rgn_iterator_free()</function></link> to free thsi
|
|
iterator.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>drawable</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpDrawable"><type>GimpDrawable</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>unused</parameter> :</term>
|
|
<listitem><simpara> ignored
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="GimpRgnIterator"><type>GimpRgnIterator</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-rgn-iterator-free" role="function"/>gimp_rgn_iterator_free ()</title>
|
|
<indexterm><primary>gimp_rgn_iterator_free</primary></indexterm><programlisting><link linkend="void">void</link> gimp_rgn_iterator_free (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter);</programlisting>
|
|
<para>
|
|
Frees the resources allocated for <parameter>iter</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>iter</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpRgnIterator"><type>GimpRgnIterator</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-rgn-iterator-src" role="function"/>gimp_rgn_iterator_src ()</title>
|
|
<indexterm><primary>gimp_rgn_iterator_src</primary></indexterm><programlisting><link linkend="void">void</link> gimp_rgn_iterator_src (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter,
|
|
<link linkend="GimpRgnFuncSrc">GimpRgnFuncSrc</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>iter</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-rgn-iterator-dest" role="function"/>gimp_rgn_iterator_dest ()</title>
|
|
<indexterm><primary>gimp_rgn_iterator_dest</primary></indexterm><programlisting><link linkend="void">void</link> gimp_rgn_iterator_dest (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter,
|
|
<link linkend="GimpRgnFuncDest">GimpRgnFuncDest</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>iter</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-rgn-iterator-src-dest" role="function"/>gimp_rgn_iterator_src_dest ()</title>
|
|
<indexterm><primary>gimp_rgn_iterator_src_dest</primary></indexterm><programlisting><link linkend="void">void</link> gimp_rgn_iterator_src_dest (<link linkend="GimpRgnIterator">GimpRgnIterator</link> *iter,
|
|
<link linkend="GimpRgnFuncSrcDest">GimpRgnFuncSrcDest</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>iter</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-rgn-iterate1" role="function"/>gimp_rgn_iterate1 ()</title>
|
|
<indexterm><primary>gimp_rgn_iterate1</primary></indexterm><programlisting><link linkend="void">void</link> gimp_rgn_iterate1 (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="GimpRunMode">GimpRunMode</link> unused,
|
|
<link linkend="GimpRgnFunc1">GimpRgnFunc1</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>drawable</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>unused</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-rgn-iterate2" role="function"/>gimp_rgn_iterate2 ()</title>
|
|
<indexterm><primary>gimp_rgn_iterate2</primary></indexterm><programlisting><link linkend="void">void</link> gimp_rgn_iterate2 (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="GimpRunMode">GimpRunMode</link> unused,
|
|
<link linkend="GimpRgnFunc2">GimpRgnFunc2</link> func,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>drawable</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>unused</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|