1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3 <!-- SECTION: Programming -->
5 <title>Raster API
</title>
6 <meta name=
"keywords" content=
"Programming">
7 <meta http-equiv=
"Content-Type" content=
"text/html;charset=utf-8">
8 <meta name=
"creator" content=
"Mini-XML v2.7">
9 <style type=
"text/css"><!--
11 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
14 H1, H2, H3, H4, H5, H6, P, TD, TH {
15 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
19 font-family: monaco, courier, monospace;
24 font-family: monaco, courier, monospace;
28 border: dotted thin #7f7f7f;
56 border: dotted thin #999999;
61 PRE.command EM, PRE.example EM {
62 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
66 font-family: monaco, courier, monospace;
77 border: solid thin #999999;
88 -moz-border-radius: 10px;
93 text-decoration: none;
96 A:link:hover, A:visited:hover, A:active {
97 text-decoration: underline;
104 TR.data, TD.data, TR.data TD {
107 border-bottom: solid 1pt #999999;
111 border-bottom: solid 1pt #999999;
118 border: solid thin #999999;
119 border-collapse: collapse;
135 border: solid thin #cccccc;
142 border-bottom: solid thin #999999;
151 caption-side: bottom;
175 border: thin solid black;
183 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
192 border-bottom: solid 2pt #000000;
195 DIV.indent, TABLE.indent {
203 border-collapse: collapse;
206 TABLE.indent TD, TABLE.indent TH {
211 border-collapse: collapse;
219 border-bottom: solid thin #cccccc;
224 vertical-align: bottom;
233 border-bottom: solid thin #eeeeee;
238 TABLE.list TR:nth-child(even) {
242 TABLE.list TR:nth-child(odd) {
261 font-family: monaco, courier, monospace;
265 border: solid thin #999999;
266 border-collapse: collapse;
271 DIV.summary TABLE TD, DIV.summary TABLE TH {
272 border: solid thin #999999;
278 DIV.summary TABLE THEAD TH {
282 /* API documentation styles... */
289 div.body h3, div.body h4, div.body h5 {
290 margin-bottom: 0.5em;
293 .class, .enumeration, .function, .struct, .typedef, .union {
294 border-bottom: solid thin #999999;
301 code, p.code, pre, ul.code li {
302 font-family: monaco, courier, monospace;
305 ul.code, ul.contents, ul.subcontents {
306 list-style-type: none;
316 ul.contents li ul.code, ul.contents li ul.subcontents {
329 margin-bottom: 0.5em;
332 /* This is just for the HTML files generated with the framedhelp target */
335 border: solid thin black;
344 div.contents ul.contents {
347 div.contents ul.subcontents li {
358 Raster API documentation for CUPS.
360 Copyright 2008-2010 by Apple Inc.
362 These coded instructions, statements, and computer programs are the
363 property of Apple Inc. and are protected by Federal copyright
364 law. Distribution and use rights are outlined in the file "LICENSE.txt"
365 which should have been included with this file. If this file is
366 file is missing or damaged, see the license at "http://www.cups.org/".
369 <h1 class='title'
>Raster API
</h1>
371 <div class='summary'
><table summary='General Information'
>
375 <th>cups/raster.h
</th>
385 <td>Programming:
<a href='api-overview.html'
>Introduction to CUPS Programming
</a><br>
386 Programming:
<a href='api-cups.html'
>CUPS API
</a><br>
387 Programming:
<a href='api-cups.html'
>PPD API
</a><br>
388 References:
<a href='spec-ppd.html'
>CUPS PPD Specification
</a></td>
392 <h2 class=
"title">Contents
</h2>
393 <ul class=
"contents">
394 <li><a href=
"#OVERVIEW">Overview
</a></li>
395 <li><a href=
"#TASKS">Functions by Task
</a><ul class=
"subcontents">
396 <li><a href=
"#OPENCLOSE">Opening and Closing Raster Streams
</a></li>
397 <li><a href=
"#READING">Reading Raster Streams
</a></li>
398 <li><a href=
"#WRITING">Writing Raster Streams
</a></li>
400 <li><a href=
"#FUNCTIONS">Functions
</a><ul class=
"code">
401 <li><a href=
"#cupsRasterClose" title=
"Close a raster stream.">cupsRasterClose
</a></li>
402 <li><a href=
"#cupsRasterInitPWGHeader" title=
"Initialize a page header for PWG Raster output.">cupsRasterInitPWGHeader
</a></li>
403 <li><a href=
"#cupsRasterInterpretPPD" title=
"Interpret PPD commands to create a page header.">cupsRasterInterpretPPD
</a></li>
404 <li><a href=
"#cupsRasterOpen" title=
"Open a raster stream using a file descriptor.">cupsRasterOpen
</a></li>
405 <li><a href=
"#cupsRasterOpenIO" title=
"Open a raster stream using a callback function.">cupsRasterOpenIO
</a></li>
406 <li><a href=
"#cupsRasterReadHeader" title=
"Read a raster page header and store it in a
407 version 1 page header structure.">cupsRasterReadHeader
</a></li>
408 <li><a href=
"#cupsRasterReadHeader2" title=
"Read a raster page header and store it in a
409 version 2 page header structure.">cupsRasterReadHeader2
</a></li>
410 <li><a href=
"#cupsRasterReadPixels" title=
"Read raster pixels.">cupsRasterReadPixels
</a></li>
411 <li><a href=
"#cupsRasterWriteHeader" title=
"Write a raster page header from a version 1 page
412 header structure.">cupsRasterWriteHeader
</a></li>
413 <li><a href=
"#cupsRasterWriteHeader2" title=
"Write a raster page header from a version 2
414 page header structure.">cupsRasterWriteHeader2
</a></li>
415 <li><a href=
"#cupsRasterWritePixels" title=
"Write raster pixels.">cupsRasterWritePixels
</a></li>
417 <li><a href=
"#TYPES">Data Types
</a><ul class=
"code">
418 <li><a href=
"#cups_adv_t" title=
"AdvanceMedia attribute values">cups_adv_t
</a></li>
419 <li><a href=
"#cups_bool_t" title=
"Boolean type">cups_bool_t
</a></li>
420 <li><a href=
"#cups_cspace_t" title=
"cupsColorSpace attribute values">cups_cspace_t
</a></li>
421 <li><a href=
"#cups_cut_t" title=
"CutMedia attribute values">cups_cut_t
</a></li>
422 <li><a href=
"#cups_edge_t" title=
"LeadingEdge attribute values">cups_edge_t
</a></li>
423 <li><a href=
"#cups_interpret_cb_t" title=
"cupsRasterInterpretPPD callback function">cups_interpret_cb_t
</a></li>
424 <li><a href=
"#cups_jog_t" title=
"Jog attribute values">cups_jog_t
</a></li>
425 <li><a href=
"#cups_mode_t" title=
"cupsRasterOpen modes">cups_mode_t
</a></li>
426 <li><a href=
"#cups_order_t" title=
"cupsColorOrder attribute values">cups_order_t
</a></li>
427 <li><a href=
"#cups_orient_t" title=
"Orientation attribute values">cups_orient_t
</a></li>
428 <li><a href=
"#cups_page_header2_t" title=
"Version 2 page header ">cups_page_header2_t
</a></li>
429 <li><a href=
"#cups_page_header_t" title=
"Version 1 page header ">cups_page_header_t
</a></li>
430 <li><a href=
"#cups_raster_iocb_t" title=
"cupsRasterOpenIO callback function">cups_raster_iocb_t
</a></li>
431 <li><a href=
"#cups_raster_t" title=
"Raster stream data">cups_raster_t
</a></li>
433 <li><a href=
"#STRUCTURES">Structures
</a><ul class=
"code">
434 <li><a href=
"#cups_page_header2_s" title=
"Version 2 page header ">cups_page_header2_s
</a></li>
435 <li><a href=
"#cups_page_header_s" title=
"Version 1 page header ">cups_page_header_s
</a></li>
437 <li><a href=
"#ENUMERATIONS">Constants
</a><ul class=
"code">
438 <li><a href=
"#cups_adv_e" title=
"AdvanceMedia attribute values">cups_adv_e
</a></li>
439 <li><a href=
"#cups_bool_e" title=
"Boolean type">cups_bool_e
</a></li>
440 <li><a href=
"#cups_cspace_e" title=
"cupsColorSpace attribute values">cups_cspace_e
</a></li>
441 <li><a href=
"#cups_cut_e" title=
"CutMedia attribute values">cups_cut_e
</a></li>
442 <li><a href=
"#cups_edge_e" title=
"LeadingEdge attribute values">cups_edge_e
</a></li>
443 <li><a href=
"#cups_jog_e" title=
"Jog attribute values">cups_jog_e
</a></li>
444 <li><a href=
"#cups_mode_e" title=
"cupsRasterOpen modes">cups_mode_e
</a></li>
445 <li><a href=
"#cups_order_e" title=
"cupsColorOrder attribute values">cups_order_e
</a></li>
446 <li><a href=
"#cups_orient_e" title=
"Orientation attribute values">cups_orient_e
</a></li>
452 Raster API introduction for CUPS.
454 Copyright 2007-2013 by Apple Inc.
455 Copyright 1997-2006 by Easy Software Products, all rights reserved.
457 These coded instructions, statements, and computer programs are the
458 property of Apple Inc. and are protected by Federal copyright
459 law. Distribution and use rights are outlined in the file "LICENSE.txt"
460 which should have been included with this file. If this file is
461 file is missing or damaged, see the license at "http://www.cups.org/".
464 <h2 class='title'
><a name=
"OVERVIEW">Overview
</a></h2>
466 <p>The CUPS raster API provides a standard interface for reading and writing
467 CUPS raster streams which are used for printing to raster printers. Because the
468 raster format is updated from time to time, it is important to use this API to
469 avoid incompatibilities with newer versions of CUPS.
</p>
471 <p>Two kinds of CUPS filters use the CUPS raster API - raster image processor
472 (RIP) filters such as
<code>pstoraster
</code> and
<code>cgpdftoraster
</code>
473 (OS X) that produce CUPS raster files and printer driver filters that
474 convert CUPS raster files into a format usable by the printer. Printer
475 driver filters are by far the most common.
</p>
477 <p>CUPS raster files (
<code>application/vnd.cups-raster
</code>) consists of
478 a stream of raster page descriptions produced by one of the RIP filters such as
479 <var>pstoraster
</var>,
<var>imagetoraster
</var>, or
480 <var>cgpdftoraster
</var>. CUPS raster files are referred to using the
481 <a href='#cups_raster_t'
><code>cups_raster_t
</code></a> type and are
482 opened using the
<a href='#cupsRasterOpen'
><code>cupsRasterOpen
</code></a>
483 function. For example, to read raster data from the standard input, open
484 file descriptor
0:
</p>
486 <pre class=
"example">
487 #include
<cups/raster.h
>>
489 <a href=
"#cups_raster_t">cups_raster_t
</a> *ras =
<a href=
"#cupsRasterOpen">cupsRasterOpen
</a>(
0, CUPS_RASTER_READ);
492 <p>Each page of data begins with a page dictionary structure called
493 <a href=
"#cups_page_header2_t"><code>cups_page_header2_t
</code></a>. This
494 structure contains the colorspace, bits per color, media size, media type,
495 hardware resolution, and so forth used for the page.
</p>
497 <blockquote><b>Note:
</b>
499 <p>Do not confuse the colorspace in the page header with the PPD
500 <tt>ColorModel
</tt> keyword.
<tt>ColorModel
</tt> refers to the general type of
501 color used for a device (Gray, RGB, CMYK, DeviceN) and is often used to
502 select a particular colorspace for the page header along with the associate
503 color profile. The page header colorspace (
<tt>cupsColorSpace
</tt>) describes
504 both the type and organization of the color data, for example KCMY (black
505 first) instead of CMYK and RGBA (RGB + alpha) instead of RGB.
</p>
509 <p>You read the page header using the
510 <a href=
"#cupsRasterReadHeader2"><code>cupsRasterReadHeader2
</code></a>
513 <pre class=
"example">
514 #include
<cups/raster.h
>>
516 <a href=
"#cups_raster_t">cups_raster_t
</a> *ras =
<a href=
"#cupsRasterOpen">cupsRasterOpen
</a>(
0, CUPS_RASTER_READ);
517 <a href=
"#cups_page_header2_t">cups_page_header2_t
</a> header;
519 while (
<a href=
"#cupsRasterReadHeader2">cupsRasterReadHeader2
</a>(ras,
&header))
521 /* setup this page */
523 /* read raster data */
525 /* finish this page */
529 <p>After the page dictionary comes the page data which is a full-resolution,
530 possibly compressed bitmap representing the page in the printer's output
531 colorspace. You read uncompressed raster data using the
532 <a href=
"#cupsRasterReadPixels"><code>cupsRasterReadPixels
</code></a>
533 function. A
<code>for
</code> loop is normally used to read the page one line
536 <pre class=
"example">
537 #include
<cups/raster.h
>>
539 <a href=
"#cups_raster_t">cups_raster_t
</a> *ras =
<a href=
"#cupsRasterOpen">cupsRasterOpen
</a>(
0, CUPS_RASTER_READ);
540 <a href=
"#cups_page_header2_t">cups_page_header2_t
</a> header;
545 while (
<a href=
"#cupsRasterReadHeader2">cupsRasterReadHeader2
</a>(ras,
&header))
547 /* setup this page */
549 fprintf(stderr,
"PAGE: %d %d\n", page, header.NumCopies);
551 /* allocate memory for
1 line */
552 buffer = malloc(header.cupsBytesPerLine);
554 /* read raster data */
555 for (y =
0; y
< header.cupsHeight; y ++)
557 if (
<a href=
"#cupsRasterReadPixels">cupsRasterReadPixels
</a>(ras, buffer, header.cupsBytesPerLine) ==
0)
560 /* write raster data to printer on stdout */
563 /* finish this page */
567 <p>When you are done reading the raster data, call the
568 <a href=
"#cupsRasterClose"><code>cupsRasterClose
</code></a> function to free
569 the memory used to read the raster file:
</p>
571 <pre class=
"example">
572 <a href=
"#cups_raster_t">cups_raster_t
</a> *ras;
574 <a href=
"#cupsRasterClose">cupsRasterClose
</a>(ras);
578 <h2 class='title'
><a name=
"TASKS">Functions by Task
</a></h2>
580 <h3><a name=
"OPENCLOSE">Opening and Closing Raster Streams
</a></h3>
584 <li><a href=
"#cupsRasterClose" title=
"Close a raster stream.">cupsRasterClose
</a></li>
585 <li><a href=
"#cupsRasterOpen" title=
"Open a raster stream.">cupsRasterOpen
</a></li>
589 <h3><a name=
"READING">Reading Raster Streams
</a></h3>
593 <li><a href=
"#cupsRasterReadHeader" title=
"Read a raster page header and store it in a version 1 page header structure.">cupsRasterReadHeader
</a> <span class=
"info">Deprecated in CUPS
1.2/OS X
10.5</span></li>
594 <li><a href=
"#cupsRasterReadHeader2" title=
"Read a raster page header and store it in a version 2 page header structure.">cupsRasterReadHeader2
</a></li>
595 <li><a href=
"#cupsRasterReadPixels" title=
"Read raster pixels.">cupsRasterReadPixels
</a></li>
599 <h3><a name=
"WRITING">Writing Raster Streams
</a></h3>
603 <li><a href=
"#cupsRasterInterpretPPD" title=
"Interpret PPD commands to create a page header.">cupsRasterInterpretPPD
</a></li>
604 <li><a href=
"#cupsRasterWriteHeader" title=
"Write a raster page header from a version 1 page header structure.">cupsRasterWriteHeader
</a> <span class=
"info">Deprecated in CUPS
1.2/OS X
10.5</span></li>
605 <li><a href=
"#cupsRasterWriteHeader2" title=
"Write a raster page header from a version 2 page header structure.">cupsRasterWriteHeader2
</a></li>
606 <li><a href=
"#cupsRasterWritePixels" title=
"Write raster pixels.">cupsRasterWritePixels
</a></li>
609 <h2 class=
"title"><a name=
"FUNCTIONS">Functions
</a></h2>
610 <h3 class=
"function"><a name=
"cupsRasterClose">cupsRasterClose
</a></h3>
611 <p class=
"description">Close a raster stream.
</p>
613 void cupsRasterClose (
<br>
614 <a href=
"#cups_raster_t">cups_raster_t
</a> *r
<br>
616 <h4 class=
"parameters">Parameters
</h4>
619 <dd class=
"description">Stream to close
</dd>
621 <h4 class=
"discussion">Discussion
</h4>
622 <p class=
"discussion">The file descriptor associated with the raster stream must be closed
623 separately as needed.
</p>
624 <h3 class=
"function"><span class=
"info"> CUPS
2.2 </span><a name=
"cupsRasterInitPWGHeader">cupsRasterInitPWGHeader
</a></h3>
625 <p class=
"description">Initialize a page header for PWG Raster output.
</p>
627 int cupsRasterInitPWGHeader (
<br>
628 <a href=
"#cups_page_header2_t">cups_page_header2_t
</a> *h,
<br>
629 pwg_media_t *media,
<br>
630 const char *type,
<br>
631 int xdpi,
<br>
632 int ydpi,
<br>
633 const char *sides,
<br>
634 const char *sheet_back
<br>
636 <h4 class=
"parameters">Parameters
</h4>
639 <dd class=
"description">Page header
</dd>
641 <dd class=
"description">PWG media information
</dd>
643 <dd class=
"description">PWG raster type string
</dd>
645 <dd class=
"description">Cross-feed direction (horizontal) resolution
</dd>
647 <dd class=
"description">Feed direction (vertical) resolution
</dd>
649 <dd class=
"description">IPP
"sides
" option value
</dd>
651 <dd class=
"description">Transform for back side or
<code>NULL
</code> for none
</dd>
653 <h4 class=
"returnvalue">Return Value
</h4>
654 <p class=
"description">1 on success,
0 on failure
</p>
655 <h4 class=
"discussion">Discussion
</h4>
656 <p class=
"discussion">The
"media
" argument specifies the media to use.
<br>
658 The
"type
" argument specifies a
"pwg-raster-document-type-supported
" value
659 that controls the color space and bit depth of the raster data.
<br>
661 The
"xres
" and
"yres
" arguments specify the raster resolution in dots per
664 The
"sheet_back
" argument specifies a
"pwg-raster-document-sheet-back
" value
665 to apply for the back side of a page. Pass
<code>NULL
</code> for the front side.
668 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"cupsRasterInterpretPPD">cupsRasterInterpretPPD
</a></h3>
669 <p class=
"description">Interpret PPD commands to create a page header.
</p>
671 int cupsRasterInterpretPPD (
<br>
672 <a href=
"#cups_page_header2_t">cups_page_header2_t
</a> *h,
<br>
673 ppd_file_t *ppd,
<br>
674 int num_options,
<br>
675 cups_option_t *options,
<br>
676 <a href=
"#cups_interpret_cb_t">cups_interpret_cb_t
</a> func
<br>
678 <h4 class=
"parameters">Parameters
</h4>
681 <dd class=
"description">Page header to create
</dd>
683 <dd class=
"description">PPD file
</dd>
685 <dd class=
"description">Number of options
</dd>
687 <dd class=
"description">Options
</dd>
689 <dd class=
"description">Optional page header callback (
<code>NULL
</code> for none)
</dd>
691 <h4 class=
"returnvalue">Return Value
</h4>
692 <p class=
"description">0 on success, -
1 on failure
</p>
693 <h4 class=
"discussion">Discussion
</h4>
694 <p class=
"discussion">This function is used by raster image processing (RIP) filters like
695 cgpdftoraster and imagetoraster when writing CUPS raster data for a page.
696 It is not used by raster printer driver filters which only read CUPS
700 <code>cupsRasterInterpretPPD
</code> does not mark the options in the PPD using
701 the
"num_options
" and
"options
" arguments. Instead, mark the options with
702 <code>cupsMarkOptions
</code> and
<code>ppdMarkOption
</code> prior to calling it -
703 this allows for per-page options without manipulating the options array.
<br>
705 The
"func
" argument specifies an optional callback function that is
706 called prior to the computation of the final raster data. The function
707 can make changes to the
<a href=
"#cups_page_header2_t"><code>cups_page_header2_t
</code></a> data as needed to use a
708 supported raster format and then returns
0 on success and -
1 if the
709 requested attributes cannot be supported.
<br>
712 <code>cupsRasterInterpretPPD
</code> supports a subset of the PostScript language.
713 Currently only the
<code>[
</code>,
<code>]
</code>,
<code><<</code>,
<code>>></code>,
<code>{
</code>,
714 <code>}
</code>,
<code>cleartomark
</code>,
<code>copy
</code>,
<code>dup
</code>,
<code>index
</code>,
715 <code>pop
</code>,
<code>roll
</code>,
<code>setpagedevice
</code>, and
<code>stopped
</code> operators
719 <h3 class=
"function"><a name=
"cupsRasterOpen">cupsRasterOpen
</a></h3>
720 <p class=
"description">Open a raster stream using a file descriptor.
</p>
722 <a href=
"#cups_raster_t">cups_raster_t
</a> *cupsRasterOpen (
<br>
723 int fd,
<br>
724 <a href=
"#cups_mode_t">cups_mode_t
</a> mode
<br>
726 <h4 class=
"parameters">Parameters
</h4>
729 <dd class=
"description">File descriptor
</dd>
731 <dd class=
"description">Mode -
<code>CUPS_RASTER_READ
</code>,
732 <code>CUPS_RASTER_WRITE
</code>,
733 <code>CUPS_RASTER_WRITE_COMPRESSED
</code>,
734 or
<code>CUPS_RASTER_WRITE_PWG
</code></dd>
736 <h4 class=
"returnvalue">Return Value
</h4>
737 <p class=
"description">New stream
</p>
738 <h4 class=
"discussion">Discussion
</h4>
739 <p class=
"discussion">This function associates a raster stream with the given file descriptor.
740 For most printer driver filters,
"fd
" will be
0 (stdin). For most raster
741 image processor (RIP) filters that generate raster data,
"fd
" will be
1
744 When writing raster data, the
<code>CUPS_RASTER_WRITE
</code>,
745 <code>CUPS_RASTER_WRITE_COMPRESS
</code>, or
<code>CUPS_RASTER_WRITE_PWG
</code> mode can
746 be used - compressed and PWG output is generally
25-
50% smaller but adds a
747 100-
300% execution time overhead.
</p>
748 <h3 class=
"function"><a name=
"cupsRasterOpenIO">cupsRasterOpenIO
</a></h3>
749 <p class=
"description">Open a raster stream using a callback function.
</p>
751 <a href=
"#cups_raster_t">cups_raster_t
</a> *cupsRasterOpenIO (
<br>
752 <a href=
"#cups_raster_iocb_t">cups_raster_iocb_t
</a> iocb,
<br>
753 void *ctx,
<br>
754 <a href=
"#cups_mode_t">cups_mode_t
</a> mode
<br>
756 <h4 class=
"parameters">Parameters
</h4>
759 <dd class=
"description">Read/write callback
</dd>
761 <dd class=
"description">Context pointer for callback
</dd>
763 <dd class=
"description">Mode -
<code>CUPS_RASTER_READ
</code>,
764 <code>CUPS_RASTER_WRITE
</code>,
765 <code>CUPS_RASTER_WRITE_COMPRESSED
</code>,
766 or
<code>CUPS_RASTER_WRITE_PWG
</code></dd>
768 <h4 class=
"returnvalue">Return Value
</h4>
769 <p class=
"description">New stream
</p>
770 <h4 class=
"discussion">Discussion
</h4>
771 <p class=
"discussion">This function associates a raster stream with the given callback function and
774 When writing raster data, the
<code>CUPS_RASTER_WRITE
</code>,
775 <code>CUPS_RASTER_WRITE_COMPRESS
</code>, or
<code>CUPS_RASTER_WRITE_PWG
</code> mode can
776 be used - compressed and PWG output is generally
25-
50% smaller but adds a
777 100-
300% execution time overhead.
</p>
778 <h3 class=
"function"><span class=
"info"> DEPRECATED
</span><a name=
"cupsRasterReadHeader">cupsRasterReadHeader
</a></h3>
779 <p class=
"description">Read a raster page header and store it in a
780 version
1 page header structure.
</p>
782 unsigned cupsRasterReadHeader (
<br>
783 <a href=
"#cups_raster_t">cups_raster_t
</a> *r,
<br>
784 <a href=
"#cups_page_header_t">cups_page_header_t
</a> *h
<br>
786 <h4 class=
"parameters">Parameters
</h4>
789 <dd class=
"description">Raster stream
</dd>
791 <dd class=
"description">Pointer to header data
</dd>
793 <h4 class=
"returnvalue">Return Value
</h4>
794 <p class=
"description">1 on success,
0 on failure/end-of-file
</p>
795 <h4 class=
"discussion">Discussion
</h4>
796 <p class=
"discussion">This function is deprecated. Use
<a href=
"#cupsRasterReadHeader2"><code>cupsRasterReadHeader2
</code></a> instead.
<br>
798 Version
1 page headers were used in CUPS
1.0 and
1.1 and contain a subset
799 of the version
2 page header data. This function handles reading version
2
800 page headers and copying only the version
1 data into the provided buffer.
803 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"cupsRasterReadHeader2">cupsRasterReadHeader2
</a></h3>
804 <p class=
"description">Read a raster page header and store it in a
805 version
2 page header structure.
</p>
807 unsigned cupsRasterReadHeader2 (
<br>
808 <a href=
"#cups_raster_t">cups_raster_t
</a> *r,
<br>
809 <a href=
"#cups_page_header2_t">cups_page_header2_t
</a> *h
<br>
811 <h4 class=
"parameters">Parameters
</h4>
814 <dd class=
"description">Raster stream
</dd>
816 <dd class=
"description">Pointer to header data
</dd>
818 <h4 class=
"returnvalue">Return Value
</h4>
819 <p class=
"description">1 on success,
0 on failure/end-of-file
</p>
820 <h3 class=
"function"><a name=
"cupsRasterReadPixels">cupsRasterReadPixels
</a></h3>
821 <p class=
"description">Read raster pixels.
</p>
823 unsigned cupsRasterReadPixels (
<br>
824 <a href=
"#cups_raster_t">cups_raster_t
</a> *r,
<br>
825 unsigned char *p,
<br>
826 unsigned len
<br>
828 <h4 class=
"parameters">Parameters
</h4>
831 <dd class=
"description">Raster stream
</dd>
833 <dd class=
"description">Pointer to pixel buffer
</dd>
835 <dd class=
"description">Number of bytes to read
</dd>
837 <h4 class=
"returnvalue">Return Value
</h4>
838 <p class=
"description">Number of bytes read
</p>
839 <h4 class=
"discussion">Discussion
</h4>
840 <p class=
"discussion">For best performance, filters should read one or more whole lines.
841 The
"cupsBytesPerLine
" value from the page header can be used to allocate
842 the line buffer and as the number of bytes to read.
</p>
843 <h3 class=
"function"><span class=
"info"> DEPRECATED
</span><a name=
"cupsRasterWriteHeader">cupsRasterWriteHeader
</a></h3>
844 <p class=
"description">Write a raster page header from a version
1 page
845 header structure.
</p>
847 unsigned cupsRasterWriteHeader (
<br>
848 <a href=
"#cups_raster_t">cups_raster_t
</a> *r,
<br>
849 <a href=
"#cups_page_header_t">cups_page_header_t
</a> *h
<br>
851 <h4 class=
"parameters">Parameters
</h4>
854 <dd class=
"description">Raster stream
</dd>
856 <dd class=
"description">Raster page header
</dd>
858 <h4 class=
"returnvalue">Return Value
</h4>
859 <p class=
"description">1 on success,
0 on failure
</p>
860 <h4 class=
"discussion">Discussion
</h4>
861 <p class=
"discussion">This function is deprecated. Use
<a href=
"#cupsRasterWriteHeader2"><code>cupsRasterWriteHeader2
</code></a> instead.
864 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"cupsRasterWriteHeader2">cupsRasterWriteHeader2
</a></h3>
865 <p class=
"description">Write a raster page header from a version
2
866 page header structure.
</p>
868 unsigned cupsRasterWriteHeader2 (
<br>
869 <a href=
"#cups_raster_t">cups_raster_t
</a> *r,
<br>
870 <a href=
"#cups_page_header2_t">cups_page_header2_t
</a> *h
<br>
872 <h4 class=
"parameters">Parameters
</h4>
875 <dd class=
"description">Raster stream
</dd>
877 <dd class=
"description">Raster page header
</dd>
879 <h4 class=
"returnvalue">Return Value
</h4>
880 <p class=
"description">1 on success,
0 on failure
</p>
881 <h4 class=
"discussion">Discussion
</h4>
882 <p class=
"discussion">The page header can be initialized using
<a href=
"#cupsRasterInterpretPPD"><code>cupsRasterInterpretPPD
</code></a>.
885 <h3 class=
"function"><a name=
"cupsRasterWritePixels">cupsRasterWritePixels
</a></h3>
886 <p class=
"description">Write raster pixels.
</p>
888 unsigned cupsRasterWritePixels (
<br>
889 <a href=
"#cups_raster_t">cups_raster_t
</a> *r,
<br>
890 unsigned char *p,
<br>
891 unsigned len
<br>
893 <h4 class=
"parameters">Parameters
</h4>
896 <dd class=
"description">Raster stream
</dd>
898 <dd class=
"description">Bytes to write
</dd>
900 <dd class=
"description">Number of bytes to write
</dd>
902 <h4 class=
"returnvalue">Return Value
</h4>
903 <p class=
"description">Number of bytes written
</p>
904 <h4 class=
"discussion">Discussion
</h4>
905 <p class=
"discussion">For best performance, filters should write one or more whole lines.
906 The
"cupsBytesPerLine
" value from the page header can be used to allocate
907 the line buffer and as the number of bytes to write.
</p>
908 <h2 class=
"title"><a name=
"TYPES">Data Types
</a></h2>
909 <h3 class=
"typedef"><a name=
"cups_adv_t">cups_adv_t
</a></h3>
910 <p class=
"description">AdvanceMedia attribute values
</p>
912 typedef enum
<a href=
"#cups_adv_e">cups_adv_e
</a> cups_adv_t;
914 <h3 class=
"typedef"><a name=
"cups_bool_t">cups_bool_t
</a></h3>
915 <p class=
"description">Boolean type
</p>
917 typedef enum
<a href=
"#cups_bool_e">cups_bool_e
</a> cups_bool_t;
919 <h3 class=
"typedef"><a name=
"cups_cspace_t">cups_cspace_t
</a></h3>
920 <p class=
"description">cupsColorSpace attribute values
</p>
922 typedef enum
<a href=
"#cups_cspace_e">cups_cspace_e
</a> cups_cspace_t;
924 <h3 class=
"typedef"><a name=
"cups_cut_t">cups_cut_t
</a></h3>
925 <p class=
"description">CutMedia attribute values
</p>
927 typedef enum
<a href=
"#cups_cut_e">cups_cut_e
</a> cups_cut_t;
929 <h3 class=
"typedef"><a name=
"cups_edge_t">cups_edge_t
</a></h3>
930 <p class=
"description">LeadingEdge attribute values
</p>
932 typedef enum
<a href=
"#cups_edge_e">cups_edge_e
</a> cups_edge_t;
934 <h3 class=
"typedef"><a name=
"cups_interpret_cb_t">cups_interpret_cb_t
</a></h3>
935 <p class=
"description">cupsRasterInterpretPPD callback function
</p>
937 typedef int (*cups_interpret_cb_t)(
<a href=
"#cups_page_header2_t">cups_page_header2_t
</a> *header, int preferred_bits);
939 <h3 class=
"typedef"><a name=
"cups_jog_t">cups_jog_t
</a></h3>
940 <p class=
"description">Jog attribute values
</p>
942 typedef enum
<a href=
"#cups_jog_e">cups_jog_e
</a> cups_jog_t;
944 <h3 class=
"typedef"><a name=
"cups_mode_t">cups_mode_t
</a></h3>
945 <p class=
"description">cupsRasterOpen modes
</p>
947 typedef enum
<a href=
"#cups_mode_e">cups_mode_e
</a> cups_mode_t;
949 <h3 class=
"typedef"><a name=
"cups_order_t">cups_order_t
</a></h3>
950 <p class=
"description">cupsColorOrder attribute values
</p>
952 typedef enum
<a href=
"#cups_order_e">cups_order_e
</a> cups_order_t;
954 <h3 class=
"typedef"><a name=
"cups_orient_t">cups_orient_t
</a></h3>
955 <p class=
"description">Orientation attribute values
</p>
957 typedef enum
<a href=
"#cups_orient_e">cups_orient_e
</a> cups_orient_t;
959 <h3 class=
"typedef"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"cups_page_header2_t">cups_page_header2_t
</a></h3>
960 <p class=
"description">Version
2 page header
</p>
962 typedef struct
<a href=
"#cups_page_header2_s">cups_page_header2_s
</a> cups_page_header2_t;
964 <h3 class=
"typedef"><span class=
"info"> DEPRECATED
</span><a name=
"cups_page_header_t">cups_page_header_t
</a></h3>
965 <p class=
"description">Version
1 page header
</p>
967 typedef struct
<a href=
"#cups_page_header_s">cups_page_header_s
</a> cups_page_header_t;
969 <h3 class=
"typedef"><a name=
"cups_raster_iocb_t">cups_raster_iocb_t
</a></h3>
970 <p class=
"description">cupsRasterOpenIO callback function
</p>
972 typedef ssize_t (*cups_raster_iocb_t)(void *ctx, unsigned char *buffer, size_t length);
974 <h3 class=
"typedef"><a name=
"cups_raster_t">cups_raster_t
</a></h3>
975 <p class=
"description">Raster stream data
</p>
977 typedef struct _cups_raster_s cups_raster_t;
979 <h2 class=
"title"><a name=
"STRUCTURES">Structures
</a></h2>
980 <h3 class=
"struct"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"cups_page_header2_s">cups_page_header2_s
</a></h3>
981 <p class=
"description">Version
2 page header
</p>
982 <p class=
"code">struct cups_page_header2_s {
<br>
983 unsigned AdvanceDistance;
<br>
984 <a href=
"#cups_adv_t">cups_adv_t
</a> AdvanceMedia;
<br>
985 <a href=
"#cups_bool_t">cups_bool_t
</a> Collate;
<br>
986 <a href=
"#cups_cut_t">cups_cut_t
</a> CutMedia;
<br>
987 <a href=
"#cups_bool_t">cups_bool_t
</a> Duplex;
<br>
988 unsigned HWResolution[
2];
<br>
989 unsigned ImagingBoundingBox[
4];
<br>
990 <a href=
"#cups_bool_t">cups_bool_t
</a> InsertSheet;
<br>
991 <a href=
"#cups_jog_t">cups_jog_t
</a> Jog;
<br>
992 <a href=
"#cups_edge_t">cups_edge_t
</a> LeadingEdge;
<br>
993 <a href=
"#cups_bool_t">cups_bool_t
</a> ManualFeed;
<br>
994 unsigned Margins[
2];
<br>
995 char MediaClass[
64];
<br>
996 char MediaColor[
64];
<br>
997 unsigned MediaPosition;
<br>
998 char MediaType[
64];
<br>
999 unsigned MediaWeight;
<br>
1000 <a href=
"#cups_bool_t">cups_bool_t
</a> MirrorPrint;
<br>
1001 <a href=
"#cups_bool_t">cups_bool_t
</a> NegativePrint;
<br>
1002 unsigned NumCopies;
<br>
1003 <a href=
"#cups_orient_t">cups_orient_t
</a> Orientation;
<br>
1004 <a href=
"#cups_bool_t">cups_bool_t
</a> OutputFaceUp;
<br>
1005 char OutputType[
64];
<br>
1006 unsigned PageSize[
2];
<br>
1007 <a href=
"#cups_bool_t">cups_bool_t
</a> Separations;
<br>
1008 <a href=
"#cups_bool_t">cups_bool_t
</a> TraySwitch;
<br>
1009 <a href=
"#cups_bool_t">cups_bool_t
</a> Tumble;
<br>
1010 unsigned cupsBitsPerColor;
<br>
1011 unsigned cupsBitsPerPixel;
<br>
1012 float cupsBorderlessScalingFactor;
<br>
1013 unsigned cupsBytesPerLine;
<br>
1014 <a href=
"#cups_order_t">cups_order_t
</a> cupsColorOrder;
<br>
1015 <a href=
"#cups_cspace_t">cups_cspace_t
</a> cupsColorSpace;
<br>
1016 unsigned cupsCompression;
<br>
1017 unsigned cupsHeight;
<br>
1018 float cupsImagingBBox[
4];
<br>
1019 unsigned cupsInteger[
16];
<br>
1020 char cupsMarkerType[
64];
<br>
1021 unsigned cupsMediaType;
<br>
1022 unsigned cupsNumColors;
<br>
1023 char cupsPageSizeName[
64];
<br>
1024 float cupsPageSize[
2];
<br>
1025 float cupsReal[
16];
<br>
1026 char cupsRenderingIntent[
64];
<br>
1027 unsigned cupsRowCount;
<br>
1028 unsigned cupsRowFeed;
<br>
1029 unsigned cupsRowStep;
<br>
1030 char cupsString[
16][
64];
<br>
1031 unsigned cupsWidth;
<br>
1033 <h4 class=
"members">Members
</h4>
1035 <dt>AdvanceDistance
</dt>
1036 <dd class=
"description">AdvanceDistance value in points
</dd>
1037 <dt>AdvanceMedia
</dt>
1038 <dd class=
"description">AdvanceMedia value (
<a href=
"#cups_adv_t"><code>cups_adv_t
</code></a>)
</dd>
1040 <dd class=
"description">Collated copies value
</dd>
1042 <dd class=
"description">CutMedia value (
<a href=
"#cups_cut_t"><code>cups_cut_t
</code></a>)
</dd>
1044 <dd class=
"description">Duplexed (double-sided) value
</dd>
1045 <dt>HWResolution[
2]
</dt>
1046 <dd class=
"description">Resolution in dots-per-inch
</dd>
1047 <dt>ImagingBoundingBox[
4]
</dt>
1048 <dd class=
"description">Pixel region that is painted (points, left, bottom, right, top)
</dd>
1049 <dt>InsertSheet
</dt>
1050 <dd class=
"description">InsertSheet value
</dd>
1052 <dd class=
"description">Jog value (
<a href=
"#cups_jog_t"><code>cups_jog_t
</code></a>)
</dd>
1053 <dt>LeadingEdge
</dt>
1054 <dd class=
"description">LeadingEdge value (
<a href=
"#cups_edge_t"><code>cups_edge_t
</code></a>)
</dd>
1055 <dt>ManualFeed
</dt>
1056 <dd class=
"description">ManualFeed value
</dd>
1057 <dt>Margins[
2]
</dt>
1058 <dd class=
"description">Lower-lefthand margins in points
</dd>
1059 <dt>MediaClass[
64]
</dt>
1060 <dd class=
"description">MediaClass string
</dd>
1061 <dt>MediaColor[
64]
</dt>
1062 <dd class=
"description">MediaColor string
</dd>
1063 <dt>MediaPosition
</dt>
1064 <dd class=
"description">MediaPosition value
</dd>
1065 <dt>MediaType[
64]
</dt>
1066 <dd class=
"description">MediaType string
</dd>
1067 <dt>MediaWeight
</dt>
1068 <dd class=
"description">MediaWeight value in grams/m^
2</dd>
1069 <dt>MirrorPrint
</dt>
1070 <dd class=
"description">MirrorPrint value
</dd>
1071 <dt>NegativePrint
</dt>
1072 <dd class=
"description">NegativePrint value
</dd>
1074 <dd class=
"description">Number of copies to produce
</dd>
1075 <dt>Orientation
</dt>
1076 <dd class=
"description">Orientation value (
<a href=
"#cups_orient_t"><code>cups_orient_t
</code></a>)
</dd>
1077 <dt>OutputFaceUp
</dt>
1078 <dd class=
"description">OutputFaceUp value
</dd>
1079 <dt>OutputType[
64]
</dt>
1080 <dd class=
"description">OutputType string
</dd>
1081 <dt>PageSize[
2]
</dt>
1082 <dd class=
"description">Width and length of page in points
</dd>
1083 <dt>Separations
</dt>
1084 <dd class=
"description">Separations value
</dd>
1085 <dt>TraySwitch
</dt>
1086 <dd class=
"description">TraySwitch value
</dd>
1088 <dd class=
"description">Tumble value
</dd>
1089 <dt>cupsBitsPerColor
</dt>
1090 <dd class=
"description">Number of bits for each color
</dd>
1091 <dt>cupsBitsPerPixel
</dt>
1092 <dd class=
"description">Number of bits for each pixel
</dd>
1093 <dt>cupsBorderlessScalingFactor
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1094 <dd class=
"description">Scaling that was applied to page data
</dd>
1095 <dt>cupsBytesPerLine
</dt>
1096 <dd class=
"description">Number of bytes per line
</dd>
1097 <dt>cupsColorOrder
</dt>
1098 <dd class=
"description">Order of colors
</dd>
1099 <dt>cupsColorSpace
</dt>
1100 <dd class=
"description">True colorspace
</dd>
1101 <dt>cupsCompression
</dt>
1102 <dd class=
"description">Device compression to use
</dd>
1103 <dt>cupsHeight
</dt>
1104 <dd class=
"description">Height of page image in pixels
</dd>
1105 <dt>cupsImagingBBox[
4]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1106 <dd class=
"description">Floating point ImagingBoundingBox
1107 (scaling factor not applied, left,
1108 bottom, right, top)
</dd>
1109 <dt>cupsInteger[
16]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1110 <dd class=
"description">User-defined integer values
</dd>
1111 <dt>cupsMarkerType[
64]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1112 <dd class=
"description">Ink/toner type
</dd>
1113 <dt>cupsMediaType
</dt>
1114 <dd class=
"description">Media type code
</dd>
1115 <dt>cupsNumColors
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1116 <dd class=
"description">Number of color compoents
</dd>
1117 <dt>cupsPageSizeName[
64]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1118 <dd class=
"description">PageSize name
</dd>
1119 <dt>cupsPageSize[
2]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1120 <dd class=
"description">Floating point PageSize (scaling *
1121 factor not applied)
</dd>
1122 <dt>cupsReal[
16]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1123 <dd class=
"description">User-defined floating-point values
</dd>
1124 <dt>cupsRenderingIntent[
64]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1125 <dd class=
"description">Color rendering intent
</dd>
1126 <dt>cupsRowCount
</dt>
1127 <dd class=
"description">Rows per band
</dd>
1128 <dt>cupsRowFeed
</dt>
1129 <dd class=
"description">Feed between bands
</dd>
1130 <dt>cupsRowStep
</dt>
1131 <dd class=
"description">Spacing between lines
</dd>
1132 <dt>cupsString[
16][
64]
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1133 <dd class=
"description">User-defined string values
</dd>
1135 <dd class=
"description">Width of page image in pixels
</dd>
1137 <h3 class=
"struct"><span class=
"info"> DEPRECATED
</span><a name=
"cups_page_header_s">cups_page_header_s
</a></h3>
1138 <p class=
"description">Version
1 page header
</p>
1139 <p class=
"code">struct cups_page_header_s {
<br>
1140 unsigned AdvanceDistance;
<br>
1141 <a href=
"#cups_adv_t">cups_adv_t
</a> AdvanceMedia;
<br>
1142 <a href=
"#cups_bool_t">cups_bool_t
</a> Collate;
<br>
1143 <a href=
"#cups_cut_t">cups_cut_t
</a> CutMedia;
<br>
1144 <a href=
"#cups_bool_t">cups_bool_t
</a> Duplex;
<br>
1145 unsigned HWResolution[
2];
<br>
1146 unsigned ImagingBoundingBox[
4];
<br>
1147 <a href=
"#cups_bool_t">cups_bool_t
</a> InsertSheet;
<br>
1148 <a href=
"#cups_jog_t">cups_jog_t
</a> Jog;
<br>
1149 <a href=
"#cups_edge_t">cups_edge_t
</a> LeadingEdge;
<br>
1150 <a href=
"#cups_bool_t">cups_bool_t
</a> ManualFeed;
<br>
1151 unsigned Margins[
2];
<br>
1152 char MediaClass[
64];
<br>
1153 char MediaColor[
64];
<br>
1154 unsigned MediaPosition;
<br>
1155 char MediaType[
64];
<br>
1156 unsigned MediaWeight;
<br>
1157 <a href=
"#cups_bool_t">cups_bool_t
</a> MirrorPrint;
<br>
1158 <a href=
"#cups_bool_t">cups_bool_t
</a> NegativePrint;
<br>
1159 unsigned NumCopies;
<br>
1160 <a href=
"#cups_orient_t">cups_orient_t
</a> Orientation;
<br>
1161 <a href=
"#cups_bool_t">cups_bool_t
</a> OutputFaceUp;
<br>
1162 char OutputType[
64];
<br>
1163 unsigned PageSize[
2];
<br>
1164 <a href=
"#cups_bool_t">cups_bool_t
</a> Separations;
<br>
1165 <a href=
"#cups_bool_t">cups_bool_t
</a> TraySwitch;
<br>
1166 <a href=
"#cups_bool_t">cups_bool_t
</a> Tumble;
<br>
1167 unsigned cupsBitsPerColor;
<br>
1168 unsigned cupsBitsPerPixel;
<br>
1169 unsigned cupsBytesPerLine;
<br>
1170 <a href=
"#cups_order_t">cups_order_t
</a> cupsColorOrder;
<br>
1171 <a href=
"#cups_cspace_t">cups_cspace_t
</a> cupsColorSpace;
<br>
1172 unsigned cupsCompression;
<br>
1173 unsigned cupsHeight;
<br>
1174 unsigned cupsMediaType;
<br>
1175 unsigned cupsRowCount;
<br>
1176 unsigned cupsRowFeed;
<br>
1177 unsigned cupsRowStep;
<br>
1178 unsigned cupsWidth;
<br>
1180 <h4 class=
"members">Members
</h4>
1182 <dt>AdvanceDistance
</dt>
1183 <dd class=
"description">AdvanceDistance value in points
</dd>
1184 <dt>AdvanceMedia
</dt>
1185 <dd class=
"description">AdvanceMedia value (
<a href=
"#cups_adv_t"><code>cups_adv_t
</code></a>)
</dd>
1187 <dd class=
"description">Collated copies value
</dd>
1189 <dd class=
"description">CutMedia value (
<a href=
"#cups_cut_t"><code>cups_cut_t
</code></a>)
</dd>
1191 <dd class=
"description">Duplexed (double-sided) value
</dd>
1192 <dt>HWResolution[
2]
</dt>
1193 <dd class=
"description">Resolution in dots-per-inch
</dd>
1194 <dt>ImagingBoundingBox[
4]
</dt>
1195 <dd class=
"description">Pixel region that is painted (points, left, bottom, right, top)
</dd>
1196 <dt>InsertSheet
</dt>
1197 <dd class=
"description">InsertSheet value
</dd>
1199 <dd class=
"description">Jog value (
<a href=
"#cups_jog_t"><code>cups_jog_t
</code></a>)
</dd>
1200 <dt>LeadingEdge
</dt>
1201 <dd class=
"description">LeadingEdge value (
<a href=
"#cups_edge_t"><code>cups_edge_t
</code></a>)
</dd>
1202 <dt>ManualFeed
</dt>
1203 <dd class=
"description">ManualFeed value
</dd>
1204 <dt>Margins[
2]
</dt>
1205 <dd class=
"description">Lower-lefthand margins in points
</dd>
1206 <dt>MediaClass[
64]
</dt>
1207 <dd class=
"description">MediaClass string
</dd>
1208 <dt>MediaColor[
64]
</dt>
1209 <dd class=
"description">MediaColor string
</dd>
1210 <dt>MediaPosition
</dt>
1211 <dd class=
"description">MediaPosition value
</dd>
1212 <dt>MediaType[
64]
</dt>
1213 <dd class=
"description">MediaType string
</dd>
1214 <dt>MediaWeight
</dt>
1215 <dd class=
"description">MediaWeight value in grams/m^
2</dd>
1216 <dt>MirrorPrint
</dt>
1217 <dd class=
"description">MirrorPrint value
</dd>
1218 <dt>NegativePrint
</dt>
1219 <dd class=
"description">NegativePrint value
</dd>
1221 <dd class=
"description">Number of copies to produce
</dd>
1222 <dt>Orientation
</dt>
1223 <dd class=
"description">Orientation value (
<a href=
"#cups_orient_t"><code>cups_orient_t
</code></a>)
</dd>
1224 <dt>OutputFaceUp
</dt>
1225 <dd class=
"description">OutputFaceUp value
</dd>
1226 <dt>OutputType[
64]
</dt>
1227 <dd class=
"description">OutputType string
</dd>
1228 <dt>PageSize[
2]
</dt>
1229 <dd class=
"description">Width and length of page in points
</dd>
1230 <dt>Separations
</dt>
1231 <dd class=
"description">Separations value
</dd>
1232 <dt>TraySwitch
</dt>
1233 <dd class=
"description">TraySwitch value
</dd>
1235 <dd class=
"description">Tumble value
</dd>
1236 <dt>cupsBitsPerColor
</dt>
1237 <dd class=
"description">Number of bits for each color
</dd>
1238 <dt>cupsBitsPerPixel
</dt>
1239 <dd class=
"description">Number of bits for each pixel
</dd>
1240 <dt>cupsBytesPerLine
</dt>
1241 <dd class=
"description">Number of bytes per line
</dd>
1242 <dt>cupsColorOrder
</dt>
1243 <dd class=
"description">Order of colors
</dd>
1244 <dt>cupsColorSpace
</dt>
1245 <dd class=
"description">True colorspace
</dd>
1246 <dt>cupsCompression
</dt>
1247 <dd class=
"description">Device compression to use
</dd>
1248 <dt>cupsHeight
</dt>
1249 <dd class=
"description">Height of page image in pixels
</dd>
1250 <dt>cupsMediaType
</dt>
1251 <dd class=
"description">Media type code
</dd>
1252 <dt>cupsRowCount
</dt>
1253 <dd class=
"description">Rows per band
</dd>
1254 <dt>cupsRowFeed
</dt>
1255 <dd class=
"description">Feed between bands
</dd>
1256 <dt>cupsRowStep
</dt>
1257 <dd class=
"description">Spacing between lines
</dd>
1259 <dd class=
"description">Width of page image in pixels
</dd>
1261 <h2 class=
"title"><a name=
"ENUMERATIONS">Constants
</a></h2>
1262 <h3 class=
"enumeration"><a name=
"cups_adv_e">cups_adv_e
</a></h3>
1263 <p class=
"description">AdvanceMedia attribute values
</p>
1264 <h4 class=
"constants">Constants
</h4>
1266 <dt>CUPS_ADVANCE_FILE
</dt>
1267 <dd class=
"description">Advance the roll after this file
</dd>
1268 <dt>CUPS_ADVANCE_JOB
</dt>
1269 <dd class=
"description">Advance the roll after this job
</dd>
1270 <dt>CUPS_ADVANCE_NONE
</dt>
1271 <dd class=
"description">Never advance the roll
</dd>
1272 <dt>CUPS_ADVANCE_PAGE
</dt>
1273 <dd class=
"description">Advance the roll after this page
</dd>
1274 <dt>CUPS_ADVANCE_SET
</dt>
1275 <dd class=
"description">Advance the roll after this set
</dd>
1277 <h3 class=
"enumeration"><a name=
"cups_bool_e">cups_bool_e
</a></h3>
1278 <p class=
"description">Boolean type
</p>
1279 <h4 class=
"constants">Constants
</h4>
1281 <dt>CUPS_FALSE
</dt>
1282 <dd class=
"description">Logical false
</dd>
1284 <dd class=
"description">Logical true
</dd>
1286 <h3 class=
"enumeration"><a name=
"cups_cspace_e">cups_cspace_e
</a></h3>
1287 <p class=
"description">cupsColorSpace attribute values
</p>
1288 <h4 class=
"constants">Constants
</h4>
1290 <dt>CUPS_CSPACE_ADOBERGB
<span class=
"info"> CUPS
1.4.5 </span></dt>
1291 <dd class=
"description">Red, green, blue (Adobe RGB)
</dd>
1292 <dt>CUPS_CSPACE_CIELab
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1293 <dd class=
"description">CIE Lab
</dd>
1294 <dt>CUPS_CSPACE_CIEXYZ
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1295 <dd class=
"description">CIE XYZ
</dd>
1296 <dt>CUPS_CSPACE_CMY
</dt>
1297 <dd class=
"description">Cyan, magenta, yellow (DeviceCMY)
</dd>
1298 <dt>CUPS_CSPACE_CMYK
</dt>
1299 <dd class=
"description">Cyan, magenta, yellow, black (DeviceCMYK)
</dd>
1300 <dt>CUPS_CSPACE_DEVICE1
<span class=
"info"> CUPS
1.4.5 </span></dt>
1301 <dd class=
"description">DeviceN,
1 color
</dd>
1302 <dt>CUPS_CSPACE_DEVICE2
<span class=
"info"> CUPS
1.4.5 </span></dt>
1303 <dd class=
"description">DeviceN,
2 colors
</dd>
1304 <dt>CUPS_CSPACE_DEVICE3
<span class=
"info"> CUPS
1.4.5 </span></dt>
1305 <dd class=
"description">DeviceN,
3 colors
</dd>
1306 <dt>CUPS_CSPACE_DEVICE4
<span class=
"info"> CUPS
1.4.5 </span></dt>
1307 <dd class=
"description">DeviceN,
4 colors
</dd>
1308 <dt>CUPS_CSPACE_DEVICE5
<span class=
"info"> CUPS
1.4.5 </span></dt>
1309 <dd class=
"description">DeviceN,
5 colors
</dd>
1310 <dt>CUPS_CSPACE_DEVICE6
<span class=
"info"> CUPS
1.4.5 </span></dt>
1311 <dd class=
"description">DeviceN,
6 colors
</dd>
1312 <dt>CUPS_CSPACE_DEVICE7
<span class=
"info"> CUPS
1.4.5 </span></dt>
1313 <dd class=
"description">DeviceN,
7 colors
</dd>
1314 <dt>CUPS_CSPACE_DEVICE8
<span class=
"info"> CUPS
1.4.5 </span></dt>
1315 <dd class=
"description">DeviceN,
8 colors
</dd>
1316 <dt>CUPS_CSPACE_DEVICE9
<span class=
"info"> CUPS
1.4.5 </span></dt>
1317 <dd class=
"description">DeviceN,
9 colors
</dd>
1318 <dt>CUPS_CSPACE_DEVICEA
<span class=
"info"> CUPS
1.4.5 </span></dt>
1319 <dd class=
"description">DeviceN,
10 colors
</dd>
1320 <dt>CUPS_CSPACE_DEVICEB
<span class=
"info"> CUPS
1.4.5 </span></dt>
1321 <dd class=
"description">DeviceN,
11 colors
</dd>
1322 <dt>CUPS_CSPACE_DEVICEC
<span class=
"info"> CUPS
1.4.5 </span></dt>
1323 <dd class=
"description">DeviceN,
12 colors
</dd>
1324 <dt>CUPS_CSPACE_DEVICED
<span class=
"info"> CUPS
1.4.5 </span></dt>
1325 <dd class=
"description">DeviceN,
13 colors
</dd>
1326 <dt>CUPS_CSPACE_DEVICEE
<span class=
"info"> CUPS
1.4.5 </span></dt>
1327 <dd class=
"description">DeviceN,
14 colors
</dd>
1328 <dt>CUPS_CSPACE_DEVICEF
<span class=
"info"> CUPS
1.4.5 </span></dt>
1329 <dd class=
"description">DeviceN,
15 colors
</dd>
1330 <dt>CUPS_CSPACE_GMCK
<span class=
"info"> DEPRECATED
</span></dt>
1331 <dd class=
"description">Gold, magenta, yellow, black
</dd>
1332 <dt>CUPS_CSPACE_GMCS
<span class=
"info"> DEPRECATED
</span></dt>
1333 <dd class=
"description">Gold, magenta, yellow, silver
</dd>
1334 <dt>CUPS_CSPACE_GOLD
<span class=
"info"> DEPRECATED
</span></dt>
1335 <dd class=
"description">Gold foil
</dd>
1336 <dt>CUPS_CSPACE_ICC1
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1337 <dd class=
"description">ICC-based,
1 color
</dd>
1338 <dt>CUPS_CSPACE_ICC2
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1339 <dd class=
"description">ICC-based,
2 colors
</dd>
1340 <dt>CUPS_CSPACE_ICC3
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1341 <dd class=
"description">ICC-based,
3 colors
</dd>
1342 <dt>CUPS_CSPACE_ICC4
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1343 <dd class=
"description">ICC-based,
4 colors
</dd>
1344 <dt>CUPS_CSPACE_ICC5
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1345 <dd class=
"description">ICC-based,
5 colors
</dd>
1346 <dt>CUPS_CSPACE_ICC6
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1347 <dd class=
"description">ICC-based,
6 colors
</dd>
1348 <dt>CUPS_CSPACE_ICC7
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1349 <dd class=
"description">ICC-based,
7 colors
</dd>
1350 <dt>CUPS_CSPACE_ICC8
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1351 <dd class=
"description">ICC-based,
8 colors
</dd>
1352 <dt>CUPS_CSPACE_ICC9
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1353 <dd class=
"description">ICC-based,
9 colors
</dd>
1354 <dt>CUPS_CSPACE_ICCA
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1355 <dd class=
"description">ICC-based,
10 colors
</dd>
1356 <dt>CUPS_CSPACE_ICCB
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1357 <dd class=
"description">ICC-based,
11 colors
</dd>
1358 <dt>CUPS_CSPACE_ICCC
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1359 <dd class=
"description">ICC-based,
12 colors
</dd>
1360 <dt>CUPS_CSPACE_ICCD
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1361 <dd class=
"description">ICC-based,
13 colors
</dd>
1362 <dt>CUPS_CSPACE_ICCE
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1363 <dd class=
"description">ICC-based,
14 colors
</dd>
1364 <dt>CUPS_CSPACE_ICCF
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1365 <dd class=
"description">ICC-based,
15 colors
</dd>
1366 <dt>CUPS_CSPACE_K
</dt>
1367 <dd class=
"description">Black (DeviceK)
</dd>
1368 <dt>CUPS_CSPACE_KCMY
<span class=
"info"> DEPRECATED
</span></dt>
1369 <dd class=
"description">Black, cyan, magenta, yellow
</dd>
1370 <dt>CUPS_CSPACE_KCMYcm
<span class=
"info"> DEPRECATED
</span></dt>
1371 <dd class=
"description">Black, cyan, magenta, yellow, light-cyan, light-magenta
</dd>
1372 <dt>CUPS_CSPACE_RGB
</dt>
1373 <dd class=
"description">Red, green, blue (DeviceRGB, sRGB by default)
</dd>
1374 <dt>CUPS_CSPACE_RGBA
</dt>
1375 <dd class=
"description">Red, green, blue, alpha (DeviceRGB, sRGB by default)
</dd>
1376 <dt>CUPS_CSPACE_RGBW
<span class=
"info"> CUPS
1.2/OS X
10.5 </span></dt>
1377 <dd class=
"description">Red, green, blue, white (DeviceRGB, sRGB by default)
</dd>
1378 <dt>CUPS_CSPACE_SILVER
<span class=
"info"> DEPRECATED
</span></dt>
1379 <dd class=
"description">Silver foil
</dd>
1380 <dt>CUPS_CSPACE_SRGB
<span class=
"info"> CUPS
1.4.5 </span></dt>
1381 <dd class=
"description">Red, green, blue (sRGB)
</dd>
1382 <dt>CUPS_CSPACE_SW
<span class=
"info"> CUPS
1.4.5 </span></dt>
1383 <dd class=
"description">Luminance (gamma
2.2)
</dd>
1384 <dt>CUPS_CSPACE_W
</dt>
1385 <dd class=
"description">Luminance (DeviceGray, gamma
2.2 by default)
</dd>
1386 <dt>CUPS_CSPACE_WHITE
<span class=
"info"> DEPRECATED
</span></dt>
1387 <dd class=
"description">White ink (as black)
</dd>
1388 <dt>CUPS_CSPACE_YMC
<span class=
"info"> DEPRECATED
</span></dt>
1389 <dd class=
"description">Yellow, magenta, cyan
</dd>
1390 <dt>CUPS_CSPACE_YMCK
<span class=
"info"> DEPRECATED
</span></dt>
1391 <dd class=
"description">Yellow, magenta, cyan, black
</dd>
1393 <h3 class=
"enumeration"><a name=
"cups_cut_e">cups_cut_e
</a></h3>
1394 <p class=
"description">CutMedia attribute values
</p>
1395 <h4 class=
"constants">Constants
</h4>
1397 <dt>CUPS_CUT_FILE
</dt>
1398 <dd class=
"description">Cut the roll after this file
</dd>
1399 <dt>CUPS_CUT_JOB
</dt>
1400 <dd class=
"description">Cut the roll after this job
</dd>
1401 <dt>CUPS_CUT_NONE
</dt>
1402 <dd class=
"description">Never cut the roll
</dd>
1403 <dt>CUPS_CUT_PAGE
</dt>
1404 <dd class=
"description">Cut the roll after this page
</dd>
1405 <dt>CUPS_CUT_SET
</dt>
1406 <dd class=
"description">Cut the roll after this set
</dd>
1408 <h3 class=
"enumeration"><a name=
"cups_edge_e">cups_edge_e
</a></h3>
1409 <p class=
"description">LeadingEdge attribute values
</p>
1410 <h4 class=
"constants">Constants
</h4>
1412 <dt>CUPS_EDGE_BOTTOM
</dt>
1413 <dd class=
"description">Leading edge is the bottom of the page
</dd>
1414 <dt>CUPS_EDGE_LEFT
</dt>
1415 <dd class=
"description">Leading edge is the left of the page
</dd>
1416 <dt>CUPS_EDGE_RIGHT
</dt>
1417 <dd class=
"description">Leading edge is the right of the page
</dd>
1418 <dt>CUPS_EDGE_TOP
</dt>
1419 <dd class=
"description">Leading edge is the top of the page
</dd>
1421 <h3 class=
"enumeration"><a name=
"cups_jog_e">cups_jog_e
</a></h3>
1422 <p class=
"description">Jog attribute values
</p>
1423 <h4 class=
"constants">Constants
</h4>
1425 <dt>CUPS_JOG_FILE
</dt>
1426 <dd class=
"description">Move pages after this file
</dd>
1427 <dt>CUPS_JOG_JOB
</dt>
1428 <dd class=
"description">Move pages after this job
</dd>
1429 <dt>CUPS_JOG_NONE
</dt>
1430 <dd class=
"description">Never move pages
</dd>
1431 <dt>CUPS_JOG_SET
</dt>
1432 <dd class=
"description">Move pages after this set
</dd>
1434 <h3 class=
"enumeration"><a name=
"cups_mode_e">cups_mode_e
</a></h3>
1435 <p class=
"description">cupsRasterOpen modes
</p>
1436 <h4 class=
"constants">Constants
</h4>
1438 <dt>CUPS_RASTER_READ
</dt>
1439 <dd class=
"description">Open stream for reading
</dd>
1440 <dt>CUPS_RASTER_WRITE
</dt>
1441 <dd class=
"description">Open stream for writing
</dd>
1442 <dt>CUPS_RASTER_WRITE_COMPRESSED
<span class=
"info"> CUPS
1.3/OS X
10.5 </span></dt>
1443 <dd class=
"description">Open stream for compressed writing
</dd>
1444 <dt>CUPS_RASTER_WRITE_PWG
<span class=
"info"> CUPS
1.5/OS X
10.7 </span></dt>
1445 <dd class=
"description">Open stream for compressed writing in PWG mode
</dd>
1447 <h3 class=
"enumeration"><a name=
"cups_order_e">cups_order_e
</a></h3>
1448 <p class=
"description">cupsColorOrder attribute values
</p>
1449 <h4 class=
"constants">Constants
</h4>
1451 <dt>CUPS_ORDER_BANDED
</dt>
1452 <dd class=
"description">CCC MMM YYY KKK ...
</dd>
1453 <dt>CUPS_ORDER_CHUNKED
</dt>
1454 <dd class=
"description">CMYK CMYK CMYK ...
</dd>
1455 <dt>CUPS_ORDER_PLANAR
</dt>
1456 <dd class=
"description">CCC ... MMM ... YYY ... KKK ...
</dd>
1458 <h3 class=
"enumeration"><a name=
"cups_orient_e">cups_orient_e
</a></h3>
1459 <p class=
"description">Orientation attribute values
</p>
1460 <h4 class=
"constants">Constants
</h4>
1462 <dt>CUPS_ORIENT_0
</dt>
1463 <dd class=
"description">Don't rotate the page
</dd>
1464 <dt>CUPS_ORIENT_180
</dt>
1465 <dd class=
"description">Turn the page upside down
</dd>
1466 <dt>CUPS_ORIENT_270
</dt>
1467 <dd class=
"description">Rotate the page clockwise
</dd>
1468 <dt>CUPS_ORIENT_90
</dt>
1469 <dd class=
"description">Rotate the page counter-clockwise
</dd>