racket/collects/file/scribblings/gif.scrbl
Eli Barzilay ac26fe7554 A ton of @scheme*' -> @racket*' and related updates.
Also, updates some of the mzlib files to point at `racket/*' libraries
rather than to `scheme/*' ones.
2011-06-25 04:08:47 -04:00

37 lines
1.0 KiB
Racket

#lang scribble/doc
@(require scribble/manual
scribble/extract
(for-label file/gif))
@title[#:tag "gif"]{GIF File Writing}
@defmodule[file/gif]
The @racketmodname[file/gif] 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 @racket[gif-start], and then individual
images are written with @racket[gif-add-image]. Optionally,
@racket[gif-add-control] inserts instructions for rendering the
images. The @racket[gif-end] function ends the GIF stream.
A GIF stream can be in any one of the following states:
@itemize[
@item{@racket['init] : no images or controls have been added to the
stream}
@item{@racket['image-or-control] : another image or control can be
written}
@item{@racket['image] : another image can be written (but not a
control, since a control was written)}
@item{@racket['done] : nothing more can be added}
]
@(include-extracted "../gif.rkt")