<!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"/>
<title>libgutenprint API Reference: image</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<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.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</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>
<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><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<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>
<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>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<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>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<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>
<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>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<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>,
<a class="el" href="group__image.html#gga58672e1989d582c14328048b207657c8a224b8ac15cf785b24b2f3f53b4fdc274">STP_IMAGE_STATUS_ABORT</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image status. <a href="group__image.html#ga58672e1989d582c14328048b207657c8">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<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="structstp__image.html">stp_image_t</a> *image)</td></tr>
<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="structstp__image.html">stp_image_t</a> *image)</td></tr>
<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="structstp__image.html">stp_image_t</a> *image)</td></tr>
<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="structstp__image.html">stp_image_t</a> *image)</td></tr>
<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="structstp__image.html">stp_image_t</a> *image, unsigned char *data, size_t limit, int row)</td></tr>
<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="structstp__image.html">stp_image_t</a> *image)</td></tr>
<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="structstp__image.html">stp_image_t</a> *image)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The image type is an abstract data type for interfacing with the image creation program. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga0b7daa7e9e9b26fea847d71ca9de7c02"></a><!-- doxytag: member="image.h::STP_CHANNEL_LIMIT" ref="ga0b7daa7e9e9b26fea847d71ca9de7c02" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STP_CHANNEL_LIMIT   (32)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The maximum number of channels. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaae0b5ef92b619849a51cb75d376a90fb"></a><!-- doxytag: member="image.h::stp_image_t" ref="gaae0b5ef92b619849a51cb75d376a90fb" args="" -->
<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="structstp__image.html">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>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga58672e1989d582c14328048b207657c8"></a><!-- doxytag: member="image.h::stp_image_status_t" ref="ga58672e1989d582c14328048b207657c8" args="" -->
<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>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga58672e1989d582c14328048b207657c8ab5574da151b93391a337f29b2a7c96cf"></a><!-- doxytag: member="STP_IMAGE_STATUS_OK" ref="gga58672e1989d582c14328048b207657c8ab5574da151b93391a337f29b2a7c96cf" args="" -->STP_IMAGE_STATUS_OK</em> </td><td>
<p>Everything is OK. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga58672e1989d582c14328048b207657c8a224b8ac15cf785b24b2f3f53b4fdc274"></a><!-- doxytag: member="STP_IMAGE_STATUS_ABORT" ref="gga58672e1989d582c14328048b207657c8a224b8ac15cf785b24b2f3f53b4fdc274" args="" -->STP_IMAGE_STATUS_ABORT</em> </td><td>
<p>An error occured, or the job was aborted. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7598151354fbeb5f6a8b3f92d1e40ad7"></a><!-- doxytag: member="image.h::stp_image_conclude" ref="ga7598151354fbeb5f6a8b3f92d1e40ad7" args="(stp_image_t *image)" -->
<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="structstp__image.html">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><!-- doxytag: member="image.h::stp_image_get_appname" ref="ga1643f6b9eb180e98f3c1c267950f18d2" args="(stp_image_t *image)" -->
<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="structstp__image.html">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><!-- doxytag: member="image.h::stp_image_get_row" ref="ga01d72a16de9e98722859ca651561e8f5" args="(stp_image_t *image, unsigned char *data, size_t limit, int row)" -->
<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="structstp__image.html">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><!-- doxytag: member="image.h::stp_image_height" ref="gaf9dcdf718ad99df9eb71fc542d5b47e1" args="(stp_image_t *image)" -->
<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="structstp__image.html">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><!-- doxytag: member="image.h::stp_image_init" ref="gad257f72ac5272e94ff9314f8ecd24f1e" args="(stp_image_t *image)" -->
<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="structstp__image.html">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><!-- doxytag: member="image.h::stp_image_reset" ref="gaf2fc433dba580b9ec8e69aebc2e65338" args="(stp_image_t *image)" -->
<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="structstp__image.html">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><!-- doxytag: member="image.h::stp_image_width" ref="gabe86b2ff9a3a0c0e98248990f9be5652" args="(stp_image_t *image)" -->
<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="structstp__image.html">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>
<hr class="footer"/><address class="footer"><small>Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
