/usr/share/doc/libgutenprint-doc/reference/html/structstp__image.html is in libgutenprint-doc 5.2.13-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libgutenprint API Reference: stp_image Struct Reference</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libgutenprint API Reference
 <span id="projectnumber">5.2.13</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">stp_image Struct Reference<div class="ingroups"><a class="el" href="group__image.html">image</a></div></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="structstp__image.html#details">More...</a></p>
<p><code>#include <image.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a59dbf4b267e4883b14864386a7bb88a0"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html#a59dbf4b267e4883b14864386a7bb88a0">init</a> )(struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td></tr>
<tr class="memdesc:a59dbf4b267e4883b14864386a7bb88a0"><td class="mdescLeft"> </td><td class="mdescRight">This callback is used to perform any initialization required by the image layer for the image. <a href="#a59dbf4b267e4883b14864386a7bb88a0">More...</a><br /></td></tr>
<tr class="separator:a59dbf4b267e4883b14864386a7bb88a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7472e5ca54908d9d59d93b7953097971"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html#a7472e5ca54908d9d59d93b7953097971">reset</a> )(struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td></tr>
<tr class="memdesc:a7472e5ca54908d9d59d93b7953097971"><td class="mdescLeft"> </td><td class="mdescRight">This callback is called to reset the image to the beginning. <a href="#a7472e5ca54908d9d59d93b7953097971">More...</a><br /></td></tr>
<tr class="separator:a7472e5ca54908d9d59d93b7953097971"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e1b0b04d4ab722fe32b3fde6ab537da"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html#a2e1b0b04d4ab722fe32b3fde6ab537da">width</a> )(struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td></tr>
<tr class="memdesc:a2e1b0b04d4ab722fe32b3fde6ab537da"><td class="mdescLeft"> </td><td class="mdescRight">This callback returns the width of the image in pixels. <a href="#a2e1b0b04d4ab722fe32b3fde6ab537da">More...</a><br /></td></tr>
<tr class="separator:a2e1b0b04d4ab722fe32b3fde6ab537da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ac621f128e83600cc981baf95a7d0bd"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html#a9ac621f128e83600cc981baf95a7d0bd">height</a> )(struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td></tr>
<tr class="memdesc:a9ac621f128e83600cc981baf95a7d0bd"><td class="mdescLeft"> </td><td class="mdescRight">This callback returns the height of the image in pixels. <a href="#a9ac621f128e83600cc981baf95a7d0bd">More...</a><br /></td></tr>
<tr class="separator:a9ac621f128e83600cc981baf95a7d0bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55e08f22ca7450018e4a8fd7479cea01"><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="structstp__image.html#a55e08f22ca7450018e4a8fd7479cea01">get_row</a> )(struct <a class="el" href="structstp__image.html">stp_image</a> *image, unsigned char *data, size_t byte_limit, int row)</td></tr>
<tr class="memdesc:a55e08f22ca7450018e4a8fd7479cea01"><td class="mdescLeft"> </td><td class="mdescRight">This callback transfers the data from the image to the gimp-print library. <a href="#a55e08f22ca7450018e4a8fd7479cea01">More...</a><br /></td></tr>
<tr class="separator:a55e08f22ca7450018e4a8fd7479cea01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace1dbc5b42be0242c60635d278b835bb"><td class="memItemLeft" align="right" valign="top">const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html#ace1dbc5b42be0242c60635d278b835bb">get_appname</a> )(struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td></tr>
<tr class="memdesc:ace1dbc5b42be0242c60635d278b835bb"><td class="mdescLeft"> </td><td class="mdescRight">This callback returns the name of the application. <a href="#ace1dbc5b42be0242c60635d278b835bb">More...</a><br /></td></tr>
<tr class="separator:ace1dbc5b42be0242c60635d278b835bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a006dbb0b5d39ca42d9c606b0c660f558"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html#a006dbb0b5d39ca42d9c606b0c660f558">conclude</a> )(struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td></tr>
<tr class="memdesc:a006dbb0b5d39ca42d9c606b0c660f558"><td class="mdescLeft"> </td><td class="mdescRight">This callback is called at the end of each page. <a href="#a006dbb0b5d39ca42d9c606b0c660f558">More...</a><br /></td></tr>
<tr class="separator:a006dbb0b5d39ca42d9c606b0c660f558"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab18e6ee35037589bf485213022e2d871"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__image.html#ab18e6ee35037589bf485213022e2d871">rep</a></td></tr>
<tr class="memdesc:ab18e6ee35037589bf485213022e2d871"><td class="mdescLeft"> </td><td class="mdescRight">A pointer to an application-specific state information that might need to be associated with the image object. <a href="#ab18e6ee35037589bf485213022e2d871">More...</a><br /></td></tr>
<tr class="separator:ab18e6ee35037589bf485213022e2d871"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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><h2 class="groupheader">Field Documentation</h2>
<a id="a006dbb0b5d39ca42d9c606b0c660f558"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a006dbb0b5d39ca42d9c606b0c660f558">◆ </a></span>conclude</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* stp_image::conclude) (struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback is called at the end of each page. </p>
</div>
</div>
<a id="ace1dbc5b42be0242c60635d278b835bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace1dbc5b42be0242c60635d278b835bb">◆ </a></span>get_appname</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char*(* stp_image::get_appname) (struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback returns the name of the application. </p>
<p>This is embedded in the output by some drivers. </p>
</div>
</div>
<a id="a55e08f22ca7450018e4a8fd7479cea01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55e08f22ca7450018e4a8fd7479cea01">◆ </a></span>get_row</h2>
<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) (struct <a class="el" href="structstp__image.html">stp_image</a> *image, unsigned char *data, size_t byte_limit, int row)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback transfers the data from the image to the gimp-print library. </p>
<p>It is called from the driver layer. It should copy WIDTH (as returned by the <a class="el" href="structstp__image.html#a2e1b0b04d4ab722fe32b3fde6ab537da" title="This callback returns the width of the image in pixels. ">width()</a> member) pixels of data into the data buffer. It normally returns STP_IMAGE_STATUS_OK; if something goes wrong, or the application wishes to stop producing any further output (e. g. because the user cancelled the print job), it should return STP_IMAGE_STATUS_ABORT. This will cause the driver to flush any remaining data to the output. It will always request rows in monotonically ascending order, but it may skip rows (if, for example, the resolution of the input is higher than the resolution of the output). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>the image in use. </td></tr>
<tr><td class="paramname">data</td><td>a pointer to <a class="el" href="structstp__image.html#a2e1b0b04d4ab722fe32b3fde6ab537da" title="This callback returns the width of the image in pixels. ">width()</a> bytes of pixel data. </td></tr>
<tr><td class="paramname">byte_limit</td><td>(image width * number of channels). </td></tr>
<tr><td class="paramname">row</td><td>(unused). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9ac621f128e83600cc981baf95a7d0bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ac621f128e83600cc981baf95a7d0bd">◆ </a></span>height</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* stp_image::height) (struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback returns the height of the image in pixels. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>the image in use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a59dbf4b267e4883b14864386a7bb88a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59dbf4b267e4883b14864386a7bb88a0">◆ </a></span>init</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* stp_image::init) (struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback is used to perform any initialization required by the image layer for the image. </p>
<p>It will be called once per image. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>the image in use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab18e6ee35037589bf485213022e2d871"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab18e6ee35037589bf485213022e2d871">◆ </a></span>rep</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* stp_image::rep</td>
</tr>
</table>
</div><div class="memdoc">
<p>A pointer to an application-specific state information that might need to be associated with the image object. </p>
</div>
</div>
<a id="a7472e5ca54908d9d59d93b7953097971"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7472e5ca54908d9d59d93b7953097971">◆ </a></span>reset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* stp_image::reset) (struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback is called to reset the image to the beginning. </p>
<p>It may (in principle) be called multiple times if a page is being printed more than once. </p><dl class="section warning"><dt>Warning</dt><dd>The <a class="el" href="structstp__image.html#a7472e5ca54908d9d59d93b7953097971" title="This callback is called to reset the image to the beginning. ">reset()</a> call may be removed in the future. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>the image in use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2e1b0b04d4ab722fe32b3fde6ab537da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e1b0b04d4ab722fe32b3fde6ab537da">◆ </a></span>width</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* stp_image::width) (struct <a class="el" href="structstp__image.html">stp_image</a> *image)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback returns the width of the image in pixels. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>the image in use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/gutenprint/<a class="el" href="image_8h.html">image.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<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.8.13
</small></address>
</body>
</html>
|