filter/api-raster.shtml

   1 <!--
   2   "$Id$"
   3
   4   Raster API introduction for the Common UNIX Printing System (CUPS).
   5
   6   Copyright 2007 by Apple Inc.
   7   Copyright 1997-2006 by Easy Software Products, all rights reserved.
   8
   9   These coded instructions, statements, and computer programs are the
  10   property of Apple Inc. and are protected by Federal copyright
  11   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12   which should have been included with this file.  If this file is
  13   file is missing or damaged, see the license at "http://www.cups.org/".
  14 -->
  15
  16 <h2 class='title'>Introduction</h2>
  17
  18 <p>The CUPS raster API provides a standard interface for reading
  19 and writing CUPS raster streams which are used for printing to
  20 raster printers. Because the raster format is updated from time
  21 to time, it is important to use this API to avoid
  22 incompatibilities with newer versions of CUPS.</p>
  23
  24 <h2 class='title'>General Usage</h2>
  25
  26 <p>The <var>&lt;cups/raster.h&gt;</var> header file must be
  27 included to use the <tt>cupsRaster</tt> functions.</p>
  28
  29 <p>Programs using these functions must be linked to the CUPS
  30 imaging library: <var>libcupsimage.a</var>,
  31 <var>libcupsimage.so.2</var>, <var>libcupsimage.2.dylib</var>,
  32 <var>libcupsimage_s.a</var>, or <var>libcupsimage2.lib</var>
  33 depending on the platform. The following command compiles
  34 <var>myprogram.c</var> using GCC and the CUPS imaging
  35 library:</p>
  36
  37 <pre class='command'>
  38 <kbd>gcc -o myprogram myprogram.c -lcupsimage</kbd>
  39 </pre>
  40
  41 <h2 class='title'>Compatibility</h2>
  42
  43 <p>Unless otherwise specified, the raster API functions require
  44 CUPS 1.1 or higher.</p>
  45
  46 <h2 class='title'>Licensing</h2>
  47
  48 <p>The CUPS raster API is provided under the terms of the GNU
  49 Library General Public License, with exceptions for MacOS X-based
  50 programs. Please see the CUPS license agreement for more
  51 information.</p>