summaryrefslogtreecommitdiffstats
path: root/devel-docs/libgimpbase/html/libgimpbase-gimpparasiteio.html
blob: 73faa95449ce0c4d704b27d10f0c260789241d17 (plain)
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpparasiteio: GIMP Base Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="pt01.html" title="Part I. GIMP Base Library">
<link rel="prev" href="libgimpbase-GimpParasite.html" title="GimpParasite">
<link rel="next" href="libgimpbase-gimpsignal.html" title="gimpsignal">
<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="#libgimpbase-gimpparasiteio.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="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimpbase-GimpParasite.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimpbase-gimpsignal.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimpbase-gimpparasiteio"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimpbase-gimpparasiteio.top_of_page"></a>gimpparasiteio</span></h2>
<p>gimpparasiteio — Utility functions to (de)serialize certain C
structures to/from <a class="link" href="libgimpbase-GimpParasite.html#GimpParasite" title="GimpParasite"><span class="type">GimpParasite</span></a>'s.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimpbase-gimpparasiteio.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">
<a class="link" href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-init" title="gimp_pixpipe_params_init ()">gimp_pixpipe_params_init</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="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-free" title="gimp_pixpipe_params_free ()">gimp_pixpipe_params_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="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-parse" title="gimp_pixpipe_params_parse ()">gimp_pixpipe_params_parse</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-build" title="gimp_pixpipe_params_build ()">gimp_pixpipe_params_build</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpparasiteio.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgimpbase-gimpparasiteio.html#GIMP-PIXPIPE-MAXDIM:CAPS" title="GIMP_PIXPIPE_MAXDIM">GIMP_PIXPIPE_MAXDIM</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgimpbase-gimpparasiteio.html#GimpPixPipeParams" title="struct GimpPixPipeParams">GimpPixPipeParams</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpparasiteio.description"></a><h2>Description</h2>
<p>Utility functions to (de)serialize certain C structures to/from*
<a class="link" href="libgimpbase-GimpParasite.html#GimpParasite" title="GimpParasite"><span class="type">GimpParasite</span></a>'s.</p>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpparasiteio.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-pixpipe-params-init"></a><h3>gimp_pixpipe_params_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_pixpipe_params_init (<em class="parameter"><code><a class="link" href="libgimpbase-gimpparasiteio.html#GimpPixPipeParams" title="struct GimpPixPipeParams"><span class="type">GimpPixPipeParams</span></a> *params</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pixpipe-params-free"></a><h3>gimp_pixpipe_params_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_pixpipe_params_free (<em class="parameter"><code><a class="link" href="libgimpbase-gimpparasiteio.html#GimpPixPipeParams" title="struct GimpPixPipeParams"><span class="type">GimpPixPipeParams</span></a> *params</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pixpipe-params-parse"></a><h3>gimp_pixpipe_params_parse ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_pixpipe_params_parse (<em class="parameter"><code>const <span class="type">gchar</span> *parameters</code></em>,
                           <em class="parameter"><code><a class="link" href="libgimpbase-gimpparasiteio.html#GimpPixPipeParams" title="struct GimpPixPipeParams"><span class="type">GimpPixPipeParams</span></a> *params</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pixpipe-params-build"></a><h3>gimp_pixpipe_params_build ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_pixpipe_params_build (<em class="parameter"><code><a class="link" href="libgimpbase-gimpparasiteio.html#GimpPixPipeParams" title="struct GimpPixPipeParams"><span class="type">GimpPixPipeParams</span></a> *params</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpparasiteio.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GIMP-PIXPIPE-MAXDIM:CAPS"></a><h3>GIMP_PIXPIPE_MAXDIM</h3>
<pre class="programlisting">#define GIMP_PIXPIPE_MAXDIM 4
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GimpPixPipeParams"></a><h3>struct GimpPixPipeParams</h3>
<pre class="programlisting">struct GimpPixPipeParams {
  gint      step;
  gint      ncells;
  gint      dim;
  gint      cols;
  gint      rows;
  gint      cellwidth;
  gint      cellheight;
  gchar    *placement;
  gboolean  free_placement_string;
  gint      rank[GIMP_PIXPIPE_MAXDIM];
  gchar    *selection[GIMP_PIXPIPE_MAXDIM];
  /* this flag is now useless. All selection strings are allocated. */
  gboolean  free_selection_string;
};
</pre>
<p>PLease somebody help documenting this.</p>
<div class="refsect3">
<a name="GimpPixPipeParams.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.step"></a>step</code></em>;</p></td>
<td class="struct_member_description"><p>Step</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.ncells"></a>ncells</code></em>;</p></td>
<td class="struct_member_description"><p>Number of cells</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.dim"></a>dim</code></em>;</p></td>
<td class="struct_member_description"><p>Dimension</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.cols"></a>cols</code></em>;</p></td>
<td class="struct_member_description"><p>Columns</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.rows"></a>rows</code></em>;</p></td>
<td class="struct_member_description"><p>Rows</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.cellwidth"></a>cellwidth</code></em>;</p></td>
<td class="struct_member_description"><p>Cell width</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.cellheight"></a>cellheight</code></em>;</p></td>
<td class="struct_member_description"><p>Cell height</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpPixPipeParams.placement"></a>placement</code></em>;</p></td>
<td class="struct_member_description"><p>Placement</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="GimpPixPipeParams.free-placement-string"></a>free_placement_string</code></em>;</p></td>
<td class="struct_member_description"><p>Unused, ignore</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpPixPipeParams.rank"></a>rank</code></em>[GIMP_PIXPIPE_MAXDIM];</p></td>
<td class="struct_member_description"><p>Rank</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GimpPixPipeParams.selection"></a>selection</code></em>[GIMP_PIXPIPE_MAXDIM];</p></td>
<td class="struct_member_description"><p>Selection</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="GimpPixPipeParams.free-selection-string"></a>free_selection_string</code></em>;</p></td>
<td class="struct_member_description"><p>Unused, ignore</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpparasiteio.see-also"></a><h2>See Also</h2>
<p><a class="link" href="libgimpbase-GimpParasite.html#GimpParasite" title="GimpParasite"><span class="type">GimpParasite</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>