callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.4.0~rc2

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
devel-docs/libgimp/html/libgimp-gimppixelfetcher.html
View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppixelfetcher</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="prev" href="libgimp-gimppaths.html" title="gimppaths">
@ -31,16 +31,16 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimppixelrgn.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="#id2566112" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2607237" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2592159" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2625922" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppixelfetcher"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2566112"></a><span class="refentrytitle">gimppixelfetcher</span>
<a name="id2607237"></a><span class="refentrytitle">gimppixelfetcher</span>
</h2>
<p>gimppixelfetcher &#8212; Functions for operating on pixel regions.</p>
</td>
@ -52,43 +52,29 @@
enum <a href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</a>;
<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a>;
<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a>* <a href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-new">gimp_pixel_fetcher_new</a> (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> shadow);
void <a href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-set-edge-mode">gimp_pixel_fetcher_set_edge_mode</a> (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</a> mode);
void <a href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-set-bg-color">gimp_pixel_fetcher_set_bg_color</a> (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
enum <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</a>;
<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a>;
<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a>* <a class="link" href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-new">gimp_pixel_fetcher_new</a> (<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
gboolean shadow);
void <a class="link" href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-set-edge-mode">gimp_pixel_fetcher_set_edge_mode</a> (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</a> mode);
void <a class="link" href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-set-bg-color">gimp_pixel_fetcher_set_bg_color</a> (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);
void <a href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-get-pixel">gimp_pixel_fetcher_get_pixel</a> (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *pixel);
void <a href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-put-pixel">gimp_pixel_fetcher_put_pixel</a> (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *pixel);
void <a href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-destroy">gimp_pixel_fetcher_destroy</a> (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf);
void <a class="link" href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-get-pixel">gimp_pixel_fetcher_get_pixel</a> (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
gint x,
gint y,
guchar *pixel);
void <a class="link" href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-put-pixel">gimp_pixel_fetcher_put_pixel</a> (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
gint x,
gint y,
const guchar *pixel);
void <a class="link" href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-destroy">gimp_pixel_fetcher_destroy</a> (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2592159"></a><h2>Description</h2>
<a name="id2625922"></a><h2>Description</h2>
<p>
These functions provide neighbourhood-based algorithms which get
dramatically slower on region boundaries, to the point where a special
@ -98,11 +84,11 @@ plug-in code more readable and shorter.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2592180"></a><h2>Details</h2>
<a name="id2625943"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2592190"></a><h3>
<a name="id2643232"></a><h3>
<a name="GimpPixelFetcherEdgeMode"></a>enum GimpPixelFetcherEdgeMode</h3>
<a class="indexterm" name="id2616825"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2643243"></a><pre class="programlisting">typedef enum
{
GIMP_PIXEL_FETCHER_EDGE_NONE,
GIMP_PIXEL_FETCHER_EDGE_WRAP,
@ -117,21 +103,19 @@ plug-in code more readable and shorter.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2616843"></a><h3>
<a name="id2643262"></a><h3>
<a name="GimpPixelFetcher"></a>GimpPixelFetcher</h3>
<a class="indexterm" name="id2616856"></a><pre class="programlisting">typedef struct _GimpPixelFetcher GimpPixelFetcher;</pre>
<a class="indexterm" name="id2643274"></a><pre class="programlisting">typedef struct _GimpPixelFetcher GimpPixelFetcher;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2616872"></a><h3>
<a name="id2643291"></a><h3>
<a name="gimp-pixel-fetcher-new"></a>gimp_pixel_fetcher_new ()</h3>
<a class="indexterm" name="id2617545"></a><pre class="programlisting"><a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a>* gimp_pixel_fetcher_new (<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> shadow);</pre>
<a class="indexterm" name="id2629597"></a><pre class="programlisting"><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a>* gimp_pixel_fetcher_new (<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
gboolean shadow);</pre>
<p>
Initialize a pixel region from the drawable.</p>
<p>
@ -141,21 +125,19 @@ Initialize a pixel region from the drawable.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>drawable</code></em>&#160;:</span></td>
<td> the <a href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a> the new region will be attached to.
<td><p><span class="term"><em class="parameter"><code>drawable</code></em>&#160;:</span></p></td>
<td> the <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a> the new region will be attached to.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>shadow</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#gboolean"
><span class="type">gboolean</span></a> indicating whether the region is attached to
<td><p><span class="term"><em class="parameter"><code>shadow</code></em>&#160;:</span></p></td>
<td> a <span class="type">gboolean</span> indicating whether the region is attached to
the shadow tiles or the real <code class="literal">drawable</code> tiles.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a pointer to a <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a> structure (or NULL).
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> a pointer to a <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a> structure (or NULL).
</td>
</tr>
</tbody>
@ -163,10 +145,10 @@ href="../glib/glib-Basic-Types.html#gboolean"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620187"></a><h3>
<a name="id2655282"></a><h3>
<a name="gimp-pixel-fetcher-set-edge-mode"></a>gimp_pixel_fetcher_set_edge_mode ()</h3>
<a class="indexterm" name="id2620198"></a><pre class="programlisting">void gimp_pixel_fetcher_set_edge_mode (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</a> mode);</pre>
<a class="indexterm" name="id2655293"></a><pre class="programlisting">void gimp_pixel_fetcher_set_edge_mode (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</a> mode);</pre>
<p>
Change the edage mode of a previously initialized pixel region.</p>
<p>
@ -176,13 +158,13 @@ Change the edage mode of a previously initialized pixel region.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
<td><p><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></p></td>
<td> a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mode</code></em>&#160;:</span></td>
<td> the new edge mode from <a href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode"><span class="type">GimpPixelFetcherEdgeMode</span></a>.
<td><p><span class="term"><em class="parameter"><code>mode</code></em>&#160;:</span></p></td>
<td> the new edge mode from <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode"><span class="type">GimpPixelFetcherEdgeMode</span></a>.
</td>
</tr>
</tbody>
@ -190,9 +172,9 @@ Change the edage mode of a previously initialized pixel region.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620129"></a><h3>
<a name="id2655224"></a><h3>
<a name="gimp-pixel-fetcher-set-bg-color"></a>gimp_pixel_fetcher_set_bg_color ()</h3>
<a class="indexterm" name="id2563927"></a><pre class="programlisting">void gimp_pixel_fetcher_set_bg_color (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a class="indexterm" name="id2654078"></a><pre class="programlisting">void gimp_pixel_fetcher_set_bg_color (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre>
@ -205,12 +187,12 @@ Change the background color of a previously initialized pixel region.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
<td><p><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></p></td>
<td> a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></p></td>
<td> the color to be used as bg color.
</td>
</tr>
@ -219,18 +201,12 @@ Change the background color of a previously initialized pixel region.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564005"></a><h3>
<a name="id2654157"></a><h3>
<a name="gimp-pixel-fetcher-get-pixel"></a>gimp_pixel_fetcher_get_pixel ()</h3>
<a class="indexterm" name="id2639830"></a><pre class="programlisting">void gimp_pixel_fetcher_get_pixel (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *pixel);</pre>
<a class="indexterm" name="id2659882"></a><pre class="programlisting">void gimp_pixel_fetcher_get_pixel (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
gint x,
gint y,
guchar *pixel);</pre>
<p>
Get a pixel from the pixel region.</p>
<p>
@ -240,22 +216,22 @@ Get a pixel from the pixel region.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
<td><p><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></p></td>
<td> a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> the x coordinate of the pixel to get.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> the y coordinate of the pixel to get.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pixel</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>pixel</code></em>&#160;:</span></p></td>
<td> the memory location where to return the pixel.
</td>
</tr>
@ -264,18 +240,12 @@ Get a pixel from the pixel region.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2639950"></a><h3>
<a name="id2656831"></a><h3>
<a name="gimp-pixel-fetcher-put-pixel"></a>gimp_pixel_fetcher_put_pixel ()</h3>
<a class="indexterm" name="id2642721"></a><pre class="programlisting">void gimp_pixel_fetcher_put_pixel (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *pixel);</pre>
<a class="indexterm" name="id2656842"></a><pre class="programlisting">void gimp_pixel_fetcher_put_pixel (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf,
gint x,
gint y,
const guchar *pixel);</pre>
<p>
Set a pixel in the pixel region.</p>
<p>
@ -285,22 +255,22 @@ Set a pixel in the pixel region.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
<td><p><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></p></td>
<td> a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> the x coordinate of the pixel to set.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> the y coordinate of the pixel to set.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pixel</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>pixel</code></em>&#160;:</span></p></td>
<td> the pixel to set.
</td>
</tr>
@ -309,9 +279,9 @@ Set a pixel in the pixel region.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2640203"></a><h3>
<a name="id2657208"></a><h3>
<a name="gimp-pixel-fetcher-destroy"></a>gimp_pixel_fetcher_destroy ()</h3>
<a class="indexterm" name="id2640215"></a><pre class="programlisting">void gimp_pixel_fetcher_destroy (<a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf);</pre>
<a class="indexterm" name="id2657219"></a><pre class="programlisting">void gimp_pixel_fetcher_destroy (<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher">GimpPixelFetcher</a> *pf);</pre>
<p>
Close a previously initializd pixel region.</p>
<p>
@ -320,8 +290,8 @@ Close a previously initializd pixel region.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
<td><p><span class="term"><em class="parameter"><code>pf</code></em>&#160;:</span></p></td>
<td> a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.
</td>
</tr></tbody>
</table></div>