doc/help/api-raster.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
   2 <html>
   3 <!-- SECTION: Programming -->
   4 <head>
   5         <title>Raster API</title>
   6         <meta name='keywords' content='Programming'>
   7         <meta name='creator' content='Mini-XML v2.3'>
   8         <style type='text/css'><!--
   9         h1, h2, h3, p { font-family: sans-serif; text-align: justify; }
  10         tt, pre a:link, pre a:visited, tt a:link, tt a:visited { font-weight: bold; color: #7f0000; }
  11         pre { font-weight: bold; color: #7f0000; margin-left: 2em; }
  12         span.info { background: #000000; border: solid thin #000000; color: #ffffff; font-size: 80%; font-style: italic; font-weight: bold; white-space: nowrap; }
  13         h3 span.info { float: right; font-size: 100%; }
  14         h1.title, h2.title, h3.title { border-bottom: solid 2px #000000; }
  15         --></style>
  16 </head>
  17 <body>
  18 <!--
  19   "$Id$"
  20
  21   Raster API introduction for the Common UNIX Printing System (CUPS).
  22
  23   Copyright 1997-2006 by Easy Software Products.
  24
  25   These coded instructions, statements, and computer programs are the
  26   property of Easy Software Products and are protected by Federal
  27   copyright law.  Distribution and use rights are outlined in the file
  28   "LICENSE.txt" which should have been included with this file.  If this
  29   file is missing or damaged please contact Easy Software Products
  30   at:
  31
  32       Attn: CUPS Licensing Information
  33       Easy Software Products
  34       44141 Airport View Drive, Suite 204
  35       Hollywood, Maryland 20636 USA
  36
  37       Voice: (301) 373-9600
  38       EMail: cups-info@cups.org
  39         WWW: http://www.cups.org
  40 -->
  41
  42 <h2 class='title'>Introduction</h2>
  43
  44 <p>The CUPS raster API provides a standard interface for reading
  45 and writing CUPS raster streams which are used for printing to
  46 raster printers. Because the raster format is updated from time
  47 to time, it is important to use this API to avoid
  48 incompatibilities with newer versions of CUPS.</p>
  49
  50 <h2 class='title'>General Usage</h2>
  51
  52 <p>The <var>&lt;cups/raster.h&gt;</var> header file must be
  53 included to use the <tt>cupsRaster</tt> functions.</p>
  54
  55 <p>Programs using these functions must be linked to the CUPS
  56 imaging library: <var>libcupsimage.a</var>,
  57 <var>libcupsimage.so.2</var>, <var>libcupsimage.2.dylib</var>,
  58 <var>libcupsimage_s.a</var>, or <var>libcupsimage2.lib</var>
  59 depending on the platform. The following command compiles
  60 <var>myprogram.c</var> using GCC and the CUPS imaging
  61 library:</p>
  62
  63 <pre class='command'>
  64 <kbd>gcc -o myprogram myprogram.c -lcupsimage</kbd>
  65 </pre>
  66
  67 <h2 class='title'>Compatibility</h2>
  68
  69 <p>Unless otherwise specified, the raster API functions require
  70 CUPS 1.1 or higher.</p>
  71
  72 <h2 class='title'>Licensing</h2>
  73
  74 <p>The CUPS raster API is provided under the terms of the GNU
  75 Library General Public License, with exceptions for MacOS X-based
  76 programs. Please see the CUPS license agreement for more
  77 information.</p>
  78 <h2 class='title'>Contents</h2>
  79 <ul>
  80         <li><a href='#ENUMERATIONS'>Enumerations</a></li>
  81         <li><a href='#FUNCTIONS'>Functions</a></li>
  82         <li><a href='#STRUCTURES'>Structures</a></li>
  83         <li><a href='#TYPES'>Types</a></li>
  84 </ul>
  85 <!-- NEW PAGE -->
  86 <h2 class='title'><a name='ENUMERATIONS'>Enumerations</a></h2>
  87 <ul>
  88         <li><a href='#cups_adv_e'><tt>cups_adv_e</tt></a> </li>
  89         <li><a href='#cups_bool_e'><tt>cups_bool_e</tt></a> </li>
  90         <li><a href='#cups_cspace_e'><tt>cups_cspace_e</tt></a> </li>
  91         <li><a href='#cups_cut_e'><tt>cups_cut_e</tt></a> </li>
  92         <li><a href='#cups_edge_e'><tt>cups_edge_e</tt></a> </li>
  93         <li><a href='#cups_jog_e'><tt>cups_jog_e</tt></a> </li>
  94         <li><a href='#cups_mode_e'><tt>cups_mode_e</tt></a> </li>
  95         <li><a href='#cups_order_e'><tt>cups_order_e</tt></a> </li>
  96         <li><a href='#cups_orient_e'><tt>cups_orient_e</tt></a> </li>
  97 </ul>
  98 <!-- NEW PAGE -->
  99 <h3 class='title'><a name='cups_adv_e'>cups_adv_e</a></h3>
 100 <h4>Description</h4>
 101 <p></p>
 102 <h4>Values</h4>
 103 <div class='table'><table align='center' border='1' width='80%'>
 104 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 105 <tbody>
 106 <tr><td><tt>CUPS_ADVANCE_FILE</tt> </td><td>Advance the roll after this file</td></tr>
 107 <tr><td><tt>CUPS_ADVANCE_JOB</tt> </td><td>Advance the roll after this job</td></tr>
 108 <tr><td><tt>CUPS_ADVANCE_NONE</tt> </td><td>Never advance the roll</td></tr>
 109 <tr><td><tt>CUPS_ADVANCE_PAGE</tt> </td><td>Advance the roll after this page</td></tr>
 110 <tr><td><tt>CUPS_ADVANCE_SET</tt> </td><td>Advance the roll after this set</td></tr>
 111 </tbody></table></div>
 112 <!-- NEW PAGE -->
 113 <h3 class='title'><a name='cups_bool_e'>cups_bool_e</a></h3>
 114 <h4>Description</h4>
 115 <p>Types...</p>
 116 <h4>Values</h4>
 117 <div class='table'><table align='center' border='1' width='80%'>
 118 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 119 <tbody>
 120 <tr><td><tt>CUPS_FALSE</tt> </td><td>Logical false</td></tr>
 121 <tr><td><tt>CUPS_TRUE</tt> </td><td>Logical true</td></tr>
 122 </tbody></table></div>
 123 <!-- NEW PAGE -->
 124 <h3 class='title'><a name='cups_cspace_e'>cups_cspace_e</a></h3>
 125 <h4>Description</h4>
 126 <p></p>
 127 <h4>Values</h4>
 128 <div class='table'><table align='center' border='1' width='80%'>
 129 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 130 <tbody>
 131 <tr><td><tt>CUPS_CSPACE_CIELab</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>CIE Lab </td></tr>
 132 <tr><td><tt>CUPS_CSPACE_CIEXYZ</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>CIE XYZ </td></tr>
 133 <tr><td><tt>CUPS_CSPACE_CMY</tt> </td><td>Cyan, magenta, yellow</td></tr>
 134 <tr><td><tt>CUPS_CSPACE_CMYK</tt> </td><td>Cyan, magenta, yellow, black</td></tr>
 135 <tr><td><tt>CUPS_CSPACE_GMCK</tt> </td><td>Gold, magenta, yellow, black</td></tr>
 136 <tr><td><tt>CUPS_CSPACE_GMCS</tt> </td><td>Gold, magenta, yellow, silver</td></tr>
 137 <tr><td><tt>CUPS_CSPACE_GOLD</tt> </td><td>Gold foil</td></tr>
 138 <tr><td><tt>CUPS_CSPACE_ICC1</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 1 color </td></tr>
 139 <tr><td><tt>CUPS_CSPACE_ICC2</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 2 colors </td></tr>
 140 <tr><td><tt>CUPS_CSPACE_ICC3</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 3 colors </td></tr>
 141 <tr><td><tt>CUPS_CSPACE_ICC4</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 4 colors </td></tr>
 142 <tr><td><tt>CUPS_CSPACE_ICC5</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 5 colors </td></tr>
 143 <tr><td><tt>CUPS_CSPACE_ICC6</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 6 colors </td></tr>
 144 <tr><td><tt>CUPS_CSPACE_ICC7</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 7 colors </td></tr>
 145 <tr><td><tt>CUPS_CSPACE_ICC8</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 8 colors </td></tr>
 146 <tr><td><tt>CUPS_CSPACE_ICC9</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 9 colors </td></tr>
 147 <tr><td><tt>CUPS_CSPACE_ICCA</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 10 colors </td></tr>
 148 <tr><td><tt>CUPS_CSPACE_ICCB</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 11 colors </td></tr>
 149 <tr><td><tt>CUPS_CSPACE_ICCC</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 12 colors </td></tr>
 150 <tr><td><tt>CUPS_CSPACE_ICCD</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 13 colors </td></tr>
 151 <tr><td><tt>CUPS_CSPACE_ICCE</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 14 colors </td></tr>
 152 <tr><td><tt>CUPS_CSPACE_ICCF</tt> <span class='info'>&nbsp;CUPS 1.1.19&nbsp;</span></td><td>ICC-based, 15 colors </td></tr>
 153 <tr><td><tt>CUPS_CSPACE_K</tt> </td><td>Black</td></tr>
 154 <tr><td><tt>CUPS_CSPACE_KCMY</tt> </td><td>Black, cyan, magenta, yellow</td></tr>
 155 <tr><td><tt>CUPS_CSPACE_KCMYcm</tt> </td><td>Black, cyan, magenta, yellow, *
 156 light-cyan, light-magenta</td></tr>
 157 <tr><td><tt>CUPS_CSPACE_RGB</tt> </td><td>Red, green, blue</td></tr>
 158 <tr><td><tt>CUPS_CSPACE_RGBA</tt> </td><td>Red, green, blue, alpha</td></tr>
 159 <tr><td><tt>CUPS_CSPACE_RGBW</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Red, green, blue, white </td></tr>
 160 <tr><td><tt>CUPS_CSPACE_SILVER</tt> </td><td>Silver foil</td></tr>
 161 <tr><td><tt>CUPS_CSPACE_W</tt> </td><td>Luminance</td></tr>
 162 <tr><td><tt>CUPS_CSPACE_WHITE</tt> </td><td>White ink (as black)</td></tr>
 163 <tr><td><tt>CUPS_CSPACE_YMC</tt> </td><td>Yellow, magenta, cyan</td></tr>
 164 <tr><td><tt>CUPS_CSPACE_YMCK</tt> </td><td>Yellow, magenta, cyan, black</td></tr>
 165 </tbody></table></div>
 166 <!-- NEW PAGE -->
 167 <h3 class='title'><a name='cups_cut_e'>cups_cut_e</a></h3>
 168 <h4>Description</h4>
 169 <p></p>
 170 <h4>Values</h4>
 171 <div class='table'><table align='center' border='1' width='80%'>
 172 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 173 <tbody>
 174 <tr><td><tt>CUPS_CUT_FILE</tt> </td><td>Cut the roll after this file</td></tr>
 175 <tr><td><tt>CUPS_CUT_JOB</tt> </td><td>Cut the roll after this job</td></tr>
 176 <tr><td><tt>CUPS_CUT_NONE</tt> </td><td>Never cut the roll</td></tr>
 177 <tr><td><tt>CUPS_CUT_PAGE</tt> </td><td>Cut the roll after this page</td></tr>
 178 <tr><td><tt>CUPS_CUT_SET</tt> </td><td>Cut the roll after this set</td></tr>
 179 </tbody></table></div>
 180 <!-- NEW PAGE -->
 181 <h3 class='title'><a name='cups_edge_e'>cups_edge_e</a></h3>
 182 <h4>Description</h4>
 183 <p></p>
 184 <h4>Values</h4>
 185 <div class='table'><table align='center' border='1' width='80%'>
 186 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 187 <tbody>
 188 <tr><td><tt>CUPS_EDGE_BOTTOM</tt> </td><td>Leading edge is the bottom of the page</td></tr>
 189 <tr><td><tt>CUPS_EDGE_LEFT</tt> </td><td>Leading edge is the left of the page</td></tr>
 190 <tr><td><tt>CUPS_EDGE_RIGHT</tt> </td><td>Leading edge is the right of the page</td></tr>
 191 <tr><td><tt>CUPS_EDGE_TOP</tt> </td><td>Leading edge is the top of the page</td></tr>
 192 </tbody></table></div>
 193 <!-- NEW PAGE -->
 194 <h3 class='title'><a name='cups_jog_e'>cups_jog_e</a></h3>
 195 <h4>Description</h4>
 196 <p></p>
 197 <h4>Values</h4>
 198 <div class='table'><table align='center' border='1' width='80%'>
 199 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 200 <tbody>
 201 <tr><td><tt>CUPS_JOG_FILE</tt> </td><td>Move pages after this file</td></tr>
 202 <tr><td><tt>CUPS_JOG_JOB</tt> </td><td>Move pages after this job</td></tr>
 203 <tr><td><tt>CUPS_JOG_NONE</tt> </td><td>Never move pages</td></tr>
 204 <tr><td><tt>CUPS_JOG_SET</tt> </td><td>Move pages after this set</td></tr>
 205 </tbody></table></div>
 206 <!-- NEW PAGE -->
 207 <h3 class='title'><a name='cups_mode_e'>cups_mode_e</a></h3>
 208 <h4>Description</h4>
 209 <p>Raster modes</p>
 210 <h4>Values</h4>
 211 <div class='table'><table align='center' border='1' width='80%'>
 212 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 213 <tbody>
 214 <tr><td><tt>CUPS_RASTER_READ</tt> </td><td>Open stream for reading</td></tr>
 215 <tr><td><tt>CUPS_RASTER_WRITE</tt> </td><td>Open stream for writing</td></tr>
 216 <tr><td><tt>CUPS_RASTER_WRITE_COMPRESSED</tt> <span class='info'>&nbsp;CUPS 1.3&nbsp;</span></td><td>Open stream for compressed writing </td></tr>
 217 </tbody></table></div>
 218 <!-- NEW PAGE -->
 219 <h3 class='title'><a name='cups_order_e'>cups_order_e</a></h3>
 220 <h4>Description</h4>
 221 <p></p>
 222 <h4>Values</h4>
 223 <div class='table'><table align='center' border='1' width='80%'>
 224 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 225 <tbody>
 226 <tr><td><tt>CUPS_ORDER_BANDED</tt> </td><td>CCC MMM YYY KKK ...</td></tr>
 227 <tr><td><tt>CUPS_ORDER_CHUNKED</tt> </td><td>CMYK CMYK CMYK ...</td></tr>
 228 <tr><td><tt>CUPS_ORDER_PLANAR</tt> </td><td>CCC ... MMM ... YYY ... KKK ...</td></tr>
 229 </tbody></table></div>
 230 <!-- NEW PAGE -->
 231 <h3 class='title'><a name='cups_orient_e'>cups_orient_e</a></h3>
 232 <h4>Description</h4>
 233 <p></p>
 234 <h4>Values</h4>
 235 <div class='table'><table align='center' border='1' width='80%'>
 236 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 237 <tbody>
 238 <tr><td><tt>CUPS_ORIENT_0</tt> </td><td>Don't rotate the page</td></tr>
 239 <tr><td><tt>CUPS_ORIENT_180</tt> </td><td>Turn the page upside down</td></tr>
 240 <tr><td><tt>CUPS_ORIENT_270</tt> </td><td>Rotate the page clockwise</td></tr>
 241 <tr><td><tt>CUPS_ORIENT_90</tt> </td><td>Rotate the page counter-clockwise</td></tr>
 242 </tbody></table></div>
 243 <!-- NEW PAGE -->
 244 <h2 class='title'><a name='FUNCTIONS'>Functions</a></h2>
 245 <ul>
 246         <li><a href='#cupsRasterClose'><tt>cupsRasterClose()</tt></a> </li>
 247         <li><a href='#cupsRasterInterpretPPD'><tt>cupsRasterInterpretPPD()</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 248         <li><a href='#cupsRasterOpen'><tt>cupsRasterOpen()</tt></a> </li>
 249         <li><a href='#cupsRasterReadHeader'><tt>cupsRasterReadHeader()</tt></a> </li>
 250         <li><a href='#cupsRasterReadHeader2'><tt>cupsRasterReadHeader2()</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 251         <li><a href='#cupsRasterReadPixels'><tt>cupsRasterReadPixels()</tt></a> </li>
 252         <li><a href='#cupsRasterWriteHeader'><tt>cupsRasterWriteHeader()</tt></a> </li>
 253         <li><a href='#cupsRasterWriteHeader2'><tt>cupsRasterWriteHeader2()</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 254         <li><a href='#cupsRasterWritePixels'><tt>cupsRasterWritePixels()</tt></a> </li>
 255 </ul>
 256 <!-- NEW PAGE -->
 257 <h3 class='title'><a name='cupsRasterClose'>cupsRasterClose()</a></h3>
 258 <h4>Description</h4>
 259 <p>Close a raster stream.</p>
 260 <h4>Syntax</h4>
 261 <pre>
 262 void
 263 cupsRasterClose(
 264     <a href='#cups_raster_t'>cups_raster_t</a> * r);
 265 </pre>
 266 <h4>Arguments</h4>
 267 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 268 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 269 <tbody>
 270 <tr><td><tt>r</tt></td><td>Stream to close</td></tr>
 271 </tbody></table></div>
 272 <h4>Returns</h4>
 273 <p>Nothing.</p>
 274 <!-- NEW PAGE -->
 275 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cupsRasterInterpretPPD'>cupsRasterInterpretPPD()</a></h3>
 276 <h4>Description</h4>
 277 <p>Interpret PPD commands to create a page header.
 278
 279 This function does not mark the options in the PPD using the &quot;num_options&quot;
 280 and &quot;options&quot; arguments.  Instead, mark the options prior to calling
 281 cupsRasterInterpretPPD() - this allows you to do per-page options
 282 without manipulating the options array.
 283
 284 The &quot;func&quot; argument specifies an optional callback function that is
 285 called prior to the computation of the final raster data.  The function
 286 can make changes to the cups_page_header2_t data as needed to use a
 287 supported raster format and then returns 0 on success and -1 if the
 288 requested attributes cannot be supported.
 289
 290 </p>
 291 <h4>Syntax</h4>
 292 <pre>
 293 int
 294 cupsRasterInterpretPPD(
 295     <a href='#cups_page_header2_t'>cups_page_header2_t</a> * h,
 296     ppd_file_t * ppd,
 297     int num_options,
 298     cups_option_t * options,
 299     <a href='#cups_interpret_cb_t'>cups_interpret_cb_t</a> func);
 300 </pre>
 301 <h4>Arguments</h4>
 302 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 303 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 304 <tbody>
 305 <tr><td><tt>h</tt></td><td>Page header</td></tr>
 306 <tr><td><tt>ppd</tt></td><td>PPD file</td></tr>
 307 <tr><td><tt>num_options</tt></td><td>Number of options</td></tr>
 308 <tr><td><tt>options</tt></td><td>Options</td></tr>
 309 <tr><td><tt>func</tt></td><td>Optional page header callback</td></tr>
 310 </tbody></table></div>
 311 <h4>Returns</h4>
 312 <p>0 on success, -1 on failure</p>
 313 <!-- NEW PAGE -->
 314 <h3 class='title'><a name='cupsRasterOpen'>cupsRasterOpen()</a></h3>
 315 <h4>Description</h4>
 316 <p>Open a raster stream.</p>
 317 <h4>Syntax</h4>
 318 <pre>
 319 <a href='#cups_raster_t'>cups_raster_t</a> *
 320 cupsRasterOpen(
 321     int fd,
 322     cups_mode_t mode);
 323 </pre>
 324 <h4>Arguments</h4>
 325 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 326 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 327 <tbody>
 328 <tr><td><tt>fd</tt></td><td>File descriptor</td></tr>
 329 <tr><td><tt>mode</tt></td><td>Mode</td></tr>
 330 </tbody></table></div>
 331 <h4>Returns</h4>
 332 <p>New stream</p>
 333 <!-- NEW PAGE -->
 334 <h3 class='title'><a name='cupsRasterReadHeader'>cupsRasterReadHeader()</a></h3>
 335 <h4>Description</h4>
 336 <p>Read a raster page header and store it in a
 337 V1 page header structure.</p>
 338 <h4>Syntax</h4>
 339 <pre>
 340 unsigned
 341 cupsRasterReadHeader(
 342     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 343     <a href='#cups_page_header_t'>cups_page_header_t</a> * h);
 344 </pre>
 345 <h4>Arguments</h4>
 346 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 347 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 348 <tbody>
 349 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 350 <tr><td><tt>h</tt></td><td>Pointer to header data</td></tr>
 351 </tbody></table></div>
 352 <h4>Returns</h4>
 353 <p>1 on success, 0 on fail</p>
 354 <!-- NEW PAGE -->
 355 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cupsRasterReadHeader2'>cupsRasterReadHeader2()</a></h3>
 356 <h4>Description</h4>
 357 <p>Read a raster page header and store it in a
 358 V2 page header structure.
 359
 360 </p>
 361 <h4>Syntax</h4>
 362 <pre>
 363 unsigned
 364 cupsRasterReadHeader2(
 365     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 366     <a href='#cups_page_header2_t'>cups_page_header2_t</a> * h);
 367 </pre>
 368 <h4>Arguments</h4>
 369 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 370 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 371 <tbody>
 372 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 373 <tr><td><tt>h</tt></td><td>Pointer to header data</td></tr>
 374 </tbody></table></div>
 375 <h4>Returns</h4>
 376 <p>1 on success, 0 on fail</p>
 377 <!-- NEW PAGE -->
 378 <h3 class='title'><a name='cupsRasterReadPixels'>cupsRasterReadPixels()</a></h3>
 379 <h4>Description</h4>
 380 <p>Read raster pixels.</p>
 381 <h4>Syntax</h4>
 382 <pre>
 383 unsigned
 384 cupsRasterReadPixels(
 385     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 386     unsigned char * p,
 387     unsigned len);
 388 </pre>
 389 <h4>Arguments</h4>
 390 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 391 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 392 <tbody>
 393 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 394 <tr><td><tt>p</tt></td><td>Pointer to pixel buffer</td></tr>
 395 <tr><td><tt>len</tt></td><td>Number of bytes to read</td></tr>
 396 </tbody></table></div>
 397 <h4>Returns</h4>
 398 <p>Number of bytes read</p>
 399 <!-- NEW PAGE -->
 400 <h3 class='title'><a name='cupsRasterWriteHeader'>cupsRasterWriteHeader()</a></h3>
 401 <h4>Description</h4>
 402 <p>Write a raster page header from a V1 page
 403 header structure.</p>
 404 <h4>Syntax</h4>
 405 <pre>
 406 unsigned
 407 cupsRasterWriteHeader(
 408     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 409     <a href='#cups_page_header_t'>cups_page_header_t</a> * h);
 410 </pre>
 411 <h4>Arguments</h4>
 412 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 413 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 414 <tbody>
 415 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 416 <tr><td><tt>h</tt></td><td>Raster page header</td></tr>
 417 </tbody></table></div>
 418 <h4>Returns</h4>
 419 <p>1 on success, 0 on failure</p>
 420 <!-- NEW PAGE -->
 421 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cupsRasterWriteHeader2'>cupsRasterWriteHeader2()</a></h3>
 422 <h4>Description</h4>
 423 <p>Write a raster page header from a V2 page
 424 header structure.
 425
 426 </p>
 427 <h4>Syntax</h4>
 428 <pre>
 429 unsigned
 430 cupsRasterWriteHeader2(
 431     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 432     <a href='#cups_page_header2_t'>cups_page_header2_t</a> * h);
 433 </pre>
 434 <h4>Arguments</h4>
 435 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 436 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 437 <tbody>
 438 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 439 <tr><td><tt>h</tt></td><td>Raster page header</td></tr>
 440 </tbody></table></div>
 441 <h4>Returns</h4>
 442 <p>1 on success, 0 on failure</p>
 443 <!-- NEW PAGE -->
 444 <h3 class='title'><a name='cupsRasterWritePixels'>cupsRasterWritePixels()</a></h3>
 445 <h4>Description</h4>
 446 <p>Write raster pixels.</p>
 447 <h4>Syntax</h4>
 448 <pre>
 449 unsigned
 450 cupsRasterWritePixels(
 451     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 452     unsigned char * p,
 453     unsigned len);
 454 </pre>
 455 <h4>Arguments</h4>
 456 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 457 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 458 <tbody>
 459 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 460 <tr><td><tt>p</tt></td><td>Bytes to write</td></tr>
 461 <tr><td><tt>len</tt></td><td>Number of bytes to write</td></tr>
 462 </tbody></table></div>
 463 <h4>Returns</h4>
 464 <p>Number of bytes written</p>
 465 <!-- NEW PAGE -->
 466 <h2 class='title'><a name='STRUCTURES'>Structures</a></h2>
 467 <ul>
 468         <li><a href='#cups_page_header2_s'><tt>cups_page_header2_s</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 469         <li><a href='#cups_page_header_s'><tt>cups_page_header_s</tt></a> </li>
 470 </ul>
 471 <!-- NEW PAGE -->
 472 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cups_page_header2_s'>cups_page_header2_s</a></h3>
 473 <h4>Description</h4>
 474 <p>Version 2 Page Header </p>
 475 <h4>Definition</h4>
 476 <pre>
 477 struct cups_page_header2_s
 478 {
 479   unsigned AdvanceDistance;
 480   cups_adv_t AdvanceMedia;
 481   cups_bool_t Collate;
 482   cups_cut_t CutMedia;
 483   cups_bool_t Duplex;
 484   unsigned HWResolution[2];
 485   unsigned ImagingBoundingBox[4];
 486   cups_bool_t InsertSheet;
 487   cups_jog_t Jog;
 488   cups_edge_t LeadingEdge;
 489   cups_bool_t ManualFeed;
 490   unsigned Margins[2];
 491   char MediaClass[64];
 492   char MediaColor[64];
 493   unsigned MediaPosition;
 494   char MediaType[64];
 495   unsigned MediaWeight;
 496   cups_bool_t MirrorPrint;
 497   cups_bool_t NegativePrint;
 498   unsigned NumCopies;
 499   cups_orient_t Orientation;
 500   cups_bool_t OutputFaceUp;
 501   char OutputType[64];
 502   unsigned PageSize[2];
 503   cups_bool_t Separations;
 504   cups_bool_t TraySwitch;
 505   cups_bool_t Tumble;
 506   unsigned cupsBitsPerColor;
 507   unsigned cupsBitsPerPixel;
 508   float cupsBorderlessScalingFactor;
 509   unsigned cupsBytesPerLine;
 510   cups_order_t cupsColorOrder;
 511   cups_cspace_t cupsColorSpace;
 512   unsigned cupsCompression;
 513   unsigned cupsHeight;
 514   float cupsImagingBBox[4];
 515   unsigned cupsInteger[16];
 516   char cupsMarkerType[64];
 517   unsigned cupsMediaType;
 518   unsigned cupsNumColors;
 519   char cupsPageSizeName[64];
 520   float cupsPageSize[2];
 521   float cupsReal[16];
 522   char cupsRenderingIntent[64];
 523   unsigned cupsRowCount;
 524   unsigned cupsRowFeed;
 525   unsigned cupsRowStep;
 526   char cupsString[16][64];
 527   unsigned cupsWidth;
 528 };
 529 </pre>
 530 <h4>Members</h4>
 531 <div class='table'><table align='center' border='1' width='80%'>
 532 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 533 <tbody>
 534 <tr><td><tt>AdvanceDistance</tt> </td><td>AdvanceDistance value in points</td></tr>
 535 <tr><td><tt>AdvanceMedia</tt> </td><td>AdvanceMedia value (see above)</td></tr>
 536 <tr><td><tt>Collate</tt> </td><td>Collated copies value</td></tr>
 537 <tr><td><tt>CutMedia</tt> </td><td>CutMedia value (see above)</td></tr>
 538 <tr><td><tt>Duplex</tt> </td><td>Duplexed (double-sided) value</td></tr>
 539 <tr><td><tt>HWResolution[2]</tt> </td><td>Resolution in dots-per-inch</td></tr>
 540 <tr><td><tt>ImagingBoundingBox[4]</tt> </td><td>Pixel region that is painted (points)</td></tr>
 541 <tr><td><tt>InsertSheet</tt> </td><td>InsertSheet value</td></tr>
 542 <tr><td><tt>Jog</tt> </td><td>Jog value (see above)</td></tr>
 543 <tr><td><tt>LeadingEdge</tt> </td><td>LeadingEdge value (see above)</td></tr>
 544 <tr><td><tt>ManualFeed</tt> </td><td>ManualFeed value</td></tr>
 545 <tr><td><tt>Margins[2]</tt> </td><td>Lower-lefthand margins in points</td></tr>
 546 <tr><td><tt>MediaClass[64]</tt> </td><td>MediaClass string</td></tr>
 547 <tr><td><tt>MediaColor[64]</tt> </td><td>MediaColor string</td></tr>
 548 <tr><td><tt>MediaPosition</tt> </td><td>MediaPosition value</td></tr>
 549 <tr><td><tt>MediaType[64]</tt> </td><td>MediaType string</td></tr>
 550 <tr><td><tt>MediaWeight</tt> </td><td>MediaWeight value in grams/m^2</td></tr>
 551 <tr><td><tt>MirrorPrint</tt> </td><td>MirrorPrint value</td></tr>
 552 <tr><td><tt>NegativePrint</tt> </td><td>NegativePrint value</td></tr>
 553 <tr><td><tt>NumCopies</tt> </td><td>Number of copies to produce</td></tr>
 554 <tr><td><tt>Orientation</tt> </td><td>Orientation value (see above)</td></tr>
 555 <tr><td><tt>OutputFaceUp</tt> </td><td>OutputFaceUp value</td></tr>
 556 <tr><td><tt>OutputType[64]</tt> </td><td>OutputType string</td></tr>
 557 <tr><td><tt>PageSize[2]</tt> </td><td>Width and length of page in points</td></tr>
 558 <tr><td><tt>Separations</tt> </td><td>Separations value</td></tr>
 559 <tr><td><tt>TraySwitch</tt> </td><td>TraySwitch value</td></tr>
 560 <tr><td><tt>Tumble</tt> </td><td>Tumble value</td></tr>
 561 <tr><td><tt>cupsBitsPerColor</tt> </td><td>Number of bits for each color</td></tr>
 562 <tr><td><tt>cupsBitsPerPixel</tt> </td><td>Number of bits for each pixel</td></tr>
 563 <tr><td><tt>cupsBorderlessScalingFactor</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Scaling that was applied to page data </td></tr>
 564 <tr><td><tt>cupsBytesPerLine</tt> </td><td>Number of bytes per line</td></tr>
 565 <tr><td><tt>cupsColorOrder</tt> </td><td>Order of colors</td></tr>
 566 <tr><td><tt>cupsColorSpace</tt> </td><td>True colorspace</td></tr>
 567 <tr><td><tt>cupsCompression</tt> </td><td>Device compression to use</td></tr>
 568 <tr><td><tt>cupsHeight</tt> </td><td>Height of page image in pixels</td></tr>
 569 <tr><td><tt>cupsImagingBBox[4]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Floating point ImagingBoundingBox *
 570 (scaling factor not applied) </td></tr>
 571 <tr><td><tt>cupsInteger[16]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>User-defined integer values </td></tr>
 572 <tr><td><tt>cupsMarkerType[64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Ink/toner type </td></tr>
 573 <tr><td><tt>cupsMediaType</tt> </td><td>Media type code</td></tr>
 574 <tr><td><tt>cupsNumColors</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Number of colors </td></tr>
 575 <tr><td><tt>cupsPageSizeName[64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>PageSize name </td></tr>
 576 <tr><td><tt>cupsPageSize[2]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Floating point PageSize (scaling *
 577 factor not applied) </td></tr>
 578 <tr><td><tt>cupsReal[16]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>User-defined floating-point values </td></tr>
 579 <tr><td><tt>cupsRenderingIntent[64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Color rendering intent </td></tr>
 580 <tr><td><tt>cupsRowCount</tt> </td><td>Rows per band</td></tr>
 581 <tr><td><tt>cupsRowFeed</tt> </td><td>Feed between bands</td></tr>
 582 <tr><td><tt>cupsRowStep</tt> </td><td>Spacing between lines</td></tr>
 583 <tr><td><tt>cupsString[16][64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>User-defined string values </td></tr>
 584 <tr><td><tt>cupsWidth</tt> </td><td>Width of page image in pixels</td></tr>
 585 </tbody></table></div>
 586 <!-- NEW PAGE -->
 587 <h3 class='title'><a name='cups_page_header_s'>cups_page_header_s</a></h3>
 588 <h4>Description</h4>
 589 <p></p>
 590 <h4>Definition</h4>
 591 <pre>
 592 struct cups_page_header_s
 593 {
 594   unsigned AdvanceDistance;
 595   cups_adv_t AdvanceMedia;
 596   cups_bool_t Collate;
 597   cups_cut_t CutMedia;
 598   cups_bool_t Duplex;
 599   unsigned HWResolution[2];
 600   unsigned ImagingBoundingBox[4];
 601   cups_bool_t InsertSheet;
 602   cups_jog_t Jog;
 603   cups_edge_t LeadingEdge;
 604   cups_bool_t ManualFeed;
 605   unsigned Margins[2];
 606   char MediaClass[64];
 607   char MediaColor[64];
 608   unsigned MediaPosition;
 609   char MediaType[64];
 610   unsigned MediaWeight;
 611   cups_bool_t MirrorPrint;
 612   cups_bool_t NegativePrint;
 613   unsigned NumCopies;
 614   cups_orient_t Orientation;
 615   cups_bool_t OutputFaceUp;
 616   char OutputType[64];
 617   unsigned PageSize[2];
 618   cups_bool_t Separations;
 619   cups_bool_t TraySwitch;
 620   cups_bool_t Tumble;
 621   unsigned cupsBitsPerColor;
 622   unsigned cupsBitsPerPixel;
 623   unsigned cupsBytesPerLine;
 624   cups_order_t cupsColorOrder;
 625   cups_cspace_t cupsColorSpace;
 626   unsigned cupsCompression;
 627   unsigned cupsHeight;
 628   unsigned cupsMediaType;
 629   unsigned cupsRowCount;
 630   unsigned cupsRowFeed;
 631   unsigned cupsRowStep;
 632   unsigned cupsWidth;
 633 };
 634 </pre>
 635 <h4>Members</h4>
 636 <div class='table'><table align='center' border='1' width='80%'>
 637 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 638 <tbody>
 639 <tr><td><tt>AdvanceDistance</tt> </td><td>AdvanceDistance value in points</td></tr>
 640 <tr><td><tt>AdvanceMedia</tt> </td><td>AdvanceMedia value (see above)</td></tr>
 641 <tr><td><tt>Collate</tt> </td><td>Collated copies value</td></tr>
 642 <tr><td><tt>CutMedia</tt> </td><td>CutMedia value (see above)</td></tr>
 643 <tr><td><tt>Duplex</tt> </td><td>Duplexed (double-sided) value</td></tr>
 644 <tr><td><tt>HWResolution[2]</tt> </td><td>Resolution in dots-per-inch</td></tr>
 645 <tr><td><tt>ImagingBoundingBox[4]</tt> </td><td>Pixel region that is painted (points)</td></tr>
 646 <tr><td><tt>InsertSheet</tt> </td><td>InsertSheet value</td></tr>
 647 <tr><td><tt>Jog</tt> </td><td>Jog value (see above)</td></tr>
 648 <tr><td><tt>LeadingEdge</tt> </td><td>LeadingEdge value (see above)</td></tr>
 649 <tr><td><tt>ManualFeed</tt> </td><td>ManualFeed value</td></tr>
 650 <tr><td><tt>Margins[2]</tt> </td><td>Lower-lefthand margins in points</td></tr>
 651 <tr><td><tt>MediaClass[64]</tt> </td><td>MediaClass string</td></tr>
 652 <tr><td><tt>MediaColor[64]</tt> </td><td>MediaColor string</td></tr>
 653 <tr><td><tt>MediaPosition</tt> </td><td>MediaPosition value</td></tr>
 654 <tr><td><tt>MediaType[64]</tt> </td><td>MediaType string</td></tr>
 655 <tr><td><tt>MediaWeight</tt> </td><td>MediaWeight value in grams/m^2</td></tr>
 656 <tr><td><tt>MirrorPrint</tt> </td><td>MirrorPrint value</td></tr>
 657 <tr><td><tt>NegativePrint</tt> </td><td>NegativePrint value</td></tr>
 658 <tr><td><tt>NumCopies</tt> </td><td>Number of copies to produce</td></tr>
 659 <tr><td><tt>Orientation</tt> </td><td>Orientation value (see above)</td></tr>
 660 <tr><td><tt>OutputFaceUp</tt> </td><td>OutputFaceUp value</td></tr>
 661 <tr><td><tt>OutputType[64]</tt> </td><td>OutputType string</td></tr>
 662 <tr><td><tt>PageSize[2]</tt> </td><td>Width and length of page in points</td></tr>
 663 <tr><td><tt>Separations</tt> </td><td>Separations value</td></tr>
 664 <tr><td><tt>TraySwitch</tt> </td><td>TraySwitch value</td></tr>
 665 <tr><td><tt>Tumble</tt> </td><td>Tumble value</td></tr>
 666 <tr><td><tt>cupsBitsPerColor</tt> </td><td>Number of bits for each color</td></tr>
 667 <tr><td><tt>cupsBitsPerPixel</tt> </td><td>Number of bits for each pixel</td></tr>
 668 <tr><td><tt>cupsBytesPerLine</tt> </td><td>Number of bytes per line</td></tr>
 669 <tr><td><tt>cupsColorOrder</tt> </td><td>Order of colors</td></tr>
 670 <tr><td><tt>cupsColorSpace</tt> </td><td>True colorspace</td></tr>
 671 <tr><td><tt>cupsCompression</tt> </td><td>Device compression to use</td></tr>
 672 <tr><td><tt>cupsHeight</tt> </td><td>Height of page image in pixels</td></tr>
 673 <tr><td><tt>cupsMediaType</tt> </td><td>Media type code</td></tr>
 674 <tr><td><tt>cupsRowCount</tt> </td><td>Rows per band</td></tr>
 675 <tr><td><tt>cupsRowFeed</tt> </td><td>Feed between bands</td></tr>
 676 <tr><td><tt>cupsRowStep</tt> </td><td>Spacing between lines</td></tr>
 677 <tr><td><tt>cupsWidth</tt> </td><td>Width of page image in pixels</td></tr>
 678 </tbody></table></div>
 679 <!-- NEW PAGE -->
 680 <h2 class='title'><a name='TYPES'>Types</a></h2>
 681 <ul>
 682         <li><a href='#cups_interpret_cb_t'><tt>cups_interpret_cb_t</tt></a> </li>
 683         <li><a href='#cups_page_header2_t'><tt>cups_page_header2_t</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 684         <li><a href='#cups_raster_t'><tt>cups_raster_t</tt></a> </li>
 685 </ul>
 686 <!-- NEW PAGE -->
 687 <h3 class='title'><a name='cups_interpret_cb_t'>cups_interpret_cb_t</a></h3>
 688 <h4>Description</h4>
 689 <p>Prototypes...</p>
 690 <h4>Definition</h4>
 691 <pre>
 692 typedef int (*cups_interpret_cb_t)(<a href='#cups_page_header2_t'>cups_page_header2_t</a> *header, int preferred_bits);
 693 </pre>
 694 <!-- NEW PAGE -->
 695 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cups_page_header2_t'>cups_page_header2_t</a></h3>
 696 <h4>Description</h4>
 697 <p>Version 2 Page Header </p>
 698 <h4>Definition</h4>
 699 <pre>
 700 typedef struct <a href='#cups_page_header2_s'>cups_page_header2_s</a> cups_page_header2_t;
 701 </pre>
 702 <!-- NEW PAGE -->
 703 <h3 class='title'><a name='cups_raster_t'>cups_raster_t</a></h3>
 704 <h4>Description</h4>
 705 <p>Raster stream data</p>
 706 <h4>Definition</h4>
 707 <pre>
 708 typedef struct _cups_raster_s cups_raster_t;
 709 </pre>
 710 </body>
 711 </html>