4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
6
<title>libgutenprint API Reference: image</title>
8
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
<script type="text/javascript" src="jquery.js"></script>
9
<script type="text/javascript" src="dynsections.js"></script>
9
10
<link href="doxygen.css" rel="stylesheet" type="text/css" />
15
<div id="top"><!-- do not remove this div! -->
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
18
14
<div id="titlearea">
19
15
<table cellspacing="0" cellpadding="0">
21
17
<tr style="height: 56px;">
24
18
<td style="padding-left: 0.5em;">
25
19
<div id="projectname">libgutenprint API Reference
26
 <span id="projectnumber">5.2.8-pre1</span>
20
 <span id="projectnumber">5.2.8</span>
38
<!-- Generated by Doxygen 1.7.6.1 -->
27
<!-- end header part -->
28
<!-- Generated by Doxygen 1.8.1 -->
39
29
<div id="navrow1" class="tabs">
40
30
<ul class="tablist">
41
31
<li><a href="index.html"><span>Main Page</span></a></li>
61
51
<p>The image type is an abstract data type for interfacing with the image creation program.
62
52
<a href="#details">More...</a></p>
63
53
<table class="memberdecls">
64
<tr><td colspan="2"><h2><a name="nested-classes"></a>
54
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
65
55
Data Structures</h2></td></tr>
66
<tr><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>
67
<tr><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>
68
<tr><td colspan="2"><h2><a name="define-members"></a>
69
Defines</h2></td></tr>
70
<tr><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>   (32)</td></tr>
71
<tr><td colspan="2"><h2><a name="typedef-members"></a>
56
<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>
57
<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>
58
</table><table class="memberdecls">
59
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
61
<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>   (32)</td></tr>
62
</table><table class="memberdecls">
63
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
72
64
Typedefs</h2></td></tr>
73
<tr><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>
74
<tr><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"></a><br/></td></tr>
75
<tr><td colspan="2"><h2><a name="enum-members"></a>
65
<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>
66
<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"></a><br/></td></tr>
67
</table><table class="memberdecls">
68
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
76
69
Enumerations</h2></td></tr>
77
<tr><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>,
70
<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>,
78
71
<a class="el" href="group__image.html#gga58672e1989d582c14328048b207657c8a224b8ac15cf785b24b2f3f53b4fdc274">STP_IMAGE_STATUS_ABORT</a>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image status. <a href="group__image.html#ga58672e1989d582c14328048b207657c8">More...</a><br/></td></tr>
81
<tr><td colspan="2"><h2><a name="func-members"></a>
73
<tr class="memdesc:ga58672e1989d582c14328048b207657c8"><td class="mdescLeft"> </td><td class="mdescRight">Image status. <a href="group__image.html#ga58672e1989d582c14328048b207657c8">More...</a><br/></td></tr>
74
</table><table class="memberdecls">
75
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
82
76
Functions</h2></td></tr>
83
<tr><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>
84
<tr><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>
85
<tr><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>
86
<tr><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>
87
<tr><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>
88
<tr><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>
89
<tr><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>
77
<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>
78
<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>
79
<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>
80
<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>
81
<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>
82
<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>
83
<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>
91
85
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
92
86
<p>The image type is an abstract data type for interfacing with the image creation program. </p>
93
<hr/><h2>Define Documentation</h2>
94
<a class="anchor" id="ga0b7daa7e9e9b26fea847d71ca9de7c02"></a><!-- doxytag: member="image.h::STP_CHANNEL_LIMIT" ref="ga0b7daa7e9e9b26fea847d71ca9de7c02" args="" -->
87
<hr/><h2>Macro Definition Documentation</h2>
88
<a class="anchor" id="ga0b7daa7e9e9b26fea847d71ca9de7c02"></a>
95
89
<div class="memitem">
96
90
<div class="memproto">
97
91
<table class="memname">
99
<td class="memname">#define <a class="el" href="group__image.html#ga0b7daa7e9e9b26fea847d71ca9de7c02">STP_CHANNEL_LIMIT</a>   (32)</td>
93
<td class="memname">#define STP_CHANNEL_LIMIT   (32)</td>
96
</div><div class="memdoc">
104
97
<p>The maximum number of channels. </p>
108
101
<hr/><h2>Typedef Documentation</h2>
109
<a class="anchor" id="gaae0b5ef92b619849a51cb75d376a90fb"></a><!-- doxytag: member="image.h::stp_image_t" ref="gaae0b5ef92b619849a51cb75d376a90fb" args="" -->
102
<a class="anchor" id="gaae0b5ef92b619849a51cb75d376a90fb"></a>
110
103
<div class="memitem">
111
104
<div class="memproto">
112
105
<table class="memname">
151
142
<hr/><h2>Function Documentation</h2>
152
<a class="anchor" id="ga7598151354fbeb5f6a8b3f92d1e40ad7"></a><!-- doxytag: member="image.h::stp_image_conclude" ref="ga7598151354fbeb5f6a8b3f92d1e40ad7" args="(stp_image_t *image)" -->
153
<div class="memitem">
154
<div class="memproto">
155
<table class="memname">
157
<td class="memname">void <a class="el" href="group__image.html#ga7598151354fbeb5f6a8b3f92d1e40ad7">stp_image_conclude</a> </td>
159
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
160
<td class="paramname"><em>image</em></td><td>)</td>
169
<a class="anchor" id="ga1643f6b9eb180e98f3c1c267950f18d2"></a><!-- doxytag: member="image.h::stp_image_get_appname" ref="ga1643f6b9eb180e98f3c1c267950f18d2" args="(stp_image_t *image)" -->
170
<div class="memitem">
171
<div class="memproto">
172
<table class="memname">
174
<td class="memname">const char* <a class="el" href="group__image.html#ga1643f6b9eb180e98f3c1c267950f18d2">stp_image_get_appname</a> </td>
176
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
177
<td class="paramname"><em>image</em></td><td>)</td>
186
<a class="anchor" id="ga01d72a16de9e98722859ca651561e8f5"></a><!-- doxytag: member="image.h::stp_image_get_row" ref="ga01d72a16de9e98722859ca651561e8f5" args="(stp_image_t *image, unsigned char *data, size_t limit, int row)" -->
187
<div class="memitem">
188
<div class="memproto">
189
<table class="memname">
191
<td class="memname"><a class="el" href="group__image.html#ga58672e1989d582c14328048b207657c8">stp_image_status_t</a> <a class="el" href="group__image.html#ga01d72a16de9e98722859ca651561e8f5">stp_image_get_row</a> </td>
143
<a class="anchor" id="ga7598151354fbeb5f6a8b3f92d1e40ad7"></a>
144
<div class="memitem">
145
<div class="memproto">
146
<table class="memname">
148
<td class="memname">void stp_image_conclude </td>
150
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
151
<td class="paramname"><em>image</em></td><td>)</td>
155
</div><div class="memdoc">
159
<a class="anchor" id="ga1643f6b9eb180e98f3c1c267950f18d2"></a>
160
<div class="memitem">
161
<div class="memproto">
162
<table class="memname">
164
<td class="memname">const char* stp_image_get_appname </td>
166
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
167
<td class="paramname"><em>image</em></td><td>)</td>
171
</div><div class="memdoc">
175
<a class="anchor" id="ga01d72a16de9e98722859ca651561e8f5"></a>
176
<div class="memitem">
177
<div class="memproto">
178
<table class="memname">
180
<td class="memname"><a class="el" href="group__image.html#ga58672e1989d582c14328048b207657c8">stp_image_status_t</a> stp_image_get_row </td>
193
182
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
194
183
<td class="paramname"><em>image</em>, </td>
217
206
<td></td><td></td>
225
<a class="anchor" id="gaf9dcdf718ad99df9eb71fc542d5b47e1"></a><!-- doxytag: member="image.h::stp_image_height" ref="gaf9dcdf718ad99df9eb71fc542d5b47e1" args="(stp_image_t *image)" -->
226
<div class="memitem">
227
<div class="memproto">
228
<table class="memname">
230
<td class="memname">int <a class="el" href="group__image.html#gaf9dcdf718ad99df9eb71fc542d5b47e1">stp_image_height</a> </td>
232
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
233
<td class="paramname"><em>image</em></td><td>)</td>
242
<a class="anchor" id="gad257f72ac5272e94ff9314f8ecd24f1e"></a><!-- doxytag: member="image.h::stp_image_init" ref="gad257f72ac5272e94ff9314f8ecd24f1e" args="(stp_image_t *image)" -->
243
<div class="memitem">
244
<div class="memproto">
245
<table class="memname">
247
<td class="memname">void <a class="el" href="group__image.html#gad257f72ac5272e94ff9314f8ecd24f1e">stp_image_init</a> </td>
249
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
250
<td class="paramname"><em>image</em></td><td>)</td>
259
<a class="anchor" id="gaf2fc433dba580b9ec8e69aebc2e65338"></a><!-- doxytag: member="image.h::stp_image_reset" ref="gaf2fc433dba580b9ec8e69aebc2e65338" args="(stp_image_t *image)" -->
260
<div class="memitem">
261
<div class="memproto">
262
<table class="memname">
264
<td class="memname">void <a class="el" href="group__image.html#gaf2fc433dba580b9ec8e69aebc2e65338">stp_image_reset</a> </td>
266
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
267
<td class="paramname"><em>image</em></td><td>)</td>
276
<a class="anchor" id="gabe86b2ff9a3a0c0e98248990f9be5652"></a><!-- doxytag: member="image.h::stp_image_width" ref="gabe86b2ff9a3a0c0e98248990f9be5652" args="(stp_image_t *image)" -->
277
<div class="memitem">
278
<div class="memproto">
279
<table class="memname">
281
<td class="memname">int <a class="el" href="group__image.html#gabe86b2ff9a3a0c0e98248990f9be5652">stp_image_width</a> </td>
283
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
284
<td class="paramname"><em>image</em></td><td>)</td>
209
</div><div class="memdoc">
213
<a class="anchor" id="gaf9dcdf718ad99df9eb71fc542d5b47e1"></a>
214
<div class="memitem">
215
<div class="memproto">
216
<table class="memname">
218
<td class="memname">int stp_image_height </td>
220
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
221
<td class="paramname"><em>image</em></td><td>)</td>
225
</div><div class="memdoc">
229
<a class="anchor" id="gad257f72ac5272e94ff9314f8ecd24f1e"></a>
230
<div class="memitem">
231
<div class="memproto">
232
<table class="memname">
234
<td class="memname">void stp_image_init </td>
236
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
237
<td class="paramname"><em>image</em></td><td>)</td>
241
</div><div class="memdoc">
245
<a class="anchor" id="gaf2fc433dba580b9ec8e69aebc2e65338"></a>
246
<div class="memitem">
247
<div class="memproto">
248
<table class="memname">
250
<td class="memname">void stp_image_reset </td>
252
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
253
<td class="paramname"><em>image</em></td><td>)</td>
257
</div><div class="memdoc">
261
<a class="anchor" id="gabe86b2ff9a3a0c0e98248990f9be5652"></a>
262
<div class="memitem">
263
<div class="memproto">
264
<table class="memname">
266
<td class="memname">int stp_image_width </td>
268
<td class="paramtype"><a class="el" href="group__image.html#gaae0b5ef92b619849a51cb75d376a90fb">stp_image_t</a> * </td>
269
<td class="paramname"><em>image</em></td><td>)</td>
273
</div><div class="memdoc">
293
277
</div><!-- contents -->
278
<!-- start footer part -->
296
279
<hr class="footer"/><address class="footer"><small>
297
280
Generated by  <a href="http://www.doxygen.org/index.html">
298
281
<img class="footer" src="doxygen.png" alt="doxygen"/>
300
283
</small></address>