SvgaLib/doc/man3/gl_compileboxmask.3

52 lines
1.4 KiB
Groff

.TH gl_compileboxmask 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
.SH NAME
gl_compileboxmask \- compress a masked bitmap
.SH SYNOPSIS
.B #include <vgagl.h>
.BI "void gl_compileboxmask(int " w ", int " h ", void *" sdp ", void *" ddp );
.SH DESCRIPTION
Convert the rectangular masked bitmap of size
.RI ( w ", " h ") at " sdp
to a compressed format that allows faster drawing, which is
stored at
.IR ddp .
Allocating
.IR w " * " h
bytes for the compiled
version is usually enough; an upper limit should be
.RI ( w " + 2) * " h .
Compiled bitmaps are only supported in linear 256 color modes.
.SH SEE ALSO
.BR svgalib (7),
.BR vgagl (7),
.BR svgalib.conf (5),
.BR threedkit (7),
.BR testgl (1),
.BR plane (1),
.BR wrapdemo (1),
.BR gl_compileboxmask (3),
.BR gl_compiledboxmasksize (3),
.BR gl_getbox (3),
.BR gl_putbox (3),
.BR gl_putboxpart (3),
.BR gl_putboxmask (3),
.BR gl_putboxmaskcompiled (3).
.SH AUTHOR
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
exact source of the referenced demo as well as of the original documentation is
unknown.
It is very likely that both are at least to some extent are due to
Harm Hanemaayer <H.Hanemaayer@inter.nl.net>.
Occasionally this might be wrong. I hereby
asked to be excused by the original author and will happily accept any additions or corrections
to this first version of the svgalib manual.