racket/collects/net/scribblings/gifwrite.scrbl
Matthew Flatt 8284b3ab15 net docs finished
svn: r9317
2008-04-15 14:13:10 +00:00

37 lines
1.0 KiB
Racket

#lang scribble/doc
@(require scribble/manual
scribble/extract
(for-label net/gifwrite))
@title[#:tag "gifwrite"]{GIF: Writing Image Files}
@defmodule[net/gifwrite]
The @schememodname[net/gifwrite] library provides functions for
writing GIF files to a stream, including GIF files with multiple
images and controls (such as animated GIFs).
A GIF stream is created by @scheme[gif-start], and then individual
images are written with @scheme[gif-add-image]. Optionally,
@scheme[gif-add-control] inserts instructions for rendering the
images. The @scheme[gif-end] function ends the GIF stream.
A GIF stream can be in any one of the following states:
@itemize{
@item{@scheme['init] : no images or controls have been added to the
stream}
@item{@scheme['image-or-control] : another image or control can be
written}
@item{@scheme['image] : another image can be written (but not a
control, since a control was written)}
@item{@scheme['done] : nothing more can be added}
}
@(include-extracted "../gifwrite.ss")