1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?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-gimppixelfetcher">
<refmeta>
<refentrytitle role="top_of_page">gimppixelfetcher</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimppixelfetcher</refname>
<refpurpose>Functions for operating on pixel regions.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</link>;
<link linkend="GimpPixelFetcher">GimpPixelFetcher</link>;
<link linkend="GimpPixelFetcher">GimpPixelFetcher</link>* <link linkend="gimp-pixel-fetcher-new">gimp_pixel_fetcher_new</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
<link linkend="gboolean">gboolean</link> shadow);
<link linkend="void">void</link> <link linkend="gimp-pixel-fetcher-set-edge-mode">gimp_pixel_fetcher_set_edge_mode</link>
(<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
<link linkend="GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</link> mode);
<link linkend="void">void</link> <link linkend="gimp-pixel-fetcher-set-bg-color">gimp_pixel_fetcher_set_bg_color</link> (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
const <link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="void">void</link> <link linkend="gimp-pixel-fetcher-get-pixel">gimp_pixel_fetcher_get_pixel</link> (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="guchar">guchar</link> *pixel);
<link linkend="void">void</link> <link linkend="gimp-pixel-fetcher-put-pixel">gimp_pixel_fetcher_put_pixel</link> (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
const <link linkend="guchar">guchar</link> *pixel);
<link linkend="void">void</link> <link linkend="gimp-pixel-fetcher-destroy">gimp_pixel_fetcher_destroy</link> (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
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.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpPixelFetcherEdgeMode" role="enum"/>enum GimpPixelFetcherEdgeMode</title>
<indexterm><primary>GimpPixelFetcherEdgeMode</primary></indexterm><programlisting>typedef enum
{
GIMP_PIXEL_FETCHER_EDGE_NONE,
GIMP_PIXEL_FETCHER_EDGE_WRAP,
GIMP_PIXEL_FETCHER_EDGE_SMEAR,
GIMP_PIXEL_FETCHER_EDGE_BLACK,
GIMP_PIXEL_FETCHER_EDGE_BACKGROUND
} GimpPixelFetcherEdgeMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpPixelFetcher" role="struct"/>GimpPixelFetcher</title>
<indexterm><primary>GimpPixelFetcher</primary></indexterm><programlisting>typedef struct _GimpPixelFetcher GimpPixelFetcher;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-pixel-fetcher-new" role="function"/>gimp_pixel_fetcher_new ()</title>
<indexterm><primary>gimp_pixel_fetcher_new</primary></indexterm><programlisting><link linkend="GimpPixelFetcher">GimpPixelFetcher</link>* gimp_pixel_fetcher_new (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
<link linkend="gboolean">gboolean</link> shadow);</programlisting>
<para>
Initialize a pixel region from the drawable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>drawable</parameter> :</term>
<listitem><simpara> the <link linkend="GimpDrawable"><type>GimpDrawable</type></link> the new region will be attached to.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>shadow</parameter> :</term>
<listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link> indicating whether the region is attached to
the shadow tiles or the real <link linkend="drawable"><literal>drawable</literal></link> tiles.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to a <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link> structure (or NULL).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixel-fetcher-set-edge-mode" role="function"/>gimp_pixel_fetcher_set_edge_mode ()</title>
<indexterm><primary>gimp_pixel_fetcher_set_edge_mode</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_fetcher_set_edge_mode
(<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
<link linkend="GimpPixelFetcherEdgeMode">GimpPixelFetcherEdgeMode</link> mode);</programlisting>
<para>
Change the edage mode of a previously initialized pixel region.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pf</parameter> :</term>
<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelFetcher"><type>GimpPixelFetcher</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> the new edge mode from <link linkend="GimpPixelFetcherEdgeMode"><type>GimpPixelFetcherEdgeMode</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixel-fetcher-set-bg-color" role="function"/>gimp_pixel_fetcher_set_bg_color ()</title>
<indexterm><primary>gimp_pixel_fetcher_set_bg_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_fetcher_set_bg_color (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Change the background color of a previously initialized pixel region.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pf</parameter> :</term>
<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelFetcher"><type>GimpPixelFetcher</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> the color to be used as bg color.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixel-fetcher-get-pixel" role="function"/>gimp_pixel_fetcher_get_pixel ()</title>
<indexterm><primary>gimp_pixel_fetcher_get_pixel</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_fetcher_get_pixel (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="guchar">guchar</link> *pixel);</programlisting>
<para>
Get a pixel from the pixel region.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pf</parameter> :</term>
<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelFetcher"><type>GimpPixelFetcher</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> the x coordinate of the pixel to get.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> the y coordinate of the pixel to get.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixel</parameter> :</term>
<listitem><simpara> the memory location where to return the pixel.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixel-fetcher-put-pixel" role="function"/>gimp_pixel_fetcher_put_pixel ()</title>
<indexterm><primary>gimp_pixel_fetcher_put_pixel</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_fetcher_put_pixel (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
const <link linkend="guchar">guchar</link> *pixel);</programlisting>
<para>
Set a pixel in the pixel region.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pf</parameter> :</term>
<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelFetcher"><type>GimpPixelFetcher</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> the x coordinate of the pixel to set.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> the y coordinate of the pixel to set.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixel</parameter> :</term>
<listitem><simpara> the pixel to set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixel-fetcher-destroy" role="function"/>gimp_pixel_fetcher_destroy ()</title>
<indexterm><primary>gimp_pixel_fetcher_destroy</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_fetcher_destroy (<link linkend="GimpPixelFetcher">GimpPixelFetcher</link> *pf);</programlisting>
<para>
Close a previously initializd pixel region.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pf</parameter> :</term>
<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelFetcher"><type>GimpPixelFetcher</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
