diff options
Diffstat (limited to 'doc/help/api-raster.html')
| -rw-r--r-- | doc/help/api-raster.html | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/help/api-raster.html b/doc/help/api-raster.html index 9acda474f..a604bd09a 100644 --- a/doc/help/api-raster.html +++ b/doc/help/api-raster.html @@ -399,6 +399,7 @@ div.contents ul.subcontents li { </ul></li> <li><a href="#FUNCTIONS">Functions</a><ul class="code"> <li><a href="#cupsRasterClose" title="Close a raster stream.">cupsRasterClose</a></li> + <li><a href="#cupsRasterInitPWGHeader" title="Initialize a page header for PWG Raster output.">cupsRasterInitPWGHeader</a></li> <li><a href="#cupsRasterInterpretPPD" title="Interpret PPD commands to create a page header.">cupsRasterInterpretPPD</a></li> <li><a href="#cupsRasterOpen" title="Open a raster stream using a file descriptor.">cupsRasterOpen</a></li> <li><a href="#cupsRasterOpenIO" title="Open a raster stream using a callback function.">cupsRasterOpenIO</a></li> @@ -620,6 +621,50 @@ void cupsRasterClose (<br> <h4 class="discussion">Discussion</h4> <p class="discussion">The file descriptor associated with the raster stream must be closed separately as needed.</p> +<h3 class="function"><span class="info"> CUPS 2.2 </span><a name="cupsRasterInitPWGHeader">cupsRasterInitPWGHeader</a></h3> +<p class="description">Initialize a page header for PWG Raster output.</p> +<p class="code"> +int cupsRasterInitPWGHeader (<br> + <a href="#cups_page_header2_t">cups_page_header2_t</a> *h,<br> + pwg_media_t *media,<br> + const char *type,<br> + int xdpi,<br> + int ydpi,<br> + const char *sides,<br> + const char *sheet_back<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>h</dt> +<dd class="description">Page header</dd> +<dt>media</dt> +<dd class="description">PWG media information</dd> +<dt>type</dt> +<dd class="description">PWG raster type string</dd> +<dt>xdpi</dt> +<dd class="description">Cross-feed direction (horizontal) resolution</dd> +<dt>ydpi</dt> +<dd class="description">Feed direction (vertical) resolution</dd> +<dt>sides</dt> +<dd class="description">IPP "sides" option value</dd> +<dt>sheet_back</dt> +<dd class="description">Transform for back side or <code>NULL</code> for none</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">The "media" argument specifies the media to use.<br> +<br> +The "type" argument specifies a "pwg-raster-document-type-supported" value +that controls the color space and bit depth of the raster data.<br> +<br> +The "xres" and "yres" arguments specify the raster resolution in dots per +inch.<br> +<br> +The "sheet_back" argument specifies a "pwg-raster-document-sheet-back" value +to apply for the back side of a page. Pass <code>NULL</code> for the front side. + +</p> <h3 class="function"><span class="info"> CUPS 1.2/OS X 10.5 </span><a name="cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></h3> <p class="description">Interpret PPD commands to create a page header.</p> <p class="code"> |