racket/collects/sgl/scribblings/bitmap.scrbl
Matthew Flatt 82c212625b sgl docs
svn: r9362
2008-04-18 18:49:23 +00:00

29 lines
978 B
Racket

#lang scribble/doc
@(require "common.ss"
(for-label scheme/class))
@title[#:tag "bitmaps"]{Bitmaps}
@defmodule[sgl/bitmap]
@defproc[(bitmap->gl-list [bitmap (is-a?/c bitmap%)]
[#:with-gl with-gl-proc ((-> any) . -> . any)
(lambda (f) (f))]
[#:mask mask (or/c (is-a?/c bitmap%) false/c)
(send bitmap get-loaded-mask)])
exact-integer?]{
Converts the given bitmap into an OpenGL list that can be rendered
with @scheme[gl-call-list] or @scheme[glCallList]. The rendered object
is a square on the @math{z=0} plane with corners at @math{(0,0)} and
@math{(1,1)}.
The @scheme[with-gl-proc] must accept a thunk and call it while the
relevant OpenGL context is selected. Otherwise, the relevant OpenGL
context must be selected already.
If @scheme[mask] is not @scheme[#f], it is used as the mask bitmap for
extracting alpha values.}