diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:23:22 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:23:22 +0000 |
commit | e42129241681dde7adae7d20697e7b421682fbb4 (patch) | |
tree | af1fe815a5e639e68e59fabd8395ec69458b3e5e /devel-docs/libgimp/html/libgimp-gimppixelfetcher.html | |
parent | Initial commit. (diff) | |
download | gimp-e42129241681dde7adae7d20697e7b421682fbb4.tar.xz gimp-e42129241681dde7adae7d20697e7b421682fbb4.zip |
Adding upstream version 2.10.22.upstream/2.10.22upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimppixelfetcher.html')
-rw-r--r-- | devel-docs/libgimp/html/libgimp-gimppixelfetcher.html | 382 |
1 files changed, 382 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimppixelfetcher.html b/devel-docs/libgimp/html/libgimp-gimppixelfetcher.html new file mode 100644 index 0000000..9ada2ff --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppixelfetcher.html @@ -0,0 +1,382 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimppixelfetcher: 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-gimppixbuf.html" title="gimppixbuf"> +<link rel="next" href="libgimp-gimppixelrgn.html" title="gimppixelrgn"> +<meta name="generator" content="GTK-Doc V1.32 (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-gimppixelfetcher.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-gimppixbuf.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimppixelrgn.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimppixelfetcher"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimp-gimppixelfetcher.top_of_page"></a>gimppixelfetcher</span></h2> +<p>gimppixelfetcher — Functions for operating on pixel regions.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimppixelfetcher.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"> +<a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="returnvalue">GimpPixelFetcher</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimppixelfetcher.html#gimp-pixel-fetcher-new" title="gimp_pixel_fetcher_new ()">gimp_pixel_fetcher_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-gimppixelfetcher.html#gimp-pixel-fetcher-set-edge-mode" title="gimp_pixel_fetcher_set_edge_mode ()">gimp_pixel_fetcher_set_edge_mode</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-gimppixelfetcher.html#gimp-pixel-fetcher-set-bg-color" title="gimp_pixel_fetcher_set_bg_color ()">gimp_pixel_fetcher_set_bg_color</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-gimppixelfetcher.html#gimp-pixel-fetcher-get-pixel" title="gimp_pixel_fetcher_get_pixel ()">gimp_pixel_fetcher_get_pixel</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-gimppixelfetcher.html#gimp-pixel-fetcher-put-pixel" title="gimp_pixel_fetcher_put_pixel ()">gimp_pixel_fetcher_put_pixel</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-gimppixelfetcher.html#gimp-pixel-fetcher-destroy" title="gimp_pixel_fetcher_destroy ()">gimp_pixel_fetcher_destroy</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimppixelfetcher.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">enum</td> +<td class="function_name"><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode" title="enum GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher">GimpPixelFetcher</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimppixelfetcher.description"></a><h2>Description</h2> +<p>These functions provide neighbourhood-based algorithms which get +dramatically slower on region boundaries, to the point where a +special treatment for neighbourhoods which are completely inside a +tile is called for. It hides the special treatment of tile borders, +making plug-in code more readable and shorter.</p> +</div> +<div class="refsect1"> +<a name="libgimp-gimppixelfetcher.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-pixel-fetcher-new"></a><h3>gimp_pixel_fetcher_new ()</h3> +<pre class="programlisting"><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="returnvalue">GimpPixelFetcher</span></a> * +gimp_pixel_fetcher_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><span class="type">gboolean</span> shadow</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_pixel_fetcher_new</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Initialize a pixel region from the drawable.</p> +<div class="refsect3"> +<a name="gimp-pixel-fetcher-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>the <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a> the new region will be attached to.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>shadow</p></td> +<td class="parameter_description"><p>a <span class="type">gboolean</span> indicating whether the region is attached to +the shadow tiles or the real <em class="parameter"><code>drawable</code></em> +tiles.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-pixel-fetcher-new.returns"></a><h4>Returns</h4> +<p> a pointer to a <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn" title="GimpPixelRgn"><span class="type">GimpPixelRgn</span></a> structure (or NULL).</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-pixel-fetcher-set-edge-mode"></a><h3>gimp_pixel_fetcher_set_edge_mode ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_pixel_fetcher_set_edge_mode (<em class="parameter"><code><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a> *pf</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode" title="enum GimpPixelFetcherEdgeMode"><span class="type">GimpPixelFetcherEdgeMode</span></a> mode</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_pixel_fetcher_set_edge_mode</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Change the edge mode of a previously initialized pixel region.</p> +<div class="refsect3"> +<a name="gimp-pixel-fetcher-set-edge-mode.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>pf</p></td> +<td class="parameter_description"><p>a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>mode</p></td> +<td class="parameter_description"><p>the new edge mode from <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcherEdgeMode" title="enum GimpPixelFetcherEdgeMode"><span class="type">GimpPixelFetcherEdgeMode</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-pixel-fetcher-set-bg-color"></a><h3>gimp_pixel_fetcher_set_bg_color ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_pixel_fetcher_set_bg_color (<em class="parameter"><code><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a> *pf</code></em>, + <em class="parameter"><code>const <a href="../html/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_pixel_fetcher_set_bg_color</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Change the background color of a previously initialized pixel region.</p> +<div class="refsect3"> +<a name="gimp-pixel-fetcher-set-bg-color.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>pf</p></td> +<td class="parameter_description"><p>a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>color</p></td> +<td class="parameter_description"><p>the color to be used as bg color.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-pixel-fetcher-get-pixel"></a><h3>gimp_pixel_fetcher_get_pixel ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_pixel_fetcher_get_pixel (<em class="parameter"><code><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a> *pf</code></em>, + <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> *pixel</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_pixel_fetcher_get_pixel</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Get a pixel from the pixel region.</p> +<div class="refsect3"> +<a name="gimp-pixel-fetcher-get-pixel.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>pf</p></td> +<td class="parameter_description"><p>a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>the x coordinate of the pixel to get.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>the y coordinate of the pixel to get.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>pixel</p></td> +<td class="parameter_description"><p>the memory location where to return the pixel.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-pixel-fetcher-put-pixel"></a><h3>gimp_pixel_fetcher_put_pixel ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_pixel_fetcher_put_pixel (<em class="parameter"><code><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a> *pf</code></em>, + <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> *pixel</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_pixel_fetcher_put_pixel</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Set a pixel in the pixel region.</p> +<div class="refsect3"> +<a name="gimp-pixel-fetcher-put-pixel.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>pf</p></td> +<td class="parameter_description"><p>a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>the x coordinate of the pixel to set.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>the y coordinate of the pixel to set.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>pixel</p></td> +<td class="parameter_description"><p>the pixel to set.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-pixel-fetcher-destroy"></a><h3>gimp_pixel_fetcher_destroy ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_pixel_fetcher_destroy (<em class="parameter"><code><a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a> *pf</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_pixel_fetcher_destroy</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Close a previously initialized pixel region.</p> +<div class="refsect3"> +<a name="gimp-pixel-fetcher-destroy.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>pf</p></td> +<td class="parameter_description"><p>a pointer to a previously initialized <a class="link" href="libgimp-gimppixelfetcher.html#GimpPixelFetcher" title="GimpPixelFetcher"><span class="type">GimpPixelFetcher</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="libgimp-gimppixelfetcher.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpPixelFetcherEdgeMode"></a><h3>enum GimpPixelFetcherEdgeMode</h3> +<div class="refsect3"> +<a name="GimpPixelFetcherEdgeMode.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="GIMP-PIXEL-FETCHER-EDGE-NONE:CAPS"></a>GIMP_PIXEL_FETCHER_EDGE_NONE</p></td> +<td> </td> +<td> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-PIXEL-FETCHER-EDGE-WRAP:CAPS"></a>GIMP_PIXEL_FETCHER_EDGE_WRAP</p></td> +<td> </td> +<td> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-PIXEL-FETCHER-EDGE-SMEAR:CAPS"></a>GIMP_PIXEL_FETCHER_EDGE_SMEAR</p></td> +<td> </td> +<td> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-PIXEL-FETCHER-EDGE-BLACK:CAPS"></a>GIMP_PIXEL_FETCHER_EDGE_BLACK</p></td> +<td> </td> +<td> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-PIXEL-FETCHER-EDGE-BACKGROUND:CAPS"></a>GIMP_PIXEL_FETCHER_EDGE_BACKGROUND</p></td> +<td> </td> +<td> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpPixelFetcher"></a><h3>GimpPixelFetcher</h3> +<pre class="programlisting">typedef struct _GimpPixelFetcher GimpPixelFetcher;</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |