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 </tbody></table></div>
 217 <!-- NEW PAGE -->
 218 <h3 class='title'><a name='cups_order_e'>cups_order_e</a></h3>
 219 <h4>Description</h4>
 220 <p></p>
 221 <h4>Values</h4>
 222 <div class='table'><table align='center' border='1' width='80%'>
 223 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 224 <tbody>
 225 <tr><td><tt>CUPS_ORDER_BANDED</tt> </td><td>CCC MMM YYY KKK ...</td></tr>
 226 <tr><td><tt>CUPS_ORDER_CHUNKED</tt> </td><td>CMYK CMYK CMYK ...</td></tr>
 227 <tr><td><tt>CUPS_ORDER_PLANAR</tt> </td><td>CCC ... MMM ... YYY ... KKK ...</td></tr>
 228 </tbody></table></div>
 229 <!-- NEW PAGE -->
 230 <h3 class='title'><a name='cups_orient_e'>cups_orient_e</a></h3>
 231 <h4>Description</h4>
 232 <p></p>
 233 <h4>Values</h4>
 234 <div class='table'><table align='center' border='1' width='80%'>
 235 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 236 <tbody>
 237 <tr><td><tt>CUPS_ORIENT_0</tt> </td><td>Don't rotate the page</td></tr>
 238 <tr><td><tt>CUPS_ORIENT_180</tt> </td><td>Turn the page upside down</td></tr>
 239 <tr><td><tt>CUPS_ORIENT_270</tt> </td><td>Rotate the page clockwise</td></tr>
 240 <tr><td><tt>CUPS_ORIENT_90</tt> </td><td>Rotate the page counter-clockwise</td></tr>
 241 </tbody></table></div>
 242 <!-- NEW PAGE -->
 243 <h2 class='title'><a name='FUNCTIONS'>Functions</a></h2>
 244 <ul>
 245         <li><a href='#cupsRasterClose'><tt>cupsRasterClose()</tt></a> </li>
 246         <li><a href='#cupsRasterInterpretPPD'><tt>cupsRasterInterpretPPD()</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 247         <li><a href='#cupsRasterOpen'><tt>cupsRasterOpen()</tt></a> </li>
 248         <li><a href='#cupsRasterReadHeader'><tt>cupsRasterReadHeader()</tt></a> </li>
 249         <li><a href='#cupsRasterReadHeader2'><tt>cupsRasterReadHeader2()</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 250         <li><a href='#cupsRasterReadPixels'><tt>cupsRasterReadPixels()</tt></a> </li>
 251         <li><a href='#cupsRasterWriteHeader'><tt>cupsRasterWriteHeader()</tt></a> </li>
 252         <li><a href='#cupsRasterWriteHeader2'><tt>cupsRasterWriteHeader2()</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 253         <li><a href='#cupsRasterWritePixels'><tt>cupsRasterWritePixels()</tt></a> </li>
 254 </ul>
 255 <!-- NEW PAGE -->
 256 <h3 class='title'><a name='cupsRasterClose'>cupsRasterClose()</a></h3>
 257 <h4>Description</h4>
 258 <p>Close a raster stream.</p>
 259 <h4>Syntax</h4>
 260 <pre>
 261 void
 262 cupsRasterClose(
 263     <a href='#cups_raster_t'>cups_raster_t</a> * r);
 264 </pre>
 265 <h4>Arguments</h4>
 266 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 267 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 268 <tbody>
 269 <tr><td><tt>r</tt></td><td>Stream to close</td></tr>
 270 </tbody></table></div>
 271 <h4>Returns</h4>
 272 <p>Nothing.</p>
 273 <!-- NEW PAGE -->
 274 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cupsRasterInterpretPPD'>cupsRasterInterpretPPD()</a></h3>
 275 <h4>Description</h4>
 276 <p>Interpret PPD commands to create a page header.
 277
 278 This function does not mark the options in the PPD using the &quot;num_options&quot;
 279 and &quot;options&quot; arguments.  Instead, mark the options prior to calling
 280 cupsRasterInterpretPPD() - this allows you to do per-page options
 281 without manipulating the options array.
 282
 283 The &quot;func&quot; argument specifies an optional callback function that is
 284 called prior to the computation of the final raster data.  The function
 285 can make changes to the cups_page_header2_t data as needed to use a
 286 supported raster format and then returns 0 on success and -1 if the
 287 requested attributes cannot be supported.
 288
 289 </p>
 290 <h4>Syntax</h4>
 291 <pre>
 292 int
 293 cupsRasterInterpretPPD(
 294     <a href='#cups_page_header2_t'>cups_page_header2_t</a> * h,
 295     ppd_file_t * ppd,
 296     int num_options,
 297     cups_option_t * options,
 298     <a href='#cups_interpret_cb_t'>cups_interpret_cb_t</a> func);
 299 </pre>
 300 <h4>Arguments</h4>
 301 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 302 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 303 <tbody>
 304 <tr><td><tt>h</tt></td><td>Page header</td></tr>
 305 <tr><td><tt>ppd</tt></td><td>PPD file</td></tr>
 306 <tr><td><tt>num_options</tt></td><td>Number of options</td></tr>
 307 <tr><td><tt>options</tt></td><td>Options</td></tr>
 308 <tr><td><tt>func</tt></td><td>Optional page header callback</td></tr>
 309 </tbody></table></div>
 310 <h4>Returns</h4>
 311 <p>0 on success, -1 on failure</p>
 312 <!-- NEW PAGE -->
 313 <h3 class='title'><a name='cupsRasterOpen'>cupsRasterOpen()</a></h3>
 314 <h4>Description</h4>
 315 <p>Open a raster stream.</p>
 316 <h4>Syntax</h4>
 317 <pre>
 318 <a href='#cups_raster_t'>cups_raster_t</a> *
 319 cupsRasterOpen(
 320     int fd,
 321     cups_mode_t mode);
 322 </pre>
 323 <h4>Arguments</h4>
 324 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 325 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 326 <tbody>
 327 <tr><td><tt>fd</tt></td><td>File descriptor</td></tr>
 328 <tr><td><tt>mode</tt></td><td>Mode</td></tr>
 329 </tbody></table></div>
 330 <h4>Returns</h4>
 331 <p>New stream</p>
 332 <!-- NEW PAGE -->
 333 <h3 class='title'><a name='cupsRasterReadHeader'>cupsRasterReadHeader()</a></h3>
 334 <h4>Description</h4>
 335 <p>Read a raster page header and store it in a
 336 V1 page header structure.</p>
 337 <h4>Syntax</h4>
 338 <pre>
 339 unsigned
 340 cupsRasterReadHeader(
 341     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 342     <a href='#cups_page_header_t'>cups_page_header_t</a> * h);
 343 </pre>
 344 <h4>Arguments</h4>
 345 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 346 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 347 <tbody>
 348 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 349 <tr><td><tt>h</tt></td><td>Pointer to header data</td></tr>
 350 </tbody></table></div>
 351 <h4>Returns</h4>
 352 <p>1 on success, 0 on fail</p>
 353 <!-- NEW PAGE -->
 354 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cupsRasterReadHeader2'>cupsRasterReadHeader2()</a></h3>
 355 <h4>Description</h4>
 356 <p>Read a raster page header and store it in a
 357 V2 page header structure.
 358
 359 </p>
 360 <h4>Syntax</h4>
 361 <pre>
 362 unsigned
 363 cupsRasterReadHeader2(
 364     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 365     <a href='#cups_page_header2_t'>cups_page_header2_t</a> * h);
 366 </pre>
 367 <h4>Arguments</h4>
 368 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 369 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 370 <tbody>
 371 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 372 <tr><td><tt>h</tt></td><td>Pointer to header data</td></tr>
 373 </tbody></table></div>
 374 <h4>Returns</h4>
 375 <p>1 on success, 0 on fail</p>
 376 <!-- NEW PAGE -->
 377 <h3 class='title'><a name='cupsRasterReadPixels'>cupsRasterReadPixels()</a></h3>
 378 <h4>Description</h4>
 379 <p>Read raster pixels.</p>
 380 <h4>Syntax</h4>
 381 <pre>
 382 unsigned
 383 cupsRasterReadPixels(
 384     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 385     unsigned char * p,
 386     unsigned len);
 387 </pre>
 388 <h4>Arguments</h4>
 389 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 390 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 391 <tbody>
 392 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 393 <tr><td><tt>p</tt></td><td>Pointer to pixel buffer</td></tr>
 394 <tr><td><tt>len</tt></td><td>Number of bytes to read</td></tr>
 395 </tbody></table></div>
 396 <h4>Returns</h4>
 397 <p>Number of bytes read</p>
 398 <!-- NEW PAGE -->
 399 <h3 class='title'><a name='cupsRasterWriteHeader'>cupsRasterWriteHeader()</a></h3>
 400 <h4>Description</h4>
 401 <p>Write a raster page header from a V1 page
 402 header structure.</p>
 403 <h4>Syntax</h4>
 404 <pre>
 405 unsigned
 406 cupsRasterWriteHeader(
 407     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 408     <a href='#cups_page_header_t'>cups_page_header_t</a> * h);
 409 </pre>
 410 <h4>Arguments</h4>
 411 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 412 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 413 <tbody>
 414 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 415 <tr><td><tt>h</tt></td><td>Raster page header</td></tr>
 416 </tbody></table></div>
 417 <h4>Returns</h4>
 418 <p>1 on success, 0 on failure</p>
 419 <!-- NEW PAGE -->
 420 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cupsRasterWriteHeader2'>cupsRasterWriteHeader2()</a></h3>
 421 <h4>Description</h4>
 422 <p>Write a raster page header from a V2 page
 423 header structure.
 424
 425 </p>
 426 <h4>Syntax</h4>
 427 <pre>
 428 unsigned
 429 cupsRasterWriteHeader2(
 430     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 431     <a href='#cups_page_header2_t'>cups_page_header2_t</a> * h);
 432 </pre>
 433 <h4>Arguments</h4>
 434 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 435 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 436 <tbody>
 437 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 438 <tr><td><tt>h</tt></td><td>Raster page header</td></tr>
 439 </tbody></table></div>
 440 <h4>Returns</h4>
 441 <p>1 on success, 0 on failure</p>
 442 <!-- NEW PAGE -->
 443 <h3 class='title'><a name='cupsRasterWritePixels'>cupsRasterWritePixels()</a></h3>
 444 <h4>Description</h4>
 445 <p>Write raster pixels.</p>
 446 <h4>Syntax</h4>
 447 <pre>
 448 unsigned
 449 cupsRasterWritePixels(
 450     <a href='#cups_raster_t'>cups_raster_t</a> * r,
 451     unsigned char * p,
 452     unsigned len);
 453 </pre>
 454 <h4>Arguments</h4>
 455 <div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'>
 456 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 457 <tbody>
 458 <tr><td><tt>r</tt></td><td>Raster stream</td></tr>
 459 <tr><td><tt>p</tt></td><td>Bytes to write</td></tr>
 460 <tr><td><tt>len</tt></td><td>Number of bytes to write</td></tr>
 461 </tbody></table></div>
 462 <h4>Returns</h4>
 463 <p>Number of bytes written</p>
 464 <!-- NEW PAGE -->
 465 <h2 class='title'><a name='STRUCTURES'>Structures</a></h2>
 466 <ul>
 467         <li><a href='#cups_page_header2_s'><tt>cups_page_header2_s</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 468         <li><a href='#cups_page_header_s'><tt>cups_page_header_s</tt></a> </li>
 469 </ul>
 470 <!-- NEW PAGE -->
 471 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cups_page_header2_s'>cups_page_header2_s</a></h3>
 472 <h4>Description</h4>
 473 <p>Version 2 Page Header </p>
 474 <h4>Definition</h4>
 475 <pre>
 476 struct cups_page_header2_s
 477 {
 478   unsigned AdvanceDistance;
 479   cups_adv_t AdvanceMedia;
 480   cups_bool_t Collate;
 481   cups_cut_t CutMedia;
 482   cups_bool_t Duplex;
 483   unsigned HWResolution[2];
 484   unsigned ImagingBoundingBox[4];
 485   cups_bool_t InsertSheet;
 486   cups_jog_t Jog;
 487   cups_edge_t LeadingEdge;
 488   cups_bool_t ManualFeed;
 489   unsigned Margins[2];
 490   char MediaClass[64];
 491   char MediaColor[64];
 492   unsigned MediaPosition;
 493   char MediaType[64];
 494   unsigned MediaWeight;
 495   cups_bool_t MirrorPrint;
 496   cups_bool_t NegativePrint;
 497   unsigned NumCopies;
 498   cups_orient_t Orientation;
 499   cups_bool_t OutputFaceUp;
 500   char OutputType[64];
 501   unsigned PageSize[2];
 502   cups_bool_t Separations;
 503   cups_bool_t TraySwitch;
 504   cups_bool_t Tumble;
 505   unsigned cupsBitsPerColor;
 506   unsigned cupsBitsPerPixel;
 507   float cupsBorderlessScalingFactor;
 508   unsigned cupsBytesPerLine;
 509   cups_order_t cupsColorOrder;
 510   cups_cspace_t cupsColorSpace;
 511   unsigned cupsCompression;
 512   unsigned cupsHeight;
 513   float cupsImagingBBox[4];
 514   unsigned cupsInteger[16];
 515   char cupsMarkerType[64];
 516   unsigned cupsMediaType;
 517   unsigned cupsNumColors;
 518   char cupsPageSizeName[64];
 519   float cupsPageSize[2];
 520   float cupsReal[16];
 521   char cupsRenderingIntent[64];
 522   unsigned cupsRowCount;
 523   unsigned cupsRowFeed;
 524   unsigned cupsRowStep;
 525   char cupsString[16][64];
 526   unsigned cupsWidth;
 527 };
 528 </pre>
 529 <h4>Members</h4>
 530 <div class='table'><table align='center' border='1' width='80%'>
 531 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 532 <tbody>
 533 <tr><td><tt>AdvanceDistance</tt> </td><td>AdvanceDistance value in points</td></tr>
 534 <tr><td><tt>AdvanceMedia</tt> </td><td>AdvanceMedia value (see above)</td></tr>
 535 <tr><td><tt>Collate</tt> </td><td>Collated copies value</td></tr>
 536 <tr><td><tt>CutMedia</tt> </td><td>CutMedia value (see above)</td></tr>
 537 <tr><td><tt>Duplex</tt> </td><td>Duplexed (double-sided) value</td></tr>
 538 <tr><td><tt>HWResolution[2]</tt> </td><td>Resolution in dots-per-inch</td></tr>
 539 <tr><td><tt>ImagingBoundingBox[4]</tt> </td><td>Pixel region that is painted (points)</td></tr>
 540 <tr><td><tt>InsertSheet</tt> </td><td>InsertSheet value</td></tr>
 541 <tr><td><tt>Jog</tt> </td><td>Jog value (see above)</td></tr>
 542 <tr><td><tt>LeadingEdge</tt> </td><td>LeadingEdge value (see above)</td></tr>
 543 <tr><td><tt>ManualFeed</tt> </td><td>ManualFeed value</td></tr>
 544 <tr><td><tt>Margins[2]</tt> </td><td>Lower-lefthand margins in points</td></tr>
 545 <tr><td><tt>MediaClass[64]</tt> </td><td>MediaClass string</td></tr>
 546 <tr><td><tt>MediaColor[64]</tt> </td><td>MediaColor string</td></tr>
 547 <tr><td><tt>MediaPosition</tt> </td><td>MediaPosition value</td></tr>
 548 <tr><td><tt>MediaType[64]</tt> </td><td>MediaType string</td></tr>
 549 <tr><td><tt>MediaWeight</tt> </td><td>MediaWeight value in grams/m^2</td></tr>
 550 <tr><td><tt>MirrorPrint</tt> </td><td>MirrorPrint value</td></tr>
 551 <tr><td><tt>NegativePrint</tt> </td><td>NegativePrint value</td></tr>
 552 <tr><td><tt>NumCopies</tt> </td><td>Number of copies to produce</td></tr>
 553 <tr><td><tt>Orientation</tt> </td><td>Orientation value (see above)</td></tr>
 554 <tr><td><tt>OutputFaceUp</tt> </td><td>OutputFaceUp value</td></tr>
 555 <tr><td><tt>OutputType[64]</tt> </td><td>OutputType string</td></tr>
 556 <tr><td><tt>PageSize[2]</tt> </td><td>Width and length of page in points</td></tr>
 557 <tr><td><tt>Separations</tt> </td><td>Separations value</td></tr>
 558 <tr><td><tt>TraySwitch</tt> </td><td>TraySwitch value</td></tr>
 559 <tr><td><tt>Tumble</tt> </td><td>Tumble value</td></tr>
 560 <tr><td><tt>cupsBitsPerColor</tt> </td><td>Number of bits for each color</td></tr>
 561 <tr><td><tt>cupsBitsPerPixel</tt> </td><td>Number of bits for each pixel</td></tr>
 562 <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>
 563 <tr><td><tt>cupsBytesPerLine</tt> </td><td>Number of bytes per line</td></tr>
 564 <tr><td><tt>cupsColorOrder</tt> </td><td>Order of colors</td></tr>
 565 <tr><td><tt>cupsColorSpace</tt> </td><td>True colorspace</td></tr>
 566 <tr><td><tt>cupsCompression</tt> </td><td>Device compression to use</td></tr>
 567 <tr><td><tt>cupsHeight</tt> </td><td>Height of page image in pixels</td></tr>
 568 <tr><td><tt>cupsImagingBBox[4]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Floating point ImagingBoundingBox *
 569 (scaling factor not applied) </td></tr>
 570 <tr><td><tt>cupsInteger[16]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>User-defined integer values </td></tr>
 571 <tr><td><tt>cupsMarkerType[64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Ink/toner type </td></tr>
 572 <tr><td><tt>cupsMediaType</tt> </td><td>Media type code</td></tr>
 573 <tr><td><tt>cupsNumColors</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Number of colors </td></tr>
 574 <tr><td><tt>cupsPageSizeName[64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>PageSize name </td></tr>
 575 <tr><td><tt>cupsPageSize[2]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Floating point PageSize (scaling *
 576 factor not applied) </td></tr>
 577 <tr><td><tt>cupsReal[16]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>User-defined floating-point values </td></tr>
 578 <tr><td><tt>cupsRenderingIntent[64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>Color rendering intent </td></tr>
 579 <tr><td><tt>cupsRowCount</tt> </td><td>Rows per band</td></tr>
 580 <tr><td><tt>cupsRowFeed</tt> </td><td>Feed between bands</td></tr>
 581 <tr><td><tt>cupsRowStep</tt> </td><td>Spacing between lines</td></tr>
 582 <tr><td><tt>cupsString[16][64]</tt> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></td><td>User-defined string values </td></tr>
 583 <tr><td><tt>cupsWidth</tt> </td><td>Width of page image in pixels</td></tr>
 584 </tbody></table></div>
 585 <!-- NEW PAGE -->
 586 <h3 class='title'><a name='cups_page_header_s'>cups_page_header_s</a></h3>
 587 <h4>Description</h4>
 588 <p></p>
 589 <h4>Definition</h4>
 590 <pre>
 591 struct cups_page_header_s
 592 {
 593   unsigned AdvanceDistance;
 594   cups_adv_t AdvanceMedia;
 595   cups_bool_t Collate;
 596   cups_cut_t CutMedia;
 597   cups_bool_t Duplex;
 598   unsigned HWResolution[2];
 599   unsigned ImagingBoundingBox[4];
 600   cups_bool_t InsertSheet;
 601   cups_jog_t Jog;
 602   cups_edge_t LeadingEdge;
 603   cups_bool_t ManualFeed;
 604   unsigned Margins[2];
 605   char MediaClass[64];
 606   char MediaColor[64];
 607   unsigned MediaPosition;
 608   char MediaType[64];
 609   unsigned MediaWeight;
 610   cups_bool_t MirrorPrint;
 611   cups_bool_t NegativePrint;
 612   unsigned NumCopies;
 613   cups_orient_t Orientation;
 614   cups_bool_t OutputFaceUp;
 615   char OutputType[64];
 616   unsigned PageSize[2];
 617   cups_bool_t Separations;
 618   cups_bool_t TraySwitch;
 619   cups_bool_t Tumble;
 620   unsigned cupsBitsPerColor;
 621   unsigned cupsBitsPerPixel;
 622   unsigned cupsBytesPerLine;
 623   cups_order_t cupsColorOrder;
 624   cups_cspace_t cupsColorSpace;
 625   unsigned cupsCompression;
 626   unsigned cupsHeight;
 627   unsigned cupsMediaType;
 628   unsigned cupsRowCount;
 629   unsigned cupsRowFeed;
 630   unsigned cupsRowStep;
 631   unsigned cupsWidth;
 632 };
 633 </pre>
 634 <h4>Members</h4>
 635 <div class='table'><table align='center' border='1' width='80%'>
 636 <thead><tr><th>Name</th><th>Description</th></tr></thead>
 637 <tbody>
 638 <tr><td><tt>AdvanceDistance</tt> </td><td>AdvanceDistance value in points</td></tr>
 639 <tr><td><tt>AdvanceMedia</tt> </td><td>AdvanceMedia value (see above)</td></tr>
 640 <tr><td><tt>Collate</tt> </td><td>Collated copies value</td></tr>
 641 <tr><td><tt>CutMedia</tt> </td><td>CutMedia value (see above)</td></tr>
 642 <tr><td><tt>Duplex</tt> </td><td>Duplexed (double-sided) value</td></tr>
 643 <tr><td><tt>HWResolution[2]</tt> </td><td>Resolution in dots-per-inch</td></tr>
 644 <tr><td><tt>ImagingBoundingBox[4]</tt> </td><td>Pixel region that is painted (points)</td></tr>
 645 <tr><td><tt>InsertSheet</tt> </td><td>InsertSheet value</td></tr>
 646 <tr><td><tt>Jog</tt> </td><td>Jog value (see above)</td></tr>
 647 <tr><td><tt>LeadingEdge</tt> </td><td>LeadingEdge value (see above)</td></tr>
 648 <tr><td><tt>ManualFeed</tt> </td><td>ManualFeed value</td></tr>
 649 <tr><td><tt>Margins[2]</tt> </td><td>Lower-lefthand margins in points</td></tr>
 650 <tr><td><tt>MediaClass[64]</tt> </td><td>MediaClass string</td></tr>
 651 <tr><td><tt>MediaColor[64]</tt> </td><td>MediaColor string</td></tr>
 652 <tr><td><tt>MediaPosition</tt> </td><td>MediaPosition value</td></tr>
 653 <tr><td><tt>MediaType[64]</tt> </td><td>MediaType string</td></tr>
 654 <tr><td><tt>MediaWeight</tt> </td><td>MediaWeight value in grams/m^2</td></tr>
 655 <tr><td><tt>MirrorPrint</tt> </td><td>MirrorPrint value</td></tr>
 656 <tr><td><tt>NegativePrint</tt> </td><td>NegativePrint value</td></tr>
 657 <tr><td><tt>NumCopies</tt> </td><td>Number of copies to produce</td></tr>
 658 <tr><td><tt>Orientation</tt> </td><td>Orientation value (see above)</td></tr>
 659 <tr><td><tt>OutputFaceUp</tt> </td><td>OutputFaceUp value</td></tr>
 660 <tr><td><tt>OutputType[64]</tt> </td><td>OutputType string</td></tr>
 661 <tr><td><tt>PageSize[2]</tt> </td><td>Width and length of page in points</td></tr>
 662 <tr><td><tt>Separations</tt> </td><td>Separations value</td></tr>
 663 <tr><td><tt>TraySwitch</tt> </td><td>TraySwitch value</td></tr>
 664 <tr><td><tt>Tumble</tt> </td><td>Tumble value</td></tr>
 665 <tr><td><tt>cupsBitsPerColor</tt> </td><td>Number of bits for each color</td></tr>
 666 <tr><td><tt>cupsBitsPerPixel</tt> </td><td>Number of bits for each pixel</td></tr>
 667 <tr><td><tt>cupsBytesPerLine</tt> </td><td>Number of bytes per line</td></tr>
 668 <tr><td><tt>cupsColorOrder</tt> </td><td>Order of colors</td></tr>
 669 <tr><td><tt>cupsColorSpace</tt> </td><td>True colorspace</td></tr>
 670 <tr><td><tt>cupsCompression</tt> </td><td>Device compression to use</td></tr>
 671 <tr><td><tt>cupsHeight</tt> </td><td>Height of page image in pixels</td></tr>
 672 <tr><td><tt>cupsMediaType</tt> </td><td>Media type code</td></tr>
 673 <tr><td><tt>cupsRowCount</tt> </td><td>Rows per band</td></tr>
 674 <tr><td><tt>cupsRowFeed</tt> </td><td>Feed between bands</td></tr>
 675 <tr><td><tt>cupsRowStep</tt> </td><td>Spacing between lines</td></tr>
 676 <tr><td><tt>cupsWidth</tt> </td><td>Width of page image in pixels</td></tr>
 677 </tbody></table></div>
 678 <!-- NEW PAGE -->
 679 <h2 class='title'><a name='TYPES'>Types</a></h2>
 680 <ul>
 681         <li><a href='#cups_interpret_cb_t'><tt>cups_interpret_cb_t</tt></a> </li>
 682         <li><a href='#cups_page_header2_t'><tt>cups_page_header2_t</tt></a> <span class='info'>&nbsp;CUPS 1.2&nbsp;</span></li>
 683         <li><a href='#cups_raster_t'><tt>cups_raster_t</tt></a> </li>
 684 </ul>
 685 <!-- NEW PAGE -->
 686 <h3 class='title'><a name='cups_interpret_cb_t'>cups_interpret_cb_t</a></h3>
 687 <h4>Description</h4>
 688 <p>Prototypes...</p>
 689 <h4>Definition</h4>
 690 <pre>
 691 typedef int (*cups_interpret_cb_t)(<a href='#cups_page_header2_t'>cups_page_header2_t</a> *header, int preferred_bits);
 692 </pre>
 693 <!-- NEW PAGE -->
 694 <h3 class='title'><span class='info'>&nbsp;CUPS 1.2&nbsp;</span><a name='cups_page_header2_t'>cups_page_header2_t</a></h3>
 695 <h4>Description</h4>
 696 <p>Version 2 Page Header </p>
 697 <h4>Definition</h4>
 698 <pre>
 699 typedef struct <a href='#cups_page_header2_s'>cups_page_header2_s</a> cups_page_header2_t;
 700 </pre>
 701 <!-- NEW PAGE -->
 702 <h3 class='title'><a name='cups_raster_t'>cups_raster_t</a></h3>
 703 <h4>Description</h4>
 704 <p>Raster stream data</p>
 705 <h4>Definition</h4>
 706 <pre>
 707 typedef struct _cups_raster_s cups_raster_t;
 708 </pre>
 709 </body>
 710 </html>