blob: 08fd39d22fe64254a56b9efb39b00cef520f5d48 (
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>libgutenprint API Reference: image</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libgutenprint API Reference
 <span id="projectnumber">5.2.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">image</div> </div>
</div><!--header-->
<div class="contents">
<p>The image type is an abstract data type for interfacing with the image creation program.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html">stp_image</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The image type is an abstract data type for interfacing with the image creation program. <a href="structstp__image.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga0b7daa7e9e9b26fea847d71ca9de7c02"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#ga0b7daa7e9e9b26fea847d71ca9de7c02">STP_CHANNEL_LIMIT</a>   (64)</td></tr>
<tr class="separator:ga0b7daa7e9e9b26fea847d71ca9de7c02"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaae0b5ef92b619849a51cb75d376a90fb"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structstp__image.html">stp_image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a></td></tr>
<tr class="memdesc:gaae0b5ef92b619849a51cb75d376a90fb"><td class="mdescLeft"> </td><td class="mdescRight">The image type is an abstract data type for interfacing with the image creation program. <a href="#gaae0b5ef92b619849a51cb75d376a90fb">More...</a><br /></td></tr>
<tr class="separator:gaae0b5ef92b619849a51cb75d376a90fb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga58672e1989d582c14328048b207657c8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#ga58672e1989d582c14328048b207657c8">stp_image_status_t</a> { <a class="el" href="group__image.html#gga58672e1989d582c14328048b207657c8ab5574da151b93391a337f29b2a7c96cf">STP_IMAGE_STATUS_OK</a>,
<a class="el" href="group__image.html#gga58672e1989d582c14328048b207657c8a224b8ac15cf785b24b2f3f53b4fdc274">STP_IMAGE_STATUS_ABORT</a>
}</td></tr>
<tr class="memdesc:ga58672e1989d582c14328048b207657c8"><td class="mdescLeft"> </td><td class="mdescRight">Image status. <a href="group__image.html#ga58672e1989d582c14328048b207657c8">More...</a><br /></td></tr>
<tr class="separator:ga58672e1989d582c14328048b207657c8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad257f72ac5272e94ff9314f8ecd24f1e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gad257f72ac5272e94ff9314f8ecd24f1e">stp_image_init</a> (<a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image)</td></tr>
<tr class="separator:gad257f72ac5272e94ff9314f8ecd24f1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf2fc433dba580b9ec8e69aebc2e65338"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gaf2fc433dba580b9ec8e69aebc2e65338">stp_image_reset</a> (<a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image)</td></tr>
<tr class="separator:gaf2fc433dba580b9ec8e69aebc2e65338"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabe86b2ff9a3a0c0e98248990f9be5652"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gabe86b2ff9a3a0c0e98248990f9be5652">stp_image_width</a> (<a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image)</td></tr>
<tr class="separator:gabe86b2ff9a3a0c0e98248990f9be5652"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf9dcdf718ad99df9eb71fc542d5b47e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gaf9dcdf718ad99df9eb71fc542d5b47e1">stp_image_height</a> (<a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image)</td></tr>
<tr class="separator:gaf9dcdf718ad99df9eb71fc542d5b47e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga01d72a16de9e98722859ca651561e8f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__image.html#ga58672e1989d582c14328048b207657c8">stp_image_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#ga01d72a16de9e98722859ca651561e8f5">stp_image_get_row</a> (<a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image, unsigned char *data, size_t limit, int row)</td></tr>
<tr class="separator:ga01d72a16de9e98722859ca651561e8f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1643f6b9eb180e98f3c1c267950f18d2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#ga1643f6b9eb180e98f3c1c267950f18d2">stp_image_get_appname</a> (<a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image)</td></tr>
<tr class="separator:ga1643f6b9eb180e98f3c1c267950f18d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7598151354fbeb5f6a8b3f92d1e40ad7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#ga7598151354fbeb5f6a8b3f92d1e40ad7">stp_image_conclude</a> (<a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> *image)</td></tr>
<tr class="separator:ga7598151354fbeb5f6a8b3f92d1e40ad7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The image type is an abstract data type for interfacing with the image creation program. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga0b7daa7e9e9b26fea847d71ca9de7c02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STP_CHANNEL_LIMIT   (64)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum number of channels. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaae0b5ef92b619849a51cb75d376a90fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structstp__image.html">stp_image</a> <a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The image type is an abstract data type for interfacing with the image creation program. </p>
<p>It provides callbacks to functions defined within the client application which are called while printing the image. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga58672e1989d582c14328048b207657c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__image.html#ga58672e1989d582c14328048b207657c8">stp_image_status_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Image status. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga58672e1989d582c14328048b207657c8ab5574da151b93391a337f29b2a7c96cf"></a>STP_IMAGE_STATUS_OK </td><td class="fielddoc">
<p>Everything is OK. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga58672e1989d582c14328048b207657c8a224b8ac15cf785b24b2f3f53b4fdc274"></a>STP_IMAGE_STATUS_ABORT </td><td class="fielddoc">
<p>An error occured, or the job was aborted. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga7598151354fbeb5f6a8b3f92d1e40ad7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_image_conclude </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga1643f6b9eb180e98f3c1c267950f18d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_image_get_appname </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga01d72a16de9e98722859ca651561e8f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__image.html#ga58672e1989d582c14328048b207657c8">stp_image_status_t</a> stp_image_get_row </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>limit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>row</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gaf9dcdf718ad99df9eb71fc542d5b47e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_image_height </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gad257f72ac5272e94ff9314f8ecd24f1e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_image_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gaf2fc433dba580b9ec8e69aebc2e65338"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_image_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gabe86b2ff9a3a0c0e98248990f9be5652"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_image_width </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 18 2014 18:57:43 for libgutenprint API Reference by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>
|
