Update of /project/cl-gd/cvsroot/cl-gd/doc In directory common-lisp.net:/tmp/cvs-serv14058/doc Modified Files: index.html Log Message: pre-0.3.1 with hyperdoc support Date: Fri Apr 23 20:29:27 2004 Author: eweitz Index: cl-gd/doc/index.html diff -u cl-gd/doc/index.html:1.1.1.1 cl-gd/doc/index.html:1.2 --- cl-gd/doc/index.html:1.1.1.1 Tue Jan 6 20:02:43 2004 +++ cl-gd/doc/index.html Fri Apr 23 20:29:27 2004 @@ -82,7 +82,8 @@ about this. GD (and thus CL-GD) can't create GIF images due to <a href="http://www.boutell.com/gd/faq.html">the Unisys LZW patent</a>. And for most examples it wouldn't make much sense to use -JPEGs instead. +JPEGs instead. (Update: But see the <a href="#gif">note below</a> about +GIF support.) <br> <br><h3><a class=none name="contents">Contents</a></h3> <ul> @@ -106,6 +107,7 @@ <li><a href="#write-jpeg-to-stream"><code>write-jpeg-to-stream</code></a> <li><a href="#write-png-to-stream"><code>write-png-to-stream</code></a> <li><a href="#write-wbmp-to-stream"><code>write-wbmp-to-stream</code></a> + <li><a href="#write-gif-to-stream"><code>write-gif-to-stream</code></a> <li><a href="#write-gd-to-stream"><code>write-gd-to-stream</code></a> <li><a href="#write-gd2-to-stream"><code>write-gd2-to-stream</code></a> <li><a href="#write-image-to-stream"><code>write-image-to-stream</code></a> @@ -186,7 +188,7 @@ CL-GD together with this documentation can be downloaded from <a href="http://weitz.de/files/cl-gd.tgz">http://weitz.de/files/cl-gd.tgz</a>. The -current version is 0.2.0. A <a href="http://packages.debian.org/cgi-bin/search_packages.pl?keywords=cl-gd&searchon=names&subword=1&version=all&release=all">Debian package</a> is available thanks to <a href="http://b9.com/">Kevin Rosenberg</a>, so if you're on Debian you should have no problems installing CL-GD. There's also a port +current version is 0.3.0. A <a href="http://packages.debian.org/cgi-bin/search_packages.pl?keywords=cl-gd&searchon=names&subword=1&version=all&release=all">Debian package</a> is available thanks to <a href="http://b9.com/">Kevin Rosenberg</a>, so if you're on Debian you should have no problems installing CL-GD. There's also a port for <a href="http://www.cliki.net/gentoo">Gentoo Linux</a> thanks to Matthew Kennedy. Otherwise, proceed like this: <ul> <li>Download and install a recent version of <a href="http://www.cliki.net/asdf">asdf</a>. @@ -224,6 +226,19 @@ where you should obviously replace the path above with the pull path to the font on your machine. </ul> <p> +<a name="gif" class=none>Note about GIF support:</a> The original GD library doesn't support the <a +href="http://burnallgifs.org/">GIF file format</a> due to the <a +href="http://www.unisys.com/about__unisys/lzw">patent</a> Unisys holds +on the LZW compression algorithm. However, some distributions (notably +the FreeBSD port for non-US users) do include the ability to read and write GIF +files. Hans Hübner has patched CL-GD to use this ability. If you want +GIF support first make sure that you have a corresponding version of +GD installed and then +<pre> +(push :cl-gd-gif *features*) +</pre> +<em>before</em> you compile and load CL-GD. +<p> Note to Windows users: I've heard that it's possible to compile and use GD with <a href="http://www.cygwin.com/">Cygwin</a>. I haven't tried it myself but if you succeed in using CL-GD on Windows it'd be nice if you could send some notes so I can add them to this document. Thanks. Addendum: Jeff Caldwell notes that <a href="http://mapserver.gis.umn.edu/doc35/mapserver-cygwin-howto.html">this website</a> has good explanations about how to install GD and its supporting libraries. <p> <b>It is recommended that you at least skim over the <a href="http://www.boutell.com/gd/manual2.0.15.html">original GD documentation</a> before you start using CL-GD.</b> @@ -270,6 +285,8 @@ as <code><i>type</i></code> (one of the keywords <code>:JPG</code>, <code>:JPEG</code>, <code>:PNG</code>, <code>:GD</code>, <code>:GD2</code>, <code>:XBM</code>, or <code>:XPM</code>), or otherwise it will be guessed from the <code>PATHNAME-TYPE</code> of <code><i>file-name</i></code>. You are responsible for <a href="#destroy-image">destroying</a> the image after you're done with it. It is advisable to use <a href="#with-image-from-file"><code>WITH-IMAGE-FROM-FILE</code></a> instead. +<p> +If you have built CL-GD <a href="#gif">with GIF support</a> <code><i>type</i></code> can also be <code>:GIF</code>. </blockquote> <p><br>[Function] @@ -427,6 +444,19 @@ </blockquote> <p><br>[Function] +<br><a class=none name="write-gif-to-stream"><b>write-gif-to-stream</b> <i>stream <tt>&key</tt> image</i> => <i>image</i></a> + +<blockquote><br> +Writes image <code><i>image</i></code> to the stream +<code><i>stream</i></code> as a GIF file. <code><i>stream</i></code> must be a character stream or a binary +stream of element type <code>(UNSIGNED-BYTE 8)</code>. If STREAM is a character +stream, the user of this function has to make sure the external format +yields <a href="http://cl-cookbook.sf.net/io.html#faith">faithful output</a> of all 8-bit characters. CL-GD knows about AllegroCL's <a href="http://www.franz.com/support/documentation/6.2/doc/streams.htm">simple streams</a> and the bivalent streams of <a href="http://www.lispworks.com/">LispWorks</a> 4.3 and acts accordingly, i.e. it uses <code>WRITE-BYTE</code> instead of <code>WRITE-CHAR</code> whenever possible. +<p> +This function is only available if you've managed to build CL-GD <a href="#gif">with GIF support</a>. +</blockquote> + +<p><br>[Function] <br><a class=none name="write-gd2-to-stream"><b>write-gd2-to-stream</b> <i>stream <tt>&key</tt> image</i> => <i>image</i></a> <blockquote><br> @@ -447,6 +477,8 @@ stream of element type <code>(UNSIGNED-BYTE 8)</code>. If STREAM is a character stream, the user of this function has to make sure the external format yields <a href="http://cl-cookbook.sf.net/io.html#faith">faithful output</a> of all 8-bit characters. CL-GD knows about AllegroCL's <a href="http://www.franz.com/support/documentation/6.2/doc/streams.htm">simple streams</a> and the bivalent streams of <a href="http://www.lispworks.com/">LispWorks</a> 4.3 and acts accordingly, i.e. it uses <code>WRITE-BYTE</code> instead of <code>WRITE-CHAR</code> whenever possible. +<p> +If you have built CL-GD <a href="#gif">with GIF support</a> <code><i>type</i></code> can also be <code>:GIF</code>. </blockquote> <p><br>[Function] @@ -1339,9 +1371,10 @@ href="http://www.boutell.com/gd/">GD</a> and thanks to Kevin Rosenberg for <a href="http://uffi.b9.com/">UFFI</a> without which CL-GD would not have been possible. Kevin was also extremely helpful when I needed -functionality which wasn't yet part of UFFI. +functionality which wasn't yet part of UFFI. Thanks to <a href="http://huebner.org/">Hans +Hübner</a> for the GIF patches. <p> -$Header: /project/cl-gd/cvsroot/cl-gd/doc/index.html,v 1.1.1.1 2004/01/07 01:02:43 eweitz Exp $ +$Header: /project/cl-gd/cvsroot/cl-gd/doc/index.html,v 1.2 2004/04/24 00:29:27 eweitz Exp $ <p><a href="http://weitz.de/index.html">BACK TO MY HOMEPAGE</a> </body>