Initial. Don't... just don't ask.
This commit is contained in:
commit
00bae13bba
586 changed files with 129057 additions and 0 deletions
1
doc/man3/currentcontext.3
Normal file
1
doc/man3/currentcontext.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_getcontext.3
|
||||
48
doc/man3/gl_allocatecontext.3
Normal file
48
doc/man3/gl_allocatecontext.3
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
.TH gl_allocatecontext 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_allocatecontext \- allocate a graphics context
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "GraphicsContext *gl_allocatecontext(void);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
Allocate a graphics context. This is preferred to
|
||||
hardcoding a context variable in a program since the
|
||||
latter is incompatible with a future vgagl version that
|
||||
have additional context fields.
|
||||
|
||||
.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 currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setcontextwidth (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.
|
||||
66
doc/man3/gl_bcircle.3
Normal file
66
doc/man3/gl_bcircle.3
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
.TH gl_bcircle 3 "4 Dec 1999" "Svgalib (>= 1.4.1)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_bcircle \- draw a filled or unfilled Bresenham circle
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_bcircle(int " x ", int " y ", int " r ", int " c ", int " fill ");"
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draw a Bresenham circle of radius
|
||||
.I r
|
||||
in color
|
||||
.I c ,
|
||||
centered at
|
||||
.I ( x ", " y ).
|
||||
|
||||
.I Fill
|
||||
should be 0 for a hollow circle, or any other value for a solid color.
|
||||
|
||||
This function differs from gl_circle (3) and gl_fillcircle (3) in that it
|
||||
looks good in 320 x 200 screen modes. The modified algorithm was provided
|
||||
by Chris Atenasio <chris@svgalib.org>, and is based upon Bresenham's
|
||||
formula.
|
||||
|
||||
Note that the "circle" is technically an ellipse, and is actually wider
|
||||
than it is tall. Therefore,
|
||||
.I r
|
||||
is equal to the circle's height, but is less than its width. This
|
||||
distortion is necessary to accomodate the 8:5 aspect ratio (e.g., 320 x
|
||||
200).
|
||||
|
||||
I don't recommend using this function in standard 4:3 screen modes (e.g.,
|
||||
640 x 480 and higher). Furthermore, care must be taken so that a circle
|
||||
drawn with this function isn't copied to a screen with a different aspect
|
||||
ratio. Otherwise, the result may be undesirable.
|
||||
|
||||
.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_circle (3),
|
||||
.BR gl_clearscreen (3),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_disableclipping (3),
|
||||
.BR gl_enableclipping (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_fillcircle (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_setclippingwindow (3),
|
||||
.BR gl_setpalette (3),
|
||||
.BR gl_setpalettecolor (3),
|
||||
.BR gl_setpalettecolors (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (3),
|
||||
.BR gl_setrgbpalette (3),
|
||||
.BR gl_setwritemode (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was written by Jay Link <jlink@svgalib.org>.
|
||||
53
doc/man3/gl_circle.3
Normal file
53
doc/man3/gl_circle.3
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
.TH gl_circle 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_circle \- draw a circle
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_circle(int " x ", int " y ", int " r ", int " c );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draw a circle of radius
|
||||
.I r
|
||||
in color
|
||||
.IR c ,
|
||||
centered at
|
||||
.RI ( x ", " y ).
|
||||
|
||||
.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_clearscreen (3),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_disableclipping (3),
|
||||
.BR gl_enableclipping (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_setclippingwindow (3),
|
||||
.BR gl_setpalette (3),
|
||||
.BR gl_setpalettecolor (3),
|
||||
.BR gl_setpalettecolors (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (3),
|
||||
.BR gl_setrgbpalette (3),
|
||||
.BR gl_setwritemode (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.
|
||||
39
doc/man3/gl_clearscreen.3
Normal file
39
doc/man3/gl_clearscreen.3
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
.TH gl_clearscreen 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_clearscreen \- clear the screen
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_clearscreen(int " c );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Fill the entire screen with color
|
||||
.IR c .
|
||||
|
||||
.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 currentcontext (3),
|
||||
.BR gl_circle (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_line (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.
|
||||
45
doc/man3/gl_colorfont.3
Normal file
45
doc/man3/gl_colorfont.3
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
.TH gl_colorfont 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_colorfont \- change the color of a font
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_colorfont(int " fw ", int " fh ", int " c ", void *" fp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Set all nonzero pixels in the expanded font
|
||||
.I fp
|
||||
with 256 characters of size
|
||||
.IR fw " and " fh
|
||||
each to color
|
||||
.IR c .
|
||||
|
||||
.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_colorfont (3),
|
||||
.BR gl_expandfont (3),
|
||||
.BR gl_font8x8 (3),
|
||||
.BR gl_setfontcolors (3),
|
||||
.BR gl_write (3),
|
||||
.BR gl_writen (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.
|
||||
52
doc/man3/gl_compileboxmask.3
Normal file
52
doc/man3/gl_compileboxmask.3
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
.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.
|
||||
46
doc/man3/gl_compiledboxmasksize.3
Normal file
46
doc/man3/gl_compiledboxmasksize.3
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
.TH gl_compiledboxmasksize 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_compiledboxmasksize \- compute the size of a compiled masked box
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "int gl_compiledboxmasksize(int " w ", int " h ", void *" sdp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Returns the size of the compiled version of the masked
|
||||
bitmap of size
|
||||
.RI ( w ", " h )
|
||||
at
|
||||
.I sdp
|
||||
that would be generated by
|
||||
.BR compileboxmask(3).
|
||||
|
||||
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_putbox (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.
|
||||
51
doc/man3/gl_copybox.3
Normal file
51
doc/man3/gl_copybox.3
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
.TH gl_copybox 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_copybox \- copy a rectangular screen area
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_copybox(int " x1 ", int " y1 ", int " w ", int " h
|
||||
.BI ", int "x2 ", int " y2 );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the rectangular area at
|
||||
.BR (x1 ", " y1 )
|
||||
of size
|
||||
.BR (w ", " h ),
|
||||
to
|
||||
.BR (x2 ", " y2 )
|
||||
(screencopy).
|
||||
|
||||
.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_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_putboxpart (3),
|
||||
.BR gl_scalebox (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.
|
||||
57
doc/man3/gl_copyboxfromcontext.3
Normal file
57
doc/man3/gl_copyboxfromcontext.3
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
.TH gl_copyboxfromcontext 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_copyboxfromcontext \- copy rectangular area from another context
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_copyboxfromcontext(GraphicsContext *" gc ", int " x1 ", int "
|
||||
.IB y1 ", int " w ", int " h ", int " x2 ", int " y2 );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the rectangular area at
|
||||
.RI ( x1 ", " y1 )
|
||||
in the context
|
||||
.IR gc
|
||||
of size
|
||||
.RI ( w ", " h )
|
||||
to position
|
||||
.RI ( x2 ", " y2 )
|
||||
in the current context.
|
||||
|
||||
This is more efficient than
|
||||
.BR copyboxtocontext (3).
|
||||
|
||||
.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_copybox (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_putboxpart (3),
|
||||
.BR gl_rgbcolor (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.
|
||||
52
doc/man3/gl_copyboxtocontext.3
Normal file
52
doc/man3/gl_copyboxtocontext.3
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
.TH gl_copyboxtocontext 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_copyboxtocontext \- copy a rectangular area to another context
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_copyboxtocontext(int " x1 ", int " y1 ", int " w ", int " h
|
||||
.BI ", GraphicsContext *" gc ", int " x2 ", int " y2 );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the rectangular area at
|
||||
.RI ( x1 ", " y1 )
|
||||
of size
|
||||
.RI ( w ", " h )
|
||||
to position
|
||||
.RI ( x2 ", " y2 )
|
||||
in the context
|
||||
.IR gc .
|
||||
If possible use
|
||||
.BR copyboxfromcontext (3).
|
||||
|
||||
.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_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_putboxpart (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.
|
||||
45
doc/man3/gl_copyscreen.3
Normal file
45
doc/man3/gl_copyscreen.3
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
.TH gl_copyscreen 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_copyscreen \- copy the screen contents of contexts
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_copyscreen(GraphicsContext *" gc );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the current graphics context contents (screen data) to
|
||||
the specified graphics context (the physical screen, for
|
||||
example). Contexts are assumed to be identical in size.
|
||||
|
||||
.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 currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_clearscreen (3),
|
||||
.BR gl_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (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.
|
||||
36
doc/man3/gl_disableclipping.3
Normal file
36
doc/man3/gl_disableclipping.3
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
.TH gl_disableclipping 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_disableclipping \- disables clipping
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_disableclipping(void);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
Disable clipping. This is the default.
|
||||
|
||||
.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_enableclipping (3),
|
||||
.BR gl_setclippingwindow (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.
|
||||
41
doc/man3/gl_enableclipping.3
Normal file
41
doc/man3/gl_enableclipping.3
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
.TH gl_enableclipping 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_enableclipping \- enables clipping
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_enableclipping(void);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
Enable automatic clipping in most functions. No, I don't know
|
||||
which ones. However, it works for most.
|
||||
.BR gl_copybox (3)
|
||||
is report to do no clipping.
|
||||
|
||||
Go figure.
|
||||
|
||||
.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_disableclipping (3),
|
||||
.BR gl_setclippingwindow (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.
|
||||
71
doc/man3/gl_enablepageflipping.3
Normal file
71
doc/man3/gl_enablepageflipping.3
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
.TH gl_enablepageflipping 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_enablepageflipping \- enables automatic page flipping
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "int gl_enablepageflipping(GraphicsContext *" gc );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Enable page flipping or triple buffering in
|
||||
.BR gl_copyscreen (3)
|
||||
if the physical context
|
||||
.I gc
|
||||
can do it.
|
||||
|
||||
Returns 3 if triple
|
||||
buffering will be used, 2 for page flipping, 0 if page
|
||||
flipping is not possible (due to video memory/mode
|
||||
limitations).
|
||||
|
||||
When pageflipping is enabled, the
|
||||
.BR gl_screenoffset (3)
|
||||
is ignored in
|
||||
.BR gl_copyscreen (3).
|
||||
|
||||
The idea is that you draw your picture in
|
||||
.I gc
|
||||
and copy it to the screen by consecutive
|
||||
.BR gl_copyscreen (3)
|
||||
calls. Each of these will choose a free buffer in the screen and
|
||||
adjust the display start accourdingly.
|
||||
|
||||
The current context must by the VGA when
|
||||
.BR gl_copyscreen (3)
|
||||
is called in this situation.
|
||||
|
||||
.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_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setcontextwidth (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.
|
||||
53
doc/man3/gl_expandfont.3
Normal file
53
doc/man3/gl_expandfont.3
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
.TH gl_expandfont 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_expandfont \- expand a packed pixel font
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_expandfont(int " fw ", int " fh ", int " c ", void *" sfp ", void *" dfp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Convert a bit-per-pixel font at
|
||||
.IR sfp
|
||||
with 256 characters of size
|
||||
.RI ( fw ", " fh )
|
||||
to an expanded font of character pixmaps, stored at
|
||||
.I dfp
|
||||
(size will be 256 *
|
||||
.IR fw " * " fw
|
||||
.RB " * " BYTESPERPIXEL ).
|
||||
All non-zero pixels are set to color
|
||||
.IR c .
|
||||
|
||||
It is possible to use non expanded fonts (but it is slower) when
|
||||
the
|
||||
.BR "FONT_COMPRESSED gl_setwritemode" (3)
|
||||
flag is set.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR testgl (1),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_font8x8 (3),
|
||||
.BR gl_setfont (3),
|
||||
.BR gl_setfontcolors (3),
|
||||
.BR gl_setwritemode (3),
|
||||
.BR gl_write (3),
|
||||
.BR gl_writen (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.
|
||||
44
doc/man3/gl_fillbox.3
Normal file
44
doc/man3/gl_fillbox.3
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
.TH gl_fillbox 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_fillbox \- fill a rectangular area
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_fillbox(int " x ", int " y ", int " w ", int " h ", int " c );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Fill a rectangular area at position
|
||||
.RI ( x ", " y )
|
||||
with size
|
||||
.RI ( w ", " h )
|
||||
of the screen with a single color
|
||||
.IR c .
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR testgl (1),
|
||||
.BR currentcontext (3),
|
||||
.BR gl_clearscreen (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_putboxpart (3),
|
||||
.BR gl_scalebox (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.
|
||||
46
doc/man3/gl_fillcircle.3
Normal file
46
doc/man3/gl_fillcircle.3
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
.TH gl_fillcircle 3 "4 Dec 1999" "Svgalib (>= 1.4.1)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_fillcircle \- draw a filled circle
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_fillcircle(int " x ", int " y ", int " r ", int " c );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draw a filled circle of radius
|
||||
.I r
|
||||
in color
|
||||
.I c ,
|
||||
centered at
|
||||
.I ( x ", " y ).
|
||||
|
||||
.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_circle (3),
|
||||
.BR gl_clearscreen (3),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_disableclipping (3),
|
||||
.BR gl_enableclipping (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_setclippingwindow (3),
|
||||
.BR gl_setpalette (3),
|
||||
.BR gl_setpalettecolor (3),
|
||||
.BR gl_setpalettecolors (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (3),
|
||||
.BR gl_setrgbpalette (3),
|
||||
.BR gl_setwritemode (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was written by Jay Link <jlink@svgalib.org>. The function
|
||||
itself is based upon the original gl_circle (3).
|
||||
49
doc/man3/gl_font8x8.3
Normal file
49
doc/man3/gl_font8x8.3
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
.TH gl_font8x8 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_font8x8 \- a packed 8x8 pixel font
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "extern unsigned char *" gl_font8x8 ;
|
||||
|
||||
.SH DESCRIPTION
|
||||
.I gl_font8x8
|
||||
contains a packed pixel font with 8x8 pixels per character which you can
|
||||
use in your
|
||||
.B vgagl
|
||||
programs. Before you can use it, you might need to expand it with
|
||||
.BR gl_expandfont (3),
|
||||
though.
|
||||
|
||||
It is possible to use non expanded fonts (but it is slower) when
|
||||
the
|
||||
.BR "FONT_COMPRESSED gl_setwritemode" (3)
|
||||
flag is set.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR testgl (1),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_expandfont (3),
|
||||
.BR gl_setfont (3),
|
||||
.BR gl_setfontcolors (3),
|
||||
.BR gl_setwritemode (3),
|
||||
.BR gl_write (3),
|
||||
.BR gl_writen (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.
|
||||
45
doc/man3/gl_freecontext.3
Normal file
45
doc/man3/gl_freecontext.3
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
.TH gl_freecontext 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_freecontext \- free a virtual screen
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_freecontext(GraphicsContext *" gc );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Free the space allocated for the virtual screen in the
|
||||
given context
|
||||
.I gc
|
||||
which should better be a virtual context.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setcontextwidth (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.
|
||||
51
doc/man3/gl_getbox.3
Normal file
51
doc/man3/gl_getbox.3
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
.TH gl_getbox 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_getbox \- copy a rectangular pixmap from the screen to a buffer
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_getbox(int " x ", int " y ", int " w ", int " h ", void *" dp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy a rectangular bitmap at position
|
||||
.RI ( x ", " y )
|
||||
with size
|
||||
.RI ( w ", " h )
|
||||
from the screen to a buffer
|
||||
.IR dp .
|
||||
|
||||
Pixmaps are in row-major order. The destination pixmap has the size
|
||||
.IR w " * " h " * "
|
||||
.BR BYTESPERPIXEL .
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_compileboxmask (3),
|
||||
.BR gl_compiledboxmasksize (3),
|
||||
.BR gl_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_putboxpart (3),
|
||||
.BR gl_scalebox (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.
|
||||
69
doc/man3/gl_getcontext.3
Normal file
69
doc/man3/gl_getcontext.3
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
.TH gl_getcontext 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_getcontext, currentcontext \- get the current graphics contents.
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_getcontext(GraphicsContext *" gc );
|
||||
|
||||
.BI "extern GraphicsContext " currentcontext ;
|
||||
/* this is already in vgagl.h */
|
||||
|
||||
.SH DESCRIPTION
|
||||
Save the current context in the structure variable
|
||||
.IR gc .
|
||||
|
||||
You can also get the current context from the global
|
||||
variable
|
||||
.IR currentcontext ;
|
||||
|
||||
However, simply access single elements in this structure
|
||||
with the macros given in
|
||||
.BR vgagl (7)
|
||||
but do not copy
|
||||
.I currentcontext
|
||||
in another structure. This is because the size of the structure
|
||||
might change and your program does not know it when it will be
|
||||
linked dynamically to future svgalib versions.
|
||||
|
||||
Instead use
|
||||
.BR gl_allocatecontext (3)
|
||||
to allocate such a structure, fill it with
|
||||
.B gl_getcontext
|
||||
and release it with
|
||||
.BR free (3)
|
||||
after usage.
|
||||
|
||||
.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_allocatecontext (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_freecontext (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setcontextwidth (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.
|
||||
1
doc/man3/gl_getpalette.3
Normal file
1
doc/man3/gl_getpalette.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_getpalettecolor.3
|
||||
62
doc/man3/gl_getpalettecolor.3
Normal file
62
doc/man3/gl_getpalettecolor.3
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
.TH gl_getpalettecolor 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_getpalettecolor, gl_getpalettecolors, gl_getpalette \- read the color palette
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_getpalettecolor(int " c ", int *" r ", int *" g ", int *" b );
|
||||
.br
|
||||
.BI "void gl_getpalettecolors(int " s ", int " n ", void *" dp );
|
||||
.br
|
||||
.BI "void gl_getpalette(void *" dp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B gl_getpalettecolor
|
||||
gets red, green and blue values (in the range 0 - 63) of
|
||||
color
|
||||
.I c
|
||||
from the color-lookup-table, and stores
|
||||
them as integers in the memory locations pointed to by
|
||||
.IR r ", " g " and " b .
|
||||
|
||||
.B gl_getpalettecolors
|
||||
gets RGB values of
|
||||
.I n
|
||||
colors starting at
|
||||
.IR s ,
|
||||
which are stored
|
||||
as a table of groups of three bytes each at
|
||||
.IR dp .
|
||||
|
||||
.B gl_getpalette
|
||||
is equivalent to
|
||||
.BR "getpalettecolors(0, 256, " dp ).
|
||||
|
||||
.BR vga_ext_set (3)
|
||||
might change the range of the colors returned to 0 - 255.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR vga_ext_set (3),
|
||||
.BR gl_setpalette (3),
|
||||
.BR gl_setpalettecolor (3),
|
||||
.BR gl_setpalettecolors (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.
|
||||
1
doc/man3/gl_getpalettecolors.3
Normal file
1
doc/man3/gl_getpalettecolors.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_getpalettecolor.3
|
||||
47
doc/man3/gl_getpixel.3
Normal file
47
doc/man3/gl_getpixel.3
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
.TH gl_getpixel 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_getpixel \- return the color of a pixel
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "int gl_getpixel(int " x ", int " y );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Returns the color of pixel at position
|
||||
.RI ( x ", " y )
|
||||
in the format used in the screen memory.
|
||||
|
||||
The color -1 is returned for points outside the clipping window.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_getpalette (3),
|
||||
.BR gl_getpalettecolor (3),
|
||||
.BR gl_getpalettecolors (3),
|
||||
.BR gl_getpixelrgb (3),
|
||||
.BR gl_rgbcolor (3),
|
||||
.BR gl_setpalette (3),
|
||||
.BR gl_setpalettecolor (3),
|
||||
.BR gl_setpalettecolors (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (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.
|
||||
41
doc/man3/gl_getpixelrgb.3
Normal file
41
doc/man3/gl_getpixelrgb.3
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
.TH gl_getpixelrgb 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_getpixelrgb \- store color components of a pixel
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_getpixelrgb(int " x ", int " y ", int *" r ", int *" g ", int *" b );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Store color components from pixel at
|
||||
.RI ( x ", " y )
|
||||
ranging from 0 to 255 into integers pointed to by
|
||||
.IR r ", " g " and " b .
|
||||
|
||||
.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_getpixel (3),
|
||||
.BR gl_rgbcolor (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (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.
|
||||
47
doc/man3/gl_hline.3
Normal file
47
doc/man3/gl_hline.3
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
.TH gl_hline 3 "9 Feb 2000" "Svgalib (>= 1.4.2)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_hline \- draw a horizontal line
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_hline(int " x1 ", int " y ", int " x2 ", int " c );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draw a horizontal line from point
|
||||
.RI ( x1 ", " y )
|
||||
to
|
||||
.RI ( x2 ", " y )
|
||||
in color
|
||||
.IR c .
|
||||
x1 must not be larger than x2. If x2<x1 the function does nothing.
|
||||
|
||||
.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_circle (3),
|
||||
.BR gl_clearscreen (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (3),
|
||||
.BR gl_setwritemode (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.
|
||||
56
doc/man3/gl_line.3
Normal file
56
doc/man3/gl_line.3
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
.TH gl_line 3 "21 Aug 1999" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_line \- draw a line
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_line(int " x1 ", int " y1 ", int " x2 ", int " y2 ", int " c );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draw a line from point
|
||||
.RI ( x1 ", " y1 )
|
||||
to
|
||||
.RI ( x2 ", " y2 )
|
||||
inclusively in color
|
||||
.IR c .
|
||||
|
||||
You should not assume that the same drawing trajectory is used when you exchange start and
|
||||
end points.
|
||||
|
||||
To use this program one first sets up a mode with a regular
|
||||
vga_setmode call and vga_setpage(0), with possibly a
|
||||
vga_setlinearaddressing
|
||||
call. Then a call to gl_setcontextvga(mode) is made. This makes the
|
||||
information about the mode available to gl_line.
|
||||
|
||||
The pixels are placed directly into video memory using inline coded
|
||||
commands.
|
||||
|
||||
.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_circle (3),
|
||||
.BR gl_clearscreen (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (3),
|
||||
.BR gl_setcontextvga (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. This page was modified by Don Secrest <secrest@uiuc.edu>.
|
||||
|
||||
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.
|
||||
70
doc/man3/gl_printf.3
Normal file
70
doc/man3/gl_printf.3
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
.TH gl_printf 3 "22 Feb 1997" "Svgalib 1.3.0" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_printf \- write formatted output in graphic mode
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "int gl_printf(int " x ", int " y ", const char *" fmt ", ...);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B gl_printf
|
||||
writes, like
|
||||
.B printf(3)
|
||||
a formatted string to position
|
||||
.RI ( x ", " y )
|
||||
using the currently selected font. If one or both of
|
||||
.IR x " and " y
|
||||
is negative, the text printing continues at the last position. The
|
||||
special characters
|
||||
.BR \eb ", " \er ", "
|
||||
.BR \en ", " \ea ", "
|
||||
.BR \et " and " \ev
|
||||
have the usual effects.
|
||||
|
||||
Printing wraps at the screen borders. Nevertheless, behaviour is undefined
|
||||
if not a single characters fits on the screen or if the initial position
|
||||
is outside the screen.
|
||||
|
||||
The kind of text draw operation is set with
|
||||
.BR gl_setwritemode (3).
|
||||
|
||||
.B BEWARE!
|
||||
Prior to the of use of
|
||||
.BR gl_printf (3)
|
||||
you must set a font.
|
||||
|
||||
A good default initialization sequence is:
|
||||
|
||||
.B gl_setfont(8, 8, gl_font8x8);
|
||||
.br
|
||||
.B gl_setwritemode(FONT_COMPRESSED + WRITEMODE_OVERWRITE);
|
||||
.br
|
||||
.B gl_setfontcolors(0, vga_white());
|
||||
.br
|
||||
|
||||
.SH RETURN VALUE
|
||||
The number of characters printed.
|
||||
|
||||
.SH BUGS
|
||||
For compatibility reasons this function is not contained in a.out
|
||||
libraries.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR printf (3),
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_expandfont (3),
|
||||
.BR gl_font8x8 (3),
|
||||
.BR gl_setfont (3),
|
||||
.BR gl_setfontcolors (3),
|
||||
.BR gl_setwritemode (3),
|
||||
.BR gl_write (3),
|
||||
.BR gl_writechar (3),
|
||||
.BR printftest (6).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This function and manual page was written by Trek <trek00@freenet.hut.fi>
|
||||
<trek@mediaservice.net>.
|
||||
52
doc/man3/gl_putbox.3
Normal file
52
doc/man3/gl_putbox.3
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
.TH gl_putbox 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_putbox \- copy a pixmap to a rectangular area
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_putbox(int " x ", int " y ", int " w ", int " h ", void *" dp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the contents of a memory buffer
|
||||
.I dp
|
||||
to a rectangular bitmap at position
|
||||
.RI ( x ", " y )
|
||||
with size
|
||||
.RI ( w ", " h ).
|
||||
|
||||
Pixmaps are in row-major order. The source pixmap memory has the size
|
||||
.IR w " * " h " * "
|
||||
.BR BYTESPERPIXEL .
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_compileboxmask (3),
|
||||
.BR gl_compiledboxmasksize (3),
|
||||
.BR gl_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_putboxpart (3),
|
||||
.BR gl_scalebox (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.
|
||||
58
doc/man3/gl_putboxmask.3
Normal file
58
doc/man3/gl_putboxmask.3
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
.TH gl_putboxmask 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_putboxmask \- copy a masked pixmap to a rectangular area
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_putboxmask(int " x ", int " y ", int " w ", int " h ", void *" dp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the contents of a memory buffer
|
||||
.I dp
|
||||
to a rectangular bitmap at position
|
||||
.RI ( x ", " y )
|
||||
with size
|
||||
.RI ( w ", " h ).
|
||||
|
||||
This function works like
|
||||
.BR gl_putbox ,
|
||||
but does not write pixmap pixels of color zero. If the same pixmap is used often
|
||||
you should consider using the faster
|
||||
.BR gl_putboxmaskcompiled (3).
|
||||
|
||||
Pixmaps are in row-major order. The source pixmap memory has the size
|
||||
.IR w " * " h " * "
|
||||
.BR BYTESPERPIXEL .
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_compileboxmask (3),
|
||||
.BR gl_compiledboxmasksize (3),
|
||||
.BR gl_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_putboxpart (3),
|
||||
.BR gl_scalebox (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.
|
||||
55
doc/man3/gl_putboxmaskcompiled.3
Normal file
55
doc/man3/gl_putboxmaskcompiled.3
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
.TH gl_putboxmaskcompiled 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_putboxmaskcompiled \- copy a compiled masked pixmap to a rectangular area
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_putboxmaskcompiled(int " x ", int " y ", int " w ", int " h ", void *" dp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the contents of a memory buffer
|
||||
.I dp
|
||||
to a rectangular bitmap at position
|
||||
.RI ( x ", " y )
|
||||
with size
|
||||
.RI ( w ", " h ).
|
||||
|
||||
This function works like
|
||||
.BR gl_putbox ,
|
||||
but does not write pixmap pixels of color zero. Also, for faster operation the
|
||||
pixmap was compiled with
|
||||
.BR gl_compileboxmask (3)
|
||||
first.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_compileboxmask (3),
|
||||
.BR gl_compiledboxmasksize (3),
|
||||
.BR gl_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxpart (3),
|
||||
.BR gl_scalebox (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.
|
||||
60
doc/man3/gl_putboxpart.3
Normal file
60
doc/man3/gl_putboxpart.3
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
.TH gl_putboxpart 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_putboxpart \- copy a partial pixmap to a rectangular area
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_putboxpart(int " x ", int " y ", int " w ", int " h
|
||||
.BI ", int " bw ", int " bh ", void *" dp
|
||||
.BI ", int " xo ", int " yo );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Copy the contents of a memory buffer
|
||||
.I dp
|
||||
to a rectangular bitmap at position
|
||||
.RI ( x ", " y )
|
||||
with size
|
||||
.RI ( w ", " h ).
|
||||
|
||||
However, only a part of size
|
||||
.RI ( bw ", " bh )
|
||||
starting at offset
|
||||
.RI ( xo ", " yo )
|
||||
in the pixmap is copied.
|
||||
|
||||
Pixmaps are in row-major order. The source pixmap memory has the size
|
||||
.IR w " * " h " * "
|
||||
.BR BYTESPERPIXEL .
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_compileboxmask (3),
|
||||
.BR gl_compiledboxmasksize (3),
|
||||
.BR gl_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (3),
|
||||
.BR gl_putboxmask (3),
|
||||
.BR gl_putboxmaskcompiled (3),
|
||||
.BR gl_scalebox (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.
|
||||
40
doc/man3/gl_rgbcolor.3
Normal file
40
doc/man3/gl_rgbcolor.3
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
.TH gl_rgbcolor 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_rgbcolor \- return pixel value corresponding to an rgb color
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "int gl_rgbcolor(int " r ", int " g ", int " b );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Returns pixel value used in the current context that corresponds with the given color
|
||||
components. Used by
|
||||
.BR setpixelrgb (3).
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_circle (3),
|
||||
.BR gl_clearscreen (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_setpixel (3),
|
||||
.BR gl_setpixelrgb (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.
|
||||
46
doc/man3/gl_scalebox.3
Normal file
46
doc/man3/gl_scalebox.3
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
.TH gl_scalebox 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_scalebox \- scale a pixmap
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_scalebox(int " w1 ", int " h1 ", void *" sdp ", int " w2 ", int " h2 ", void *" ddp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Scale the bitmap of size
|
||||
.RI ( w1 ", " h1 )
|
||||
at
|
||||
.I sdp
|
||||
to size
|
||||
.RI ( w2 ", " h2 )
|
||||
and store it at
|
||||
.IR ddp ,
|
||||
which must be a large enough buffer.
|
||||
|
||||
The pixel size of the current graphics context is used.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_copybox (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_getbox (3),
|
||||
.BR gl_putbox (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.
|
||||
38
doc/man3/gl_setclippingwindow.3
Normal file
38
doc/man3/gl_setclippingwindow.3
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
.TH gl_setclippingwindow 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setclippingwindow \- set the clipping window
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setclippingwindow(int " x1 ", int " y1 ", int " x2 ", int " y2 );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Set the clipping window to the rectangle with top-left
|
||||
corner
|
||||
.RI ( x1 ", " y1 )
|
||||
and bottom-right corner
|
||||
.RI ( x2 ", " y2 )
|
||||
(inclusively).
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_disableclipping (3),
|
||||
.BR gl_enableclipping (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.
|
||||
43
doc/man3/gl_setcontext.3
Normal file
43
doc/man3/gl_setcontext.3
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
.TH gl_setcontext 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setcontext \- set a previously saved context
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setcontext(GraphicsContext *" gc );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Restore a previously saved context (make it the current
|
||||
context).
|
||||
|
||||
.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 currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_freecontext (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setcontextwidth (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.
|
||||
1
doc/man3/gl_setcontextheight.3
Normal file
1
doc/man3/gl_setcontextheight.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_setcontextwidth.3
|
||||
64
doc/man3/gl_setcontextvga.3
Normal file
64
doc/man3/gl_setcontextvga.3
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
.TH gl_setcontextvga 3 "21 Aug 1999" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setcontextvga \- set the context to the physical screen
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "int gl_setcontextvga(int " mode );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Set the graphics context to the physical screen of a
|
||||
vga mode (as defined in
|
||||
.BR vga_setmode (3)).
|
||||
The mode must be set with
|
||||
.BR vga_setmode (3)
|
||||
prior to using any of the drawing functions.
|
||||
.B vgagl
|
||||
does not take care of that.
|
||||
|
||||
The function returns 0 for success and non-zero if the mode is not supported by the
|
||||
hardware.
|
||||
|
||||
The only thing you can do with a planar (mode X-like)
|
||||
256 color mode is aligned
|
||||
.BR gl_putbox ,
|
||||
and use it as a target for
|
||||
.BR gl_copyscreen .
|
||||
|
||||
In all of the svga modes this program makes a description of the vga
|
||||
mode available to the vgagl functions. The 256 color svgamodes are
|
||||
handled properly by this program.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_freecontext (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setcontextwidth (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. This page was modified by Don Secrest <secrest@uiuc.edu>.
|
||||
|
||||
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.
|
||||
55
doc/man3/gl_setcontextvgavirtual.3
Normal file
55
doc/man3/gl_setcontextvgavirtual.3
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
.TH gl_setcontextvgavirtual 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setcontextvgavirtual \- set the context to a virtual mode
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "int gl_setcontextvgavirtual(int " mode );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Allocate a virtual screen in system memory identical to
|
||||
the graphics mode (as defined in
|
||||
.BR vga_setmode (3)),
|
||||
and make that the current graphics context.
|
||||
|
||||
The function returns 0 for success and non-zero if the mode is not supported by the
|
||||
hardware.
|
||||
|
||||
The only thing you can do with a planar (mode X-like)
|
||||
256 color mode is aligned
|
||||
.BR gl_putbox ,
|
||||
and use it as a target for
|
||||
.BR gl_copyscreen .
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_freecontext (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setcontextwidth (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.
|
||||
54
doc/man3/gl_setcontextvirtual.3
Normal file
54
doc/man3/gl_setcontextvirtual.3
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
.TH gl_setcontextvirtual 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setcontextvirtual \- define a virtual context
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setcontextvirtual(int " w ", int " h ", int " bpp ", int " bitspp ", void *" vbuf );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Define the current graphics context to have a width of
|
||||
.I w
|
||||
pixels, height
|
||||
.IR h ", " bpp
|
||||
bytes per pixel,
|
||||
.I bitspp
|
||||
significant
|
||||
color bits per pixel (8, 15, 16 or 24), with the framebuffer
|
||||
at
|
||||
.IR vbuf .
|
||||
A 4 bytes per pixel context, with 24 significant
|
||||
color bits is also valid.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_freecontext (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextheight (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextwidth (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.
|
||||
50
doc/man3/gl_setcontextwidth.3
Normal file
50
doc/man3/gl_setcontextwidth.3
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
.TH gl_setcontextwidth 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setcontextwidth, gl_setcontextheight \- set the dimension of a context
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setcontextwidth(int " w );
|
||||
.br
|
||||
.BI "void gl_setcontextheight(int " h );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Set the size of the current virtual context, effectively clipping everything to the
|
||||
top left corner of
|
||||
size
|
||||
.RI ( w ", " h ).
|
||||
|
||||
.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 currentcontext (3),
|
||||
.BR gl_allocatecontext (3),
|
||||
.BR gl_disableclipping (3),
|
||||
.BR gl_enableclipping (3),
|
||||
.BR gl_freecontext (3),
|
||||
.BR gl_getcontext (3),
|
||||
.BR gl_setcontext (3),
|
||||
.BR gl_setcontextvga (3),
|
||||
.BR gl_setcontextvgavirtual (3),
|
||||
.BR gl_setcontextvirtual (3),
|
||||
.BR gl_setdisplaystart (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.
|
||||
48
doc/man3/gl_setdisplaystart.3
Normal file
48
doc/man3/gl_setdisplaystart.3
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
.TH gl_setdisplaystart 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setdisplaystart \- set the start of the screen are displayed
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "vga gl_setdisplaystart(int " x ", int " y );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Set the physical display start address to the pixel at
|
||||
.RI ( x ", " y ).
|
||||
|
||||
Can be used for hardware scrolling, or for page flipping
|
||||
(e.g.
|
||||
.B setdisplaystart(0, HEIGHT)
|
||||
displays from the second
|
||||
page). Make sure the scanline width
|
||||
.RB ( BYTEWIDTH )
|
||||
in bytes
|
||||
of the current context corresponds with the physical
|
||||
screen.
|
||||
|
||||
Note also that the display start cannot be set to completely arbitrary points, see
|
||||
.BR vga_setdisplaystart (3).
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR vga_setdisplaystart (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_setscreenoffset (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.
|
||||
47
doc/man3/gl_setfont.3
Normal file
47
doc/man3/gl_setfont.3
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
.TH gl_setfont 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setfont \- set the text font to be used
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setfont(int " fw ", int " fh ", void *" fp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Use the font stored as character bitmaps at
|
||||
.IR fp ,
|
||||
with characters of size
|
||||
.RI ( fw ", " fh ),
|
||||
as the basic font for write
|
||||
operations. Note that the font included in the library must
|
||||
be expanded first, because it is stored bit-per-pixel;
|
||||
this is not required if the
|
||||
.B FONT_COMPRESSED
|
||||
.BR gl_setwritemode (3)
|
||||
flag is set.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_expandfont (3),
|
||||
.BR gl_font8x8 (3),
|
||||
.BR gl_setfontcolors (3),
|
||||
.BR gl_write (3),
|
||||
.BR gl_writen (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.
|
||||
43
doc/man3/gl_setfontcolors.3
Normal file
43
doc/man3/gl_setfontcolors.3
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
.TH gl_setfontcolors 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setfontcolors \- set the font colors
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setfontcolors(int " bg ", int " fg );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Set the background and foreground colors for the compressed
|
||||
font write mode which is set with
|
||||
.BR gl_setwritemode (3).
|
||||
|
||||
.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_colorfont (3),
|
||||
.BR gl_expandfont (3),
|
||||
.BR gl_font8x8 (3),
|
||||
.BR gl_setfont (3),
|
||||
.BR gl_setwritemode (3),
|
||||
.BR gl_write (3),
|
||||
.BR gl_writen (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.
|
||||
1
doc/man3/gl_setpalette.3
Normal file
1
doc/man3/gl_setpalette.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_setpalettecolor.3
|
||||
61
doc/man3/gl_setpalettecolor.3
Normal file
61
doc/man3/gl_setpalettecolor.3
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
.TH gl_setpalettecolor 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setpalettecolor, gl_setpalettecolors, gl_setpalette \- set the color palette
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setpalettecolor(int " c ", int " r ", int " g ", int " b );
|
||||
.br
|
||||
.BI "void gl_setpalettecolors(int " s ", int " n ", void *" sp );
|
||||
.br
|
||||
.BI "void gl_setpalette(void *" sp );
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B gl_setpalettecolor
|
||||
sets red, green and blue values (in the range 0 - 63) of
|
||||
color
|
||||
.I c
|
||||
from the color-lookup-table to
|
||||
.IR r ", " g " and " b .
|
||||
|
||||
.B gl_setpalettecolors
|
||||
sets RGB values of
|
||||
.I n
|
||||
colors starting at
|
||||
.IR s ,
|
||||
which are stored
|
||||
as a table of groups of three bytes each at
|
||||
.IR sp .
|
||||
|
||||
.B gl_setpalette
|
||||
is equivalent to
|
||||
.BR "setpalettecolors(0, 256, " sp ).
|
||||
|
||||
.BR vga_ext_set (3)
|
||||
might change the range of the colors to be set to 0 - 255.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR vga_ext_set (3),
|
||||
.BR gl_getpalette (3),
|
||||
.BR gl_getpalettecolor (3),
|
||||
.BR gl_getpalettecolors (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.
|
||||
1
doc/man3/gl_setpalettecolors.3
Normal file
1
doc/man3/gl_setpalettecolors.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_setpalettecolor.3
|
||||
56
doc/man3/gl_setpixel.3
Normal file
56
doc/man3/gl_setpixel.3
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
.TH gl_setpixel 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setpixel, gl_setpixelrgb \- draw a pixel
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setpixel(int " x ", int " y ", int " c ),
|
||||
.br
|
||||
.BI "void gl_setpixelrgb(int " x ", int " y ", int " r ", int " g ", int " b );
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B gl_setpixel
|
||||
draws a single pixel at position
|
||||
.RI ( x ", " y )
|
||||
in color
|
||||
.IR c .
|
||||
The lower
|
||||
8, 15, 16 or 24 bits of the color are significant, depending
|
||||
on the number of colors the current mode supports.
|
||||
|
||||
.B gl_setpixelrgb
|
||||
draws a single pixel at position
|
||||
.RI ( x ", " y )
|
||||
with color components
|
||||
.IR r ", " g ", and " b ,
|
||||
ranging from 0 to 255. In 256 color mode, only
|
||||
meaningful if the RGB palette is set
|
||||
.RB ( gl_setrgbpalette (3)).
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_circle (3),
|
||||
.BR gl_fillbox (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_rgbcolor (3),
|
||||
.BR gl_setrgbpalette (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.
|
||||
1
doc/man3/gl_setpixelrgb.3
Normal file
1
doc/man3/gl_setpixelrgb.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_setpixel.3
|
||||
46
doc/man3/gl_setrgbpalette.3
Normal file
46
doc/man3/gl_setrgbpalette.3
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
.TH gl_setrgbpalette 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setrgbpalette \- set a 256-color RGB palette
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setrgbpalette(void)"
|
||||
|
||||
.SH DESCRIPTION
|
||||
Sets 256-color RGB palette (bits 0 - 2 blue, 3 - 5 green,
|
||||
6 - 7 red).
|
||||
|
||||
Call this prior to using
|
||||
.BR gl_getpixelrgb (3),
|
||||
.BR gl_rgbcolor "(3), or "
|
||||
.BR gl_setpixelrgb (3)
|
||||
in 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_getpixelrgb (3),
|
||||
.BR gl_rgbcolor (3),
|
||||
.BR gl_setpalette (3),
|
||||
.BR gl_setpalettecolor (3),
|
||||
.BR gl_setpalettecolors (3),
|
||||
.BR gl_setpixelrgb (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.
|
||||
43
doc/man3/gl_setscreenoffset.3
Normal file
43
doc/man3/gl_setscreenoffset.3
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
.TH gl_setscreenoffset 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setscreenoffset \- set a memory offset for copyscreen
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setscreenoffset(int " o );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Set the offset in pixels into video memory for
|
||||
.BR copyscreen (3)
|
||||
and
|
||||
.BR copyboxtocontext (3),
|
||||
.BR copyboxfromcontext (3)
|
||||
and thus
|
||||
allows for page-flipping. Must be a
|
||||
multiple of the scanline width in bytes. It is reset to
|
||||
zero after the completion of
|
||||
.BR copyscreen (3).
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_copyboxfromcontext (3),
|
||||
.BR gl_copyboxtocontext (3),
|
||||
.BR gl_copyscreen (3),
|
||||
.BR gl_enablepageflipping (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.
|
||||
65
doc/man3/gl_setwritemode.3
Normal file
65
doc/man3/gl_setwritemode.3
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
.TH gl_setwritemode 3 "22 Feb 1998" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_setwritemode \- set the font writemode flags
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_setwritemode(int " m );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Sets the writemode flags for the font routines. It must be the sum of exactly
|
||||
one choice out of the following two groups:
|
||||
|
||||
.PD 0
|
||||
.TP
|
||||
.B WRITEMODE_MASKED
|
||||
.TP
|
||||
.BR WRITEMODE_OVERWRITE " (default)"
|
||||
.PD
|
||||
If
|
||||
.B WRITEMODE_MASKED
|
||||
is set, only foreground pixels of the font
|
||||
are used for write operations; the screen background is not
|
||||
erased.
|
||||
|
||||
|
||||
.PD 0
|
||||
.TP
|
||||
.B FONT_COMPRESSED
|
||||
.TP
|
||||
.BR FONT_EXPANDED " (default)"
|
||||
.PD
|
||||
If
|
||||
.B FONT_COMPRESSED
|
||||
is set, text writes will use the compressed
|
||||
bit-per-pixel font rather than the expanded font (which would be slightly faster).
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_expandfont (3),
|
||||
.BR gl_font8x8 (3),
|
||||
.BR gl_hline (3),
|
||||
.BR gl_line (3),
|
||||
.BR gl_setfont (3),
|
||||
.BR gl_setfontcolors (3),
|
||||
.BR gl_write (3),
|
||||
.BR gl_writen (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.
|
||||
91
doc/man3/gl_striangle.3
Normal file
91
doc/man3/gl_striangle.3
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
.TH gl_striangle 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_striangle \- draw a solid colored triangle
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <triangle.h>
|
||||
|
||||
.BI "void gl_striangle(int " x0 ", int " y0 ", int " x1 ", int " y1
|
||||
.BI ", int "x2 ", int " y2 ", int " color ", int " bf );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draws a non-interpolated (solid) triangle between the three points 0, 1 and 2
|
||||
with the color
|
||||
.IR color .
|
||||
|
||||
The
|
||||
.I bf
|
||||
value is used to tell the routine not to draw
|
||||
the triangle if it is facing the other way.
|
||||
.I bf
|
||||
tells
|
||||
which way the triangle should be facing to be drawn.
|
||||
since you will more than likely require both
|
||||
combinations.
|
||||
|
||||
.IB bf " = 0"
|
||||
disables drawing when the points are arranged clockwise,
|
||||
.IB bf " = 1"
|
||||
disables drawing when the points are arranged counter clockwise.
|
||||
.IB bf " = -1"
|
||||
will probably always draw the triangle.
|
||||
|
||||
Beware, these functions are not a direct part of the svgalib library.
|
||||
Instead their source is part of svgalib and can be found in the
|
||||
.I threeDkit/
|
||||
subdirectory of the original svgalib distribution. However, it is not
|
||||
installed in the system by default, s.t. it is unclear where you can find it
|
||||
if your svgalib was installed by some
|
||||
linux distribution.
|
||||
|
||||
In case of any such problem, simply get an svgalib distribution from the net. Yo
|
||||
don't need to install it. Just
|
||||
.B make
|
||||
in the
|
||||
.I threeDkit/
|
||||
subdirectory. As of this writing,
|
||||
.I svgalib-1.2.12.tar.gz
|
||||
is the latest version and can be retrieved by ftp from
|
||||
.IR "sunsite.unc.edu" " at " "/pub/Linux/libs/graphics"
|
||||
and
|
||||
.IR "tsx-11.mit.edu" " at " "/pub/linux/sources/libs"
|
||||
which will most probably be mirrored by a site close to you.
|
||||
|
||||
The functions are defined in the
|
||||
.IR tri.o " and " triangl.o
|
||||
files (or their resp. sources) which you must link to your program.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR vgagl (7),
|
||||
.BR svgalib (7),
|
||||
.BR threedkit (7),
|
||||
.BR gl_swtriangle (3),
|
||||
.BR gl_triangle (3),
|
||||
.BR gl_trigetcolorlookup (3),
|
||||
.BR gl_trisetcolorlookup (3),
|
||||
.BR gl_trisetdrawpoint (3),
|
||||
.BR gl_wtriangle (3),
|
||||
.BR plane (6),
|
||||
.BR wrapdemo (6).
|
||||
|
||||
.SH AUTHOR
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
demos, the initial documentation and the whole threedkit stuff was done by
|
||||
Paul Sheer <psheer@icon.co.za>.
|
||||
|
||||
Paper mail:
|
||||
.RS
|
||||
Paul Sheer
|
||||
.br
|
||||
P O BOX 890507
|
||||
.br
|
||||
Lyndhurst
|
||||
.br
|
||||
Johannesburg 2106
|
||||
.br
|
||||
South Africa
|
||||
.RE
|
||||
|
||||
Donations (by check or postal order) will be appreciated and will encourage
|
||||
further development of this software. However this is strictly on a voluntary
|
||||
basis where this software falls under the GNU LIBRARY GENERAL PUBLIC LICENSE.
|
||||
116
doc/man3/gl_swtriangle.3
Normal file
116
doc/man3/gl_swtriangle.3
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
.TH gl_swtriangle 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_swtriangle \- draw a solid pixmap mapped on a triangle
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <triangle.h>
|
||||
|
||||
.B typedef struct {
|
||||
.br
|
||||
.BI " unsigned char *" bitmap1 ;
|
||||
.br
|
||||
.BI " unsigned char *" bitmap2 ;
|
||||
.br
|
||||
.BI " int " bf ;
|
||||
.br
|
||||
.BI "} " TD_tridata ;
|
||||
|
||||
.BI "void gl_swtriangle(int " x0 ", int " y0 ", int " xd0 ", int " yd0
|
||||
.BI ", int " x1 ", int " y1 ", int " xd1 ", int " yd1
|
||||
.BI ", int " x2 ", int " y2 ", int " xd2 ", int " yd2 ", int " c ", TD_tridata *" tri );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draws a triangle at points 0, 1, 2 by mapping the pixmaps defined
|
||||
in the
|
||||
.B TD_triangle
|
||||
structure into the triangle.
|
||||
|
||||
The
|
||||
.IR xd " and " yd
|
||||
values represent the triangle on the
|
||||
bitmap and the
|
||||
.IR x " and " y
|
||||
values represent the triangle
|
||||
on the screen.
|
||||
|
||||
.I bitmap1
|
||||
defines the back side of the triangle,
|
||||
.I bitmap2
|
||||
the front.
|
||||
|
||||
The
|
||||
.I bf
|
||||
value is used to tell the routine to draw the backside
|
||||
if it is facing the other way.
|
||||
.I bf
|
||||
tells
|
||||
which way the triangle should be facing to show the front,
|
||||
since you will more than likely require both
|
||||
combinations.
|
||||
|
||||
.IB bf " = 2"
|
||||
defines the back to be drawn when the points are arranged clockwise,
|
||||
.IB bf " = 3"
|
||||
defines the back to be drawn when the points are arranged counter clockwise,
|
||||
.IB bf " = -1"
|
||||
will probably always draw the front.
|
||||
|
||||
Beware, these functions are not a direct part of the svgalib library.
|
||||
Instead their source is part of svgalib and can be found in the
|
||||
.I threeDkit/
|
||||
subdirectory of the original svgalib distribution. However, it is not
|
||||
installed in the system by default, s.t. it is unclear where you can find it
|
||||
if your svgalib was installed by some
|
||||
linux distribution.
|
||||
|
||||
In case of any such problem, simply get an svgalib distribution from the net. Yo
|
||||
don't need to install it. Just
|
||||
.B make
|
||||
in the
|
||||
.I threeDkit/
|
||||
subdirectory. As of this writing,
|
||||
.I svgalib-1.2.12.tar.gz
|
||||
is the latest version and can be retrieved by ftp from
|
||||
.IR "sunsite.unc.edu" " at " "/pub/Linux/libs/graphics"
|
||||
and
|
||||
.IR "tsx-11.mit.edu" " at " "/pub/linux/sources/libs"
|
||||
which will most probably be mirrored by a site close to you.
|
||||
|
||||
The functions are defined in the
|
||||
.IR tri.o " and " triangl.o
|
||||
files (or their resp. sources) which you must link to your program.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR vgagl (7),
|
||||
.BR svgalib (7),
|
||||
.BR threedkit (7),
|
||||
.BR gl_striangle (3),
|
||||
.BR gl_wtriangle (3),
|
||||
.BR gl_triangle (3),
|
||||
.BR gl_trigetcolorlookup (3),
|
||||
.BR gl_trisetcolorlookup (3),
|
||||
.BR gl_trisetdrawpoint (3),
|
||||
.BR plane (6),
|
||||
.BR wrapdemo (6).
|
||||
|
||||
.SH AUTHOR
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
demos, the initial documentation and the whole threedkit stuff was done by
|
||||
Paul Sheer <psheer@icon.co.za>.
|
||||
|
||||
Paper mail:
|
||||
.RS
|
||||
Paul Sheer
|
||||
.br
|
||||
P O BOX 890507
|
||||
.br
|
||||
Lyndhurst
|
||||
.br
|
||||
Johannesburg 2106
|
||||
.br
|
||||
South Africa
|
||||
.RE
|
||||
|
||||
Donations (by check or postal order) will be appreciated and will encourage
|
||||
further development of this software. However this is strictly on a voluntary
|
||||
basis where this software falls under the GNU LIBRARY GENERAL PUBLIC LICENSE.
|
||||
105
doc/man3/gl_triangle.3
Normal file
105
doc/man3/gl_triangle.3
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
.TH gl_triangle 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_triangle \- draw a triangle with interpolated colors
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <triangle.h>
|
||||
|
||||
.BI "void gl_triangle(int " x0 ", int " y0 ", int " z0 ", int " x1 ", int " y1
|
||||
.BI ", int " z1 ", int " x2 ", int " y2 ", int " z2 ", int " bf );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draws a triangle between the three points 0, 1 and 2.
|
||||
|
||||
.IR z0 ", " z1 " and " z2
|
||||
are the colors at those points. Hence,
|
||||
if you set the palette to a grayscale, the triangle
|
||||
will have an interpolated gray shade.
|
||||
|
||||
If you are using
|
||||
more than 8 bit color, the
|
||||
.I z
|
||||
values will be
|
||||
interpreted as an index to a lookup table of at most
|
||||
4096 entries long. Each entry is of type
|
||||
.BR long .
|
||||
|
||||
You can set the entries with the function
|
||||
.BR gl_trisetcolorlookup (3).
|
||||
|
||||
The
|
||||
.I bf
|
||||
value is used to tell the routine not to draw
|
||||
the triangle if it is facing the other way.
|
||||
.I bf
|
||||
tells
|
||||
which way the triangle should be facing to be drawn.
|
||||
since you will more than likely require both
|
||||
combinations.
|
||||
|
||||
.IB bf " = 0"
|
||||
disables drawing when the points are arranged clockwise,
|
||||
.IB bf " = 1"
|
||||
disables drawing when the points are arranged counter clockwise.
|
||||
.IB bf " = -1"
|
||||
will probably always draw the triangle.
|
||||
|
||||
Beware, these functions are not a direct part of the svgalib library.
|
||||
Instead their source is part of svgalib and can be found in the
|
||||
.I threeDkit/
|
||||
subdirectory of the original svgalib distribution. However, it is not
|
||||
installed in the system by default, s.t. it is unclear where you can find it
|
||||
if your svgalib was installed by some
|
||||
linux distribution.
|
||||
|
||||
In case of any such problem, simply get an svgalib distribution from the net. Yo
|
||||
don't need to install it. Just
|
||||
.B make
|
||||
in the
|
||||
.I threeDkit/
|
||||
subdirectory. As of this writing,
|
||||
.I svgalib-1.2.12.tar.gz
|
||||
is the latest version and can be retrieved by ftp from
|
||||
.IR "sunsite.unc.edu" " at " "/pub/Linux/libs/graphics"
|
||||
and
|
||||
.IR "tsx-11.mit.edu" " at " "/pub/linux/sources/libs"
|
||||
which will most probably be mirrored by a site close to you.
|
||||
|
||||
The functions are defined in the
|
||||
.IR tri.o " and " triangl.o
|
||||
files (or their resp. sources) which you must link to your program.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR vgagl (7),
|
||||
.BR svgalib (7),
|
||||
.BR threedkit (7),
|
||||
.BR gl_striangle (3),
|
||||
.BR gl_swtriangle (3),
|
||||
.BR gl_trigetcolorlookup (3),
|
||||
.BR gl_trisetcolorlookup (3),
|
||||
.BR gl_trisetdrawpoint (3),
|
||||
.BR gl_wtriangle (3),
|
||||
.BR plane (6),
|
||||
.BR wrapdemo (6).
|
||||
|
||||
.SH AUTHOR
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
demos, the initial documentation and the whole threedkit stuff was done by
|
||||
Paul Sheer <psheer@icon.co.za>.
|
||||
|
||||
Paper mail:
|
||||
.RS
|
||||
Paul Sheer
|
||||
.br
|
||||
P O BOX 890507
|
||||
.br
|
||||
Lyndhurst
|
||||
.br
|
||||
Johannesburg 2106
|
||||
.br
|
||||
South Africa
|
||||
.RE
|
||||
|
||||
Donations (by check or postal order) will be appreciated and will encourage
|
||||
further development of this software. However this is strictly on a voluntary
|
||||
basis where this software falls under the GNU LIBRARY GENERAL PUBLIC LICENSE.
|
||||
1
doc/man3/gl_trigetcolorlookup.3
Normal file
1
doc/man3/gl_trigetcolorlookup.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_trisetcolorlookup.3
|
||||
85
doc/man3/gl_trisetcolorlookup.3
Normal file
85
doc/man3/gl_trisetcolorlookup.3
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
.TH gl_trisetcolorlookup 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_trisetcolorlookup, gl_trigetcolorlookup \- manages a color lookup table for shadowing
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <triangle.h>
|
||||
|
||||
.BI "void gl_trisetcolorlookup(int " i ", long " color );
|
||||
.br
|
||||
.BI "long gl_trigetcolorlookup(int " i );
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B gl_trisetcolorlookup
|
||||
sets the color of an index
|
||||
.I i
|
||||
in the table used in more than 256 color modes to interpolate tables.
|
||||
|
||||
Note that it is your responsibility to set all the intermediate color values.
|
||||
|
||||
You can use this function to create the index table,
|
||||
but remember not to let
|
||||
.I i
|
||||
go over 4096.
|
||||
|
||||
.B gl_trigetcolorlookup
|
||||
retrieves a previously set value from the table.
|
||||
|
||||
Beware, these functions are not a direct part of the svgalib library.
|
||||
Instead their source is part of svgalib and can be found in the
|
||||
.I threeDkit/
|
||||
subdirectory of the original svgalib distribution. However, it is not
|
||||
installed in the system by default, s.t. it is unclear where you can find it
|
||||
if your svgalib was installed by some
|
||||
linux distribution.
|
||||
|
||||
In case of any such problem, simply get an svgalib distribution from the net. Yo
|
||||
don't need to install it. Just
|
||||
.B make
|
||||
in the
|
||||
.I threeDkit/
|
||||
subdirectory. As of this writing,
|
||||
.I svgalib-1.2.12.tar.gz
|
||||
is the latest version and can be retrieved by ftp from
|
||||
.IR "sunsite.unc.edu" " at " "/pub/Linux/libs/graphics"
|
||||
and
|
||||
.IR "tsx-11.mit.edu" " at " "/pub/linux/sources/libs"
|
||||
which will most probably be mirrored by a site close to you.
|
||||
|
||||
The functions are defined in the
|
||||
.IR tri.o " and " triangl.o
|
||||
files (or their resp. sources) which you must link to your program.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR vgagl (7),
|
||||
.BR svgalib (7),
|
||||
.BR threedkit (7),
|
||||
.BR gl_striangle (3),
|
||||
.BR gl_swtriangle (3),
|
||||
.BR gl_triangle (3),
|
||||
.BR gl_trisetdrawpoint (3),
|
||||
.BR gl_wtriangle (3),
|
||||
.BR plane (6),
|
||||
.BR wrapdemo (6).
|
||||
|
||||
.SH AUTHOR
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
demos, the initial documentation and the whole threedkit stuff was done by
|
||||
Paul Sheer <psheer@icon.co.za>.
|
||||
|
||||
Paper mail:
|
||||
.RS
|
||||
Paul Sheer
|
||||
.br
|
||||
P O BOX 890507
|
||||
.br
|
||||
Lyndhurst
|
||||
.br
|
||||
Johannesburg 2106
|
||||
.br
|
||||
South Africa
|
||||
.RE
|
||||
|
||||
Donations (by check or postal order) will be appreciated and will encourage
|
||||
further development of this software. However this is strictly on a voluntary
|
||||
basis where this software falls under the GNU LIBRARY GENERAL PUBLIC LICENSE.
|
||||
87
doc/man3/gl_trisetdrawpoint.3
Normal file
87
doc/man3/gl_trisetdrawpoint.3
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
.TH gl_trisetdrawpoint 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_trisetdrawpoint \- set a triangle drawing function
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <triangle.h>
|
||||
|
||||
.BI "void gl_trisetdrawpoint(void (" setpixelfunc ") (int " x ", int " y ", int " color ") );
|
||||
|
||||
.SH DESCRIPTION
|
||||
If this function is called with
|
||||
.I setpixelfunc
|
||||
non-zero, then the function
|
||||
.I setpixelfunc
|
||||
is used from
|
||||
there after to draw each pixel (instead of the usual
|
||||
direct screen buffer writes).
|
||||
|
||||
This function need never
|
||||
be used, except if you want to use your own pixel
|
||||
drawing function for extra effects. If you use
|
||||
this feature, you can be assured that none of the
|
||||
triangle routines will access the hardware,
|
||||
enabling portability to other environments.
|
||||
|
||||
Beware, these functions are not a direct part of the svgalib library.
|
||||
Instead their source is part of svgalib and can be found in the
|
||||
.I threeDkit/
|
||||
subdirectory of the original svgalib distribution. However, it is not
|
||||
installed in the system by default, s.t. it is unclear where you can find it
|
||||
if your svgalib was installed by some
|
||||
linux distribution.
|
||||
|
||||
In case of any such problem, simply get an svgalib distribution from the net. Yo
|
||||
don't need to install it. Just
|
||||
.B make
|
||||
in the
|
||||
.I threeDkit/
|
||||
subdirectory. As of this writing,
|
||||
.I svgalib-1.2.12.tar.gz
|
||||
is the latest version and can be retrieved by ftp from
|
||||
.IR "sunsite.unc.edu" " at " "/pub/Linux/libs/graphics"
|
||||
and
|
||||
.IR "tsx-11.mit.edu" " at " "/pub/linux/sources/libs"
|
||||
which will most probably be mirrored by a site close to you.
|
||||
|
||||
The functions are defined in the
|
||||
.IR tri.o " and " triangl.o
|
||||
|
||||
The functions are defined in the
|
||||
.IR tri.o " and " triangl.o
|
||||
files (or their resp. sources) which you must link to your program.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR vgagl (7),
|
||||
.BR svgalib (7),
|
||||
.BR threedkit (7),
|
||||
.BR gl_striangle (3),
|
||||
.BR gl_swtriangle (3),
|
||||
.BR gl_triangle (3),
|
||||
.BR gl_trigetcolorlookup (3),
|
||||
.BR gl_trisetcolorlookup (3),
|
||||
.BR gl_wtriangle (3),
|
||||
.BR plane (6),
|
||||
.BR wrapdemo (6).
|
||||
|
||||
.SH AUTHOR
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
demos, the initial documentation and the whole threedkit stuff was done by
|
||||
Paul Sheer <psheer@icon.co.za>.
|
||||
|
||||
Paper mail:
|
||||
.RS
|
||||
Paul Sheer
|
||||
.br
|
||||
P O BOX 890507
|
||||
.br
|
||||
Lyndhurst
|
||||
.br
|
||||
Johannesburg 2106
|
||||
.br
|
||||
South Africa
|
||||
.RE
|
||||
|
||||
Donations (by check or postal order) will be appreciated and will encourage
|
||||
further development of this software. However this is strictly on a voluntary
|
||||
basis where this software falls under the GNU LIBRARY GENERAL PUBLIC LICENSE.
|
||||
67
doc/man3/gl_write.3
Normal file
67
doc/man3/gl_write.3
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
.TH gl_write 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_write, gl_writen \- write a text string
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <vgagl.h>
|
||||
|
||||
.BI "void gl_write(int " x ", int " y ", char *" s );
|
||||
.br
|
||||
.BI "void gl_writen(int " x ", int " y ", int " n " ,char *" s );
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B gl_write
|
||||
writes the zero terminated string
|
||||
.I s
|
||||
to position
|
||||
.RI ( x ", " y )
|
||||
using the currently selected font.
|
||||
|
||||
.B gl_writen
|
||||
works similarly, but writes exactly
|
||||
.I n
|
||||
characters, thus allowing to use the character 0.
|
||||
|
||||
The kind of text draw operation is set with
|
||||
.BR gl_setwritemode (3).
|
||||
|
||||
.B BEWARE!
|
||||
Prior to the of use of
|
||||
.BR gl_write "(3) and " gl_writen (3)
|
||||
you must set a font.
|
||||
|
||||
A good default initialization sequence is:
|
||||
|
||||
.B gl_setfont(8, 8, gl_font8x8);
|
||||
.br
|
||||
.B gl_setwritemode(FONT_COMPRESSED + WRITEMODE_OVERWRITE);
|
||||
.br
|
||||
.B gl_setfontcolors(0, vga_white());
|
||||
.br
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR svgalib.conf (5),
|
||||
.BR threedkit (7),
|
||||
.BR testgl (1),
|
||||
.BR gl_printf (3),
|
||||
.BR gl_colorfont (3),
|
||||
.BR gl_expandfont (3),
|
||||
.BR gl_font8x8 (3),
|
||||
.BR gl_setfont (3),
|
||||
.BR gl_setfontcolors (3),
|
||||
.BR gl_setwritemode (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.
|
||||
1
doc/man3/gl_writen.3
Normal file
1
doc/man3/gl_writen.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/gl_write.3
|
||||
131
doc/man3/gl_wtriangle.3
Normal file
131
doc/man3/gl_wtriangle.3
Normal file
|
|
@ -0,0 +1,131 @@
|
|||
.TH gl_wtriangle 3 "2 Aug 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
gl_wtriangle \- draw a shadowed pixmap mapped on a triangle
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B #include <triangle.h>
|
||||
|
||||
.B typedef struct {
|
||||
.br
|
||||
.BI " unsigned char *" bitmap1 ;
|
||||
.br
|
||||
.BI " unsigned char *" bitmap2 ;
|
||||
.br
|
||||
.BI " int " bf ;
|
||||
.br
|
||||
.BI "} " TD_tridata ;
|
||||
|
||||
.BI "void gl_wtriangle(int " x0 ", int " y0 ", int " xd0 ", int " yd0 ", int " z0
|
||||
.BI ", int " x1 ", int " y1 ", int " xd1 ", int " yd1 ", int " z1
|
||||
.BI ", int " x2 ", int " y2 ", int " xd2 ", int " yd2 ", int " z2 ", TD_tridata *" tri );
|
||||
|
||||
.SH DESCRIPTION
|
||||
Draws a triangle at points 0, 1, 2 by mapping the pixmaps defined
|
||||
in the
|
||||
.B TD_triangle
|
||||
structure into the triangle.
|
||||
|
||||
The
|
||||
.IR xd " and " yd
|
||||
values represent the triangle on the
|
||||
bitmap and the
|
||||
.IR x " and " y
|
||||
values represent the triangle
|
||||
on the screen. The
|
||||
.I z
|
||||
values represent an additional
|
||||
value which will be added to the color that is looked
|
||||
up from the pixmap data. Once again, if the
|
||||
current context is more than 8 bits then the result
|
||||
is interpreted as an index to the same lookup table. See
|
||||
.BR gl_triangle (3)
|
||||
for more details on shadowing.
|
||||
|
||||
.B gl_wtriangle
|
||||
is used to draw wrapped surfaces
|
||||
.B with
|
||||
shadowing interpolation. The function
|
||||
.BR gl_swtriangle (3)
|
||||
does it without shadowing.
|
||||
|
||||
.I bitmap1
|
||||
defines the back side of the triangle,
|
||||
.I bitmap2
|
||||
the front.
|
||||
|
||||
The
|
||||
.I bf
|
||||
value is used to tell the routine to draw the backside
|
||||
if it is facing the other way.
|
||||
.I bf
|
||||
tells
|
||||
which way the triangle should be facing to show the front,
|
||||
since you will more than likely require both
|
||||
combinations.
|
||||
|
||||
.IB bf " = 2"
|
||||
defines the back to be drawn when the points are arranged clockwise,
|
||||
.IB bf " = 3"
|
||||
defines the back to be drawn when the points are arranged counter clockwise,
|
||||
.IB bf " = -1"
|
||||
will probably always draw the front.
|
||||
|
||||
Beware, these functions are not a direct part of the svgalib library.
|
||||
Instead their source is part of svgalib and can be found in the
|
||||
.I threeDkit/
|
||||
subdirectory of the original svgalib distribution. However, it is not
|
||||
installed in the system by default, s.t. it is unclear where you can find it
|
||||
if your svgalib was installed by some
|
||||
linux distribution.
|
||||
|
||||
In case of any such problem, simply get an svgalib distribution from the net. Yo
|
||||
don't need to install it. Just
|
||||
.B make
|
||||
in the
|
||||
.I threeDkit/
|
||||
subdirectory. As of this writing,
|
||||
.I svgalib-1.2.12.tar.gz
|
||||
is the latest version and can be retrieved by ftp from
|
||||
.IR "sunsite.unc.edu" " at " "/pub/Linux/libs/graphics"
|
||||
and
|
||||
.IR "tsx-11.mit.edu" " at " "/pub/linux/sources/libs"
|
||||
which will most probably be mirrored by a site close to you.
|
||||
|
||||
The functions are defined in the
|
||||
.IR tri.o " and " triangl.o
|
||||
files (or their resp. sources) which you must link to your program.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR vgagl (7),
|
||||
.BR svgalib (7),
|
||||
.BR threedkit (7),
|
||||
.BR gl_striangle (3),
|
||||
.BR gl_swtriangle (3),
|
||||
.BR gl_triangle (3),
|
||||
.BR gl_trigetcolorlookup (3),
|
||||
.BR gl_trisetcolorlookup (3),
|
||||
.BR gl_trisetdrawpoint (3),
|
||||
.BR plane (6),
|
||||
.BR wrapdemo (6).
|
||||
|
||||
.SH AUTHOR
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
demos, the initial documentation and the whole threedkit stuff was done by
|
||||
Paul Sheer <psheer@icon.co.za>.
|
||||
|
||||
Paper mail:
|
||||
.RS
|
||||
Paul Sheer
|
||||
.br
|
||||
P O BOX 890507
|
||||
.br
|
||||
Lyndhurst
|
||||
.br
|
||||
Johannesburg 2106
|
||||
.br
|
||||
South Africa
|
||||
.RE
|
||||
|
||||
Donations (by check or postal order) will be appreciated and will encourage
|
||||
further development of this software. However this is strictly on a voluntary
|
||||
basis where this software falls under the GNU LIBRARY GENERAL PUBLIC LICENSE.
|
||||
1
doc/man3/graph_mem.3
Normal file
1
doc/man3/graph_mem.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/vga_getgraphmem.3
|
||||
1
doc/man3/joystick_button1.3
Normal file
1
doc/man3/joystick_button1.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_button2.3
Normal file
1
doc/man3/joystick_button2.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_button3.3
Normal file
1
doc/man3/joystick_button3.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_button4.3
Normal file
1
doc/man3/joystick_button4.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
49
doc/man3/joystick_close.3
Normal file
49
doc/man3/joystick_close.3
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
.TH joystick_close 3 "14 April 1998" "Svgalib 1.3.0" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
joystick_close \- close a joystick
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgajoystick.h>"
|
||||
|
||||
.BI "void joystick_close(int " joydev );
|
||||
|
||||
.SH DESCRIPTION
|
||||
closes the joystick
|
||||
.I joydev
|
||||
which was opened with
|
||||
.BR joystick_init (3).
|
||||
|
||||
.IB joydev " = -1"
|
||||
closes all currently open joystick devices. Note that any calibration data is lost if you
|
||||
close a joystick.
|
||||
|
||||
.SH CAVEATS
|
||||
This function is only available in ELF versions of svgalib. Due to backwards
|
||||
compatibility issues it cannot be used with shared a.out libs.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR joytest (6),
|
||||
.BR mjoytest (6),
|
||||
.BR joystick_init (3),
|
||||
.BR joystick_update (3),
|
||||
.BR joystick_sethandler (3),
|
||||
.BR joystick_setdefaulthandler (3),
|
||||
.BR joystick_getnumaxes (3),
|
||||
.BR joystick_getnumbuttons (3),
|
||||
.BR joystick_getaxis (3),
|
||||
.BR joystick_getbutton (3),
|
||||
.BR joystick_button1 (3),
|
||||
.BR joystick_getb1 (3),
|
||||
.BR joystick_x (3),
|
||||
.BR joystick_getx (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
The svgalib joystick handler was mostly done by Daniel Engstr\\"om <daniel.engstrom@riksnett.no>.
|
||||
Multiple joystick, VC switching support and code to glue it into svgalib by Michael Weller
|
||||
<eowmob@exp-math.uni-essen.de>. Part of the code is based on code from C. Smith and
|
||||
Vojtech Pavlik.
|
||||
139
doc/man3/joystick_getaxis.3
Normal file
139
doc/man3/joystick_getaxis.3
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
.TH joystick_getaxis 3 "14 April 1998" "Svgalib 1.3.0" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
joystick_getaxis, joystick_getbutton \- query the current state of a joystick.
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgajoystick.h>"
|
||||
|
||||
.BI "char joystick_getaxis(int " joydev ", int " a );
|
||||
.br
|
||||
.BI "char joystick_getbutton(int " joydev ", int " b );
|
||||
|
||||
.SH DESCRIPTION
|
||||
These functions query the current state of the joystick
|
||||
.IR joydev .
|
||||
Actually this is the state found during the last call
|
||||
to
|
||||
.BR joystick_update (3)
|
||||
with the default joystick event handler active.
|
||||
|
||||
.BI "joystick_getaxis(" joydev ", " a )
|
||||
return the current state of the given axis (usually it is
|
||||
.BR "x - 0" ", " "y - 1" ", " "z - 1" ", ...)"
|
||||
in range
|
||||
.BR "-128 .. 127" .
|
||||
Some effort is made such that the center position is close to
|
||||
.BR 0 .
|
||||
|
||||
Note that especially the version 0.* protocol joystick calibration is very bad. You won't usually
|
||||
see the extrem values on the extreme position. Also, the center position will be close to zero but
|
||||
often not be exactly zero and return values will also vary slightly from call to call even when
|
||||
the user did not move the joystick.
|
||||
|
||||
.BI "joystick_getbutton(" joydev ", " b )
|
||||
returns the state of a button. It returns 1 for pressed button and 0 else. Note that no hardware
|
||||
checks for button clicks. The button press is only detected during a call to
|
||||
.BR joystick_update (3)
|
||||
(at least in the 0.* protocol).
|
||||
|
||||
.B NOTE:
|
||||
The functions simply return the data passed to the default joystick event handler!
|
||||
|
||||
For your convenience, the following stortcuts have been established by use of the preprocessor:
|
||||
|
||||
.RS
|
||||
.BI joystick_button1( i )
|
||||
for
|
||||
.BI joystick_getbutton( i ,
|
||||
.BR 0) .
|
||||
.br
|
||||
.BI joystick_button2( i )
|
||||
for
|
||||
.BI joystick_getbutton( i ,
|
||||
.BR 1) .
|
||||
.br
|
||||
.BI joystick_button3( i )
|
||||
for
|
||||
.BI joystick_getbutton( i ,
|
||||
.BR 2) .
|
||||
.br
|
||||
.BI joystick_button4( i )
|
||||
for
|
||||
.BI joystick_getbutton( i ,
|
||||
.BR 3) .
|
||||
.RE
|
||||
|
||||
.RS
|
||||
.BI joystick_x( i )
|
||||
for
|
||||
.BI joystick_getaxis( i ,
|
||||
.BR 0) .
|
||||
.br
|
||||
.BI joystick_y( i )
|
||||
for
|
||||
.BI joystick_getaxis( i ,
|
||||
.BR 1) .
|
||||
.br
|
||||
.BI joystick_z( i )
|
||||
for
|
||||
.BI joystick_getaxis( i ,
|
||||
.BR 2) .
|
||||
.RE
|
||||
|
||||
.RS
|
||||
.B joystick_getb1()
|
||||
for
|
||||
.BR "joystick_getbutton(0, 0)" .
|
||||
.br
|
||||
.B joystick_getb2()
|
||||
for
|
||||
.BR "joystick_getbutton(0, 1)" .
|
||||
.br
|
||||
.B joystick_getb3()
|
||||
for
|
||||
.BR "joystick_getbutton(0, 2)" .
|
||||
.br
|
||||
.B joystick_getb4()
|
||||
for
|
||||
.BR "joystick_getbutton(0, 3)" .
|
||||
.RE
|
||||
|
||||
.RS
|
||||
.B joystick_getx()
|
||||
for
|
||||
.BR "joystick_getaxis(0, 0)" .
|
||||
.br
|
||||
.B joystick_gety()
|
||||
for
|
||||
.BR "joystick_getaxis(0, 1)" .
|
||||
.br
|
||||
.B joystick_getz()
|
||||
for
|
||||
.BR "joystick_getaxis(0, 2)" .
|
||||
.RE
|
||||
|
||||
.SH CAVEATS
|
||||
This function is only available in ELF versions of svgalib. Due to backwards
|
||||
compatibility issues it cannot be used with shared a.out libs.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR joytest (6),
|
||||
.BR mjoytest (6),
|
||||
.BR joystick_init (3),
|
||||
.BR joystick_close (3),
|
||||
.BR joystick_update (3),
|
||||
.BR joystick_sethandler (3),
|
||||
.BR joystick_setdefaulthandler (3),
|
||||
.BR joystick_getnumaxes (3),
|
||||
.BR joystick_getnumbuttons (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
The svgalib joystick handler was mostly done by Daniel Engstr\\"om <daniel.engstrom@riksnett.no>.
|
||||
Multiple joystick, VC switching support and code to glue it into svgalib by Michael Weller
|
||||
<eowmob@exp-math.uni-essen.de>. Part of the code is based on code from C. Smith and
|
||||
Vojtech Pavlik.
|
||||
1
doc/man3/joystick_getb1.3
Normal file
1
doc/man3/joystick_getb1.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_getb2.3
Normal file
1
doc/man3/joystick_getb2.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_getb3.3
Normal file
1
doc/man3/joystick_getb3.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_getb4.3
Normal file
1
doc/man3/joystick_getb4.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_getbutton.3
Normal file
1
doc/man3/joystick_getbutton.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
47
doc/man3/joystick_getnumaxes.3
Normal file
47
doc/man3/joystick_getnumaxes.3
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
.TH joystick_getnumaxes 3 "14 April 1998" "Svgalib 1.3.0" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
joystick_getnumaxes, joystick_getnumbuttons \- query the capabilities of a joystick
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgajoystick.h>"
|
||||
|
||||
.BI "char joystick_getnumaxes(int " joydev );
|
||||
.br
|
||||
.BI "char joystick_getnumbuttons(int " joydev );
|
||||
|
||||
.SH DESCRIPTION
|
||||
queries the number of axes (number of continuous ranges which the joystick allows to choose
|
||||
from) and buttons. The old version 0.* joystick protocol reports 2 axes (x and y) and 4 buttons
|
||||
although the actual joystick will usually have less (often two) buttons.
|
||||
|
||||
svgalib supports up to 127 axes and buttons, provided the underlying device driver does it.
|
||||
|
||||
.SH CAVEATS
|
||||
This function is only available in ELF versions of svgalib. Due to backwards
|
||||
compatibility issues it cannot be used with shared a.out libs.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR joytest (6),
|
||||
.BR mjoytest (6),
|
||||
.BR joystick_init (3),
|
||||
.BR joystick_close (3),
|
||||
.BR joystick_update (3),
|
||||
.BR joystick_sethandler (3),
|
||||
.BR joystick_setdefaulthandler (3),
|
||||
.BR joystick_getaxis (3),
|
||||
.BR joystick_getbutton (3),
|
||||
.BR joystick_button1 (3),
|
||||
.BR joystick_getb1 (3),
|
||||
.BR joystick_x (3),
|
||||
.BR joystick_getx (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
The svgalib joystick handler was mostly done by Daniel Engstr\\"om <daniel.engstrom@riksnett.no>.
|
||||
Multiple joystick, VC switching support and code to glue it into svgalib by Michael Weller
|
||||
<eowmob@exp-math.uni-essen.de>. Part of the code is based on code from C. Smith and
|
||||
Vojtech Pavlik.
|
||||
1
doc/man3/joystick_getnumbuttons.3
Normal file
1
doc/man3/joystick_getnumbuttons.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getnumaxes.3
|
||||
1
doc/man3/joystick_getx.3
Normal file
1
doc/man3/joystick_getx.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_gety.3
Normal file
1
doc/man3/joystick_gety.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_getz.3
Normal file
1
doc/man3/joystick_getz.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
152
doc/man3/joystick_init.3
Normal file
152
doc/man3/joystick_init.3
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
.TH joystick_init 3 "14 April 1998" "Svgalib 1.3.0" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
joystick_init \- open a joystick
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgajoystick.h>"
|
||||
.br
|
||||
.BI "typedef void (*" __joystick_output ") (const char *" msg );
|
||||
|
||||
.BI "int joystick_init(int " joydev ", __joystick_output " jo );
|
||||
|
||||
.SH DESCRIPTION
|
||||
This function opens a joystick device. A negative value is returned on failure,
|
||||
otherwise the joystick was initialized.
|
||||
.BR svgalib (7)
|
||||
supports several joysticks. The corresponding device node names can be configured in
|
||||
.BR libvga.config (5).
|
||||
|
||||
The
|
||||
.I joydev
|
||||
parameter indicates which joystick is to be initialized. As of this writing svgalib
|
||||
support up to four joysticks
|
||||
.IB joydev " = 0"
|
||||
to
|
||||
.I joydev
|
||||
.BR "= 3" ,
|
||||
although I'm not aware of hardware and kernel drivers which handle more than joysticks
|
||||
.BR 0 " and " 1 .
|
||||
|
||||
It is strongly encouraged that your program allows the user to calibrate the joystick. This is
|
||||
controlled by the
|
||||
.I jo
|
||||
parameter. If it is
|
||||
.BR NULL ,
|
||||
no calibration is performed. Otherwise, calibration is performed and instructions are printed
|
||||
to the user by calling the user supplied
|
||||
.I jo
|
||||
function. It is the responsibility of this function to print the
|
||||
.B NUL
|
||||
and
|
||||
.B NL
|
||||
terminated message pointed to by
|
||||
.I msg
|
||||
to the user. The message might contain embedded
|
||||
.B NL
|
||||
characters and will not extend 256 characters including the terminating
|
||||
.BR NUL .
|
||||
|
||||
Usually an
|
||||
.BI fputs( msg ", stdout);"
|
||||
followed by
|
||||
.B fflush(stdout);
|
||||
will do, but for your convenience you can perform the same by passing
|
||||
.B JOY_CALIB_STDOUT
|
||||
for
|
||||
.IR jo .
|
||||
.BR gl_printf (3)
|
||||
is well suited for this job as well. However, it needs some font setup first, so we do not
|
||||
provide a special
|
||||
preprocessor constant.
|
||||
|
||||
It is valid to initialize an already initialized joystick. This allows you to recalibrate the
|
||||
joystick at any time. The module supports older version 0.* as well as newer version 1.* joystick
|
||||
device protocols.
|
||||
|
||||
.SH GENERAL CONCEPT
|
||||
The joystick module is basically independent from the rest of svgalib. You can easily use it
|
||||
in text mode only (but why would you do that?). If used in a graphics mode, however, it will release
|
||||
the joystick devices upon a VC switch s.t. several applications can share joysticks. Unfortunately
|
||||
this does not work during joystick calibration. Therefore, you should lock the VC with
|
||||
.BR vga_lockvc (3)
|
||||
while calibrating in graphics mode.
|
||||
|
||||
Also, when using joysticks in textmode only, svgalib won't detect VC switches and joysticks cannot
|
||||
be shared among applications.
|
||||
|
||||
.BR joystick_close (3)
|
||||
releases opened joysticks.
|
||||
|
||||
.BR joystick_update (3)
|
||||
queries the joysticks for position changes. Note that you must busy wait for joystick events.
|
||||
At least the older version 0.* joystick devices do not allow to sleep and get informed about
|
||||
new joystick events. Basically, this is a PC hardware issue in the first place. Therefore,
|
||||
.BR vga_waitevent (3)
|
||||
does not know about joysticks. To use it, you must make it timeout after a few ms and actively
|
||||
query the joystick for updates.
|
||||
|
||||
By default a handler deals with the joystick events.
|
||||
.BR joystick_getaxis "(3) and " joystick_getbutton (3)
|
||||
plus several convenience macros
|
||||
.BR joystick_button1|2|3|4 ", " joystick_getb1|2|3|4 ", " joystick_x|y|z ", and "
|
||||
.B joystick_getx|y|z
|
||||
allow to query the current status of the joystick (as it was
|
||||
determined during the last
|
||||
.B joystick_update()
|
||||
call).
|
||||
|
||||
The functions
|
||||
.BR joystick_getnumaxes "(3) and " joystick_getnumbuttons (3)
|
||||
query the number of axes and buttons of a joystick.
|
||||
|
||||
Finally, you can (un)register an own handler for the joystick events with
|
||||
.BR joystick_sethandler "(3) and " joystick_setdefaulthandler (3)
|
||||
|
||||
The simple text demo
|
||||
.BR joytest (6)
|
||||
and the more complex graphical
|
||||
.BR mjoytest (6)
|
||||
demo show the use of the joystick package in some more detail.
|
||||
|
||||
.SH CAVEATS
|
||||
This function is only available in ELF versions of svgalib. Due to backwards
|
||||
compatibility issues it cannot be used with shared a.out libs.
|
||||
|
||||
Certain game ports seem to be unable to detect missing joysticks properly.
|
||||
(This might also be a linux device driver issue). Anyway, is using the
|
||||
joystick interface, allow a user of your application to specify the number
|
||||
of joysticks to be used as well as to bail out the joystick calibration
|
||||
(when he is not able to press a button on a missing joystick).
|
||||
|
||||
Usually <Ctrl>-C works, but you should not rely too much on it, as it can
|
||||
be disabled. As a general guideline, maybe try to open and calibrate
|
||||
joysticks while still in
|
||||
textmode. <Ctrl>-C will usually still work then. If this succeeds, you may
|
||||
assume a joystick is there for any following recalibrations in graphics mode.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR joytest (6),
|
||||
.BR mjoytest (6),
|
||||
.BR joystick_close (3),
|
||||
.BR joystick_update (3),
|
||||
.BR joystick_sethandler (3),
|
||||
.BR joystick_setdefaulthandler (3),
|
||||
.BR joystick_getnumaxes (3),
|
||||
.BR joystick_getnumbuttons (3),
|
||||
.BR joystick_getaxis (3),
|
||||
.BR joystick_getbutton (3),
|
||||
.BR joystick_button1 (3),
|
||||
.BR joystick_getb1 (3),
|
||||
.BR joystick_x (3),
|
||||
.BR joystick_getx (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
The svgalib joystick handler was mostly done by Daniel Engstr\\"om <daniel.engstrom@riksnett.no>.
|
||||
Multiple joystick, VC switching support and code to glue it into svgalib by Michael Weller
|
||||
<eowmob@exp-math.uni-essen.de>. Part of the code is based on code from C. Smith and
|
||||
Vojtech Pavlik.
|
||||
1
doc/man3/joystick_setdefaulthandler.3
Normal file
1
doc/man3/joystick_setdefaulthandler.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_sethandler.3
|
||||
97
doc/man3/joystick_sethandler.3
Normal file
97
doc/man3/joystick_sethandler.3
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
.TH joystick_sethandler 3 "14 April 1998" "Svgalib 1.3.0" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
joystick_sethandler, joystick_setdefaulthandler \- set the joystick event handler.
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgajoystick.h>"
|
||||
.br
|
||||
.BI "typedef void (*" __joystick_handler ") (int " event ", int " number ", char"
|
||||
.IB value ", int " joydev );
|
||||
|
||||
.BI "void joystick_sethandler(int " joydev ", __joystick_handler " jh );
|
||||
.br
|
||||
.BI "void joystick_setdefaulthandler(int " joydev );
|
||||
|
||||
.SH DESCRIPTION
|
||||
By default, each call to
|
||||
.BR joystick_init (3)
|
||||
enables the default handler for the opened joystick. This handler maintains a state table
|
||||
which can be read by the
|
||||
.BR joystick_getaxis (3),
|
||||
.BR joystick_getbutton (3),
|
||||
.BR joystick_button1|2|3|4 (3),
|
||||
.BR joystick_getb1|2|3|4 (3),
|
||||
.BR joystick_x|y|z "(3) and "
|
||||
.BR joystick_getx|y|z (3)
|
||||
functions.
|
||||
|
||||
If you define an own handler, the following parameters are passed:
|
||||
|
||||
.RS
|
||||
.HP
|
||||
.I event
|
||||
one of the following values:
|
||||
.RS
|
||||
.HP
|
||||
.B JOY_EVENTBUTTONDOWN
|
||||
a button was pressed.
|
||||
.HP
|
||||
.B JOY_EVENTBUTTONUP
|
||||
a button was released.
|
||||
.HP
|
||||
.B JOY_EVENTAXIS
|
||||
the joystick position was changed.
|
||||
.RE
|
||||
|
||||
.IP
|
||||
All other values are reserved for future use.
|
||||
|
||||
.HP
|
||||
.I number
|
||||
identifies the button or axis to which this event belongs.
|
||||
|
||||
.HP
|
||||
.I value
|
||||
for axis events the new position in range
|
||||
.BR "-128 .. 127" . See
|
||||
.BR joystick_getaxis (3)
|
||||
for further comments on the range.
|
||||
|
||||
.HP
|
||||
.I joydev
|
||||
identifies the joystick affected (this allows to use one handler for many joysticks).
|
||||
.RE
|
||||
|
||||
.IB joydev " = -1"
|
||||
modifies the event handler of
|
||||
all currently open joystick devices.
|
||||
|
||||
.SH CAVEATS
|
||||
This function is only available in ELF versions of svgalib. Due to backwards
|
||||
compatibility issues it cannot be used with shared a.out libs.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR joytest (6),
|
||||
.BR mjoytest (6),
|
||||
.BR joystick_init (3),
|
||||
.BR joystick_close (3),
|
||||
.BR joystick_update (3),
|
||||
.BR joystick_getnumaxes (3),
|
||||
.BR joystick_getnumbuttons (3),
|
||||
.BR joystick_getaxis (3),
|
||||
.BR joystick_getbutton (3),
|
||||
.BR joystick_button1 (3),
|
||||
.BR joystick_getb1 (3),
|
||||
.BR joystick_x (3),
|
||||
.BR joystick_getx (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
The svgalib joystick handler was mostly done by Daniel Engstr\\"om <daniel.engstrom@riksnett.no>.
|
||||
Multiple joystick, VC switching support and code to glue it into svgalib by Michael Weller
|
||||
<eowmob@exp-math.uni-essen.de>. Part of the code is based on code from C. Smith and
|
||||
Vojtech Pavlik.
|
||||
48
doc/man3/joystick_update.3
Normal file
48
doc/man3/joystick_update.3
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
.TH joystick_update 3 "14 April 1998" "Svgalib 1.3.0" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
joystick_update \- query joysticks for status changes
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgajoystick.h>"
|
||||
|
||||
.BI "int joystick_update(void);
|
||||
|
||||
.SH DESCRIPTION
|
||||
queries all currently opened joysticks for position changes and calls the appropriate
|
||||
event handlers.
|
||||
|
||||
A non-zero value is returned if and only if any joystick reported a position change. In more
|
||||
detail the logical and of the return value and
|
||||
.BI "(1 << " joydev )
|
||||
is non-zero if this joystick status changed.
|
||||
|
||||
.SH CAVEATS
|
||||
This function is only available in ELF versions of svgalib. Due to backwards
|
||||
compatibility issues it cannot be used with shared a.out libs.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR joytest (6),
|
||||
.BR mjoytest (6),
|
||||
.BR joystick_init (3),
|
||||
.BR joystick_close (3),
|
||||
.BR joystick_sethandler (3),
|
||||
.BR joystick_setdefaulthandler (3),
|
||||
.BR joystick_getnumaxes (3),
|
||||
.BR joystick_getnumbuttons (3),
|
||||
.BR joystick_getaxis (3),
|
||||
.BR joystick_getbutton (3),
|
||||
.BR joystick_button1 (3),
|
||||
.BR joystick_getb1 (3),
|
||||
.BR joystick_x (3),
|
||||
.BR joystick_getx (3).
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
The svgalib joystick handler was mostly done by Daniel Engstr\\"om <daniel.engstrom@riksnett.no>.
|
||||
Multiple joystick, VC switching support and code to glue it into svgalib by Michael Weller
|
||||
<eowmob@exp-math.uni-essen.de>. Part of the code is based on code from C. Smith and
|
||||
Vojtech Pavlik.
|
||||
1
doc/man3/joystick_x.3
Normal file
1
doc/man3/joystick_x.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_y.3
Normal file
1
doc/man3/joystick_y.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
1
doc/man3/joystick_z.3
Normal file
1
doc/man3/joystick_z.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/joystick_getaxis.3
|
||||
48
doc/man3/keyboard_clearstate.3
Normal file
48
doc/man3/keyboard_clearstate.3
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
.TH keyboard_clearstate 3 "29 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_clearstate \- reset the state of all keys when in raw keyboard mode
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "void keyboard_clearstate(void);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
When in raw keyboard mode, svgalib receives press and release events from the kernel and
|
||||
keeps track which keys are currently pressed. Calling
|
||||
.B keyboard_clearstate()
|
||||
sets this information to all keys released. You can use this for cleanup at certain places
|
||||
in your program. In addition svgalib resets the states of all keys when a VC switch occurs
|
||||
because it does not know the current state of keys when it regains control of the console.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_seteventhandler (3),
|
||||
.BR keyboard_init (3),
|
||||
.BR keyboard_init_return_fd (3),
|
||||
.BR keyboard_close (3),
|
||||
.BR keyboard_setdefaulteventhandler (3),
|
||||
.BR keyboard_getstate (3),
|
||||
.BR keyboard_keypressed (3),
|
||||
.BR keyboard_translatekeys (3),
|
||||
.BR keyboard_update (3),
|
||||
.BR keyboard_waitforupdate (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
46
doc/man3/keyboard_close.3
Normal file
46
doc/man3/keyboard_close.3
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
.TH keyboard_close 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_close \- return the keyboard to normal operation from raw mode
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "void keyboard_close(void);
|
||||
|
||||
.SH DESCRIPTION
|
||||
This routine returns the keyboard to normal operation from raw mode. If you used
|
||||
one of the
|
||||
.B keyboard_init_*()
|
||||
routines you should call it prior to leaving your svgalib application as a keyboard in raw mode
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_seteventhandler (3),
|
||||
.BR keyboard_init (3),
|
||||
.BR keyboard_init_return_fd (3),
|
||||
.BR keyboard_update (3),
|
||||
.BR keyboard_waitforupdate (3),
|
||||
.BR keyboard_setdefaulteventhandler (3),
|
||||
.BR keyboard_getstate (3),
|
||||
.BR keyboard_clearstate (3),
|
||||
.BR keyboard_translatekeys (3),
|
||||
.BR keyboard_keypressed (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
143
doc/man3/keyboard_getstate.3
Normal file
143
doc/man3/keyboard_getstate.3
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
.TH keyboard_getstate 3 "29 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_getstate \- get a pointer to a buffer holding the state of all keys in raw keyboard mode
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "char *keyboard_getstate(void);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
When in raw keyboard mode this routine returns a pointer
|
||||
.I buffer
|
||||
to a static buffer. If the value in
|
||||
.IB buffer [ scancode ]
|
||||
is
|
||||
.BR KEY_PRESSED " or " KEY_NOTPRESSED
|
||||
the key with that
|
||||
.I scancode
|
||||
is pressed or not. Actually
|
||||
.BR KEY_PRESSED " is 1 and " KEY_NOTPRESSED " is 0,"
|
||||
s.t. you can use constructs like:
|
||||
|
||||
.B "if(buffer[SCANCODE_ENTER]) {"
|
||||
.br
|
||||
.BR " " "/* do something */"
|
||||
.br
|
||||
.B }
|
||||
|
||||
This is more efficient than calling
|
||||
.BR keyboard_keypressed (3)
|
||||
if you want to check for many different keys.
|
||||
|
||||
Please note that keyboard events will only be processed when you occasionally call
|
||||
.BR keyboard_update "(3) or "
|
||||
.BR keyboard_waitforupdate (3).
|
||||
|
||||
.BR keyboard_translatekeys (3)
|
||||
allows certain remap operations which make certain keys (digits, enter) which might have
|
||||
several physical keys show up under the same scancodes.
|
||||
|
||||
Here are the supported scancodes. The names of the
|
||||
.B #defines
|
||||
originate from the US keyboard layout, for other countries, they'll refer to the key
|
||||
in the same physical location, but the keycap will have a different inscription. For
|
||||
the list below, add
|
||||
.BR SCANCODE_
|
||||
in front of the names to get the right name for your C source. That means, if it lists
|
||||
.BR BACKSLASH
|
||||
below, you shall use
|
||||
.BR SCANCODE_BACKSLASH
|
||||
as symbol in your program. In addition to the names below we also have
|
||||
.BR SCANCODE_0 " - " SCANCODE_9 ", "
|
||||
.BR SCANCODE_KEYPAD0 " - " SCANCODE_KEYPAD9 ", "
|
||||
.BR SCANCODE_A " - " SCANCODE_Z ", and "
|
||||
.BR SCANCODE_F1 " - " SCANCODE_F12 "."
|
||||
|
||||
The other key names are
|
||||
.BR ESCAPE ", "
|
||||
.BR MINUS ", "
|
||||
.BR EQUAL ", "
|
||||
.BR BACKSPACE ", "
|
||||
.BR TAB ", "
|
||||
.BR BRACKET_LEFT ", "
|
||||
.BR BRACKET_RIGHT ", "
|
||||
.BR ENTER ", "
|
||||
.BR LEFTCONTROL ", "
|
||||
.BR SEMICOLON ", "
|
||||
.BR APOSTROPHE ", "
|
||||
.BR GRAVE ", "
|
||||
.BR LEFTSHIFT ", "
|
||||
.BR BACKSLASH ", "
|
||||
.BR COMMA ", "
|
||||
.BR PERIOD ", "
|
||||
.BR SLASH ", "
|
||||
.BR RIGHTSHIFT ", "
|
||||
.BR KEYPADMULTIPLY ", "
|
||||
.BR LEFTALT ", "
|
||||
.BR SPACE ", "
|
||||
.BR CAPSLOCK ", "
|
||||
.BR NUMLOCK ", "
|
||||
.BR SCROLLLOCK ", "
|
||||
.BR CURSORUPLEFT ", "
|
||||
.BR CURSORUP ", "
|
||||
.BR CURSORUPRIGHT ", "
|
||||
.BR KEYPADMINUS ", "
|
||||
.BR CURSORLEFT ", "
|
||||
.BR CURSORRIGHT ", "
|
||||
.BR KEYPADPLUS ", "
|
||||
.BR CURSORDOWNLEFT ", "
|
||||
.BR CURSORDOWN ", "
|
||||
.BR CURSORDOWNRIGHT ", "
|
||||
.BR KEYPADPERIOD ", "
|
||||
.BR LESS ", "
|
||||
.BR KEYPADENTER ", "
|
||||
.BR RIGHTCONTROL ", "
|
||||
.BR CONTROL ", "
|
||||
.BR KEYPADDIVIDE ", "
|
||||
.BR PRINTSCREEN ", "
|
||||
.BR RIGHTALT ", "
|
||||
.BR BREAK ", "
|
||||
.BR BREAK_ALTERNATIVE ", "
|
||||
.BR HOME ", "
|
||||
.BR CURSORBLOCKUP ", "
|
||||
.BR PAGEUP ", "
|
||||
.BR CURSORBLOCKLEFT ", "
|
||||
.BR CURSORBLOCKRIGHT ", "
|
||||
.BR END ", "
|
||||
.BR CURSORBLOCKDOWN ", "
|
||||
.BR PAGEDOWN ", "
|
||||
.BR INSERT ", and "
|
||||
.BR REMOVE "."
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_seteventhandler (3),
|
||||
.BR keyboard_init (3),
|
||||
.BR keyboard_init_return_fd (3),
|
||||
.BR keyboard_close (3),
|
||||
.BR keyboard_setdefaulteventhandler (3),
|
||||
.BR keyboard_getstate (3),
|
||||
.BR keyboard_clearstate (3),
|
||||
.BR keyboard_translatekeys (3),
|
||||
.BR keyboard_update (3),
|
||||
.BR keyboard_waitforupdate (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
73
doc/man3/keyboard_init.3
Normal file
73
doc/man3/keyboard_init.3
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
.TH keyboard_init 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_init, keyboard_init_return_fd \- initialize the keyboard to raw mode
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "int keyboard_init(void);
|
||||
.br
|
||||
.BI "int keyboard_init_return_fd(void);
|
||||
|
||||
.SH DESCRIPTION
|
||||
These routines initialize the keyboard to raw mode. No ASCII codes are produced, instead
|
||||
svgalib keeps track of each single keypress or depress.
|
||||
The
|
||||
.B return_fd
|
||||
version returns the file descriptor of the
|
||||
console device to allow you to do further tricks with it (though it is unclear which).
|
||||
The other version just returns 0 if successful.
|
||||
Both return -1 on error.
|
||||
|
||||
.BR keyboard_close (3)
|
||||
returns to normal operation.
|
||||
|
||||
When in raw keyboard mode you can no longer use
|
||||
.BR vga_getch(3)
|
||||
or
|
||||
.BR vga_getkey(3)
|
||||
but you must use
|
||||
.BR keyboard_getstate (3)
|
||||
or
|
||||
.BR keyboard_keypressed (3).
|
||||
|
||||
Depending on the setting of
|
||||
.BR keyboard_translatekeys (3)
|
||||
even in raw mode a
|
||||
.B <Ctrl>-C
|
||||
will cause a
|
||||
.BR SIGINT.
|
||||
In any case svgalib will check for
|
||||
.BR <Alt>-F1 " - " <Alt>-F10
|
||||
and perform console switches accordingly.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_seteventhandler (3),
|
||||
.BR keyboard_close (3),
|
||||
.BR keyboard_update (3),
|
||||
.BR keyboard_waitforupdate (3),
|
||||
.BR keyboard_setdefaulteventhandler (3),
|
||||
.BR keyboard_getstate (3),
|
||||
.BR keyboard_clearstate (3),
|
||||
.BR keyboard_translatekeys (3),
|
||||
.BR keyboard_keypressed (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
1
doc/man3/keyboard_init_return_fd.3
Normal file
1
doc/man3/keyboard_init_return_fd.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/keyboard_init.3
|
||||
135
doc/man3/keyboard_keypressed.3
Normal file
135
doc/man3/keyboard_keypressed.3
Normal file
|
|
@ -0,0 +1,135 @@
|
|||
.TH keyboard_keypressed 3 "29 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_keypressed \- check if a key is pressed when in raw keyboard mode
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "int keyboard_keypressed(int " scancode );
|
||||
|
||||
.SH DESCRIPTION
|
||||
When in raw keyboard mode this routine checks if the key with
|
||||
.I scancode
|
||||
is pressed and returns
|
||||
.BR KEY_PRESSED " or " KEY_NOTPRESSED
|
||||
accordingly. Actually
|
||||
.BR KEY_PRESSED " is 1 and " KEY_NOTPRESSED " is 0,"
|
||||
s.t. you can use constructs like:
|
||||
|
||||
.B "if(keyboard_keypressed(SCANCODE_ENTER)) {"
|
||||
.br
|
||||
.BR " " "/* do something */"
|
||||
.br
|
||||
.B }
|
||||
|
||||
Please note that keyboard events will only be processed when you occasionally call
|
||||
.BR keyboard_update "(3) or "
|
||||
.BR keyboard_waitforupdate (3).
|
||||
|
||||
.BR keyboard_translatekeys (3)
|
||||
allows certain remap operations which make certain keys (digits, enter) which might have
|
||||
several physical keys show up under the same scancodes.
|
||||
|
||||
Here are the supported scancodes. The names of the
|
||||
.B #defines
|
||||
originate from the US keyboard layout, for other countries, they'll refer to the key
|
||||
in the same physical location, but the keycap will have a different inscription. For
|
||||
the list below, add
|
||||
.BR SCANCODE_
|
||||
in front of the names to get the right name for your C source. That means, if it lists
|
||||
.BR BACKSLASH
|
||||
below, you shall use
|
||||
.BR SCANCODE_BACKSLASH
|
||||
as symbol in your program. In addition to the names below we also have
|
||||
.BR SCANCODE_0 " - " SCANCODE_9 ", "
|
||||
.BR SCANCODE_KEYPAD0 " - " SCANCODE_KEYPAD9 ", "
|
||||
.BR SCANCODE_A " - " SCANCODE_Z ", and "
|
||||
.BR SCANCODE_F1 " - " SCANCODE_F12 "."
|
||||
|
||||
The other key names are
|
||||
.BR ESCAPE ", "
|
||||
.BR MINUS ", "
|
||||
.BR EQUAL ", "
|
||||
.BR BACKSPACE ", "
|
||||
.BR TAB ", "
|
||||
.BR BRACKET_LEFT ", "
|
||||
.BR BRACKET_RIGHT ", "
|
||||
.BR ENTER ", "
|
||||
.BR LEFTCONTROL ", "
|
||||
.BR SEMICOLON ", "
|
||||
.BR APOSTROPHE ", "
|
||||
.BR GRAVE ", "
|
||||
.BR LEFTSHIFT ", "
|
||||
.BR BACKSLASH ", "
|
||||
.BR COMMA ", "
|
||||
.BR PERIOD ", "
|
||||
.BR SLASH ", "
|
||||
.BR RIGHTSHIFT ", "
|
||||
.BR KEYPADMULTIPLY ", "
|
||||
.BR LEFTALT ", "
|
||||
.BR SPACE ", "
|
||||
.BR CAPSLOCK ", "
|
||||
.BR NUMLOCK ", "
|
||||
.BR SCROLLLOCK ", "
|
||||
.BR CURSORUPLEFT ", "
|
||||
.BR CURSORUP ", "
|
||||
.BR CURSORUPRIGHT ", "
|
||||
.BR KEYPADMINUS ", "
|
||||
.BR CURSORLEFT ", "
|
||||
.BR CURSORRIGHT ", "
|
||||
.BR KEYPADPLUS ", "
|
||||
.BR CURSORDOWNLEFT ", "
|
||||
.BR CURSORDOWN ", "
|
||||
.BR CURSORDOWNRIGHT ", "
|
||||
.BR KEYPADPERIOD ", "
|
||||
.BR LESS ", "
|
||||
.BR KEYPADENTER ", "
|
||||
.BR RIGHTCONTROL ", "
|
||||
.BR CONTROL ", "
|
||||
.BR KEYPADDIVIDE ", "
|
||||
.BR PRINTSCREEN ", "
|
||||
.BR RIGHTALT ", "
|
||||
.BR BREAK ", "
|
||||
.BR BREAK_ALTERNATIVE ", "
|
||||
.BR HOME ", "
|
||||
.BR CURSORBLOCKUP ", "
|
||||
.BR PAGEUP ", "
|
||||
.BR CURSORBLOCKLEFT ", "
|
||||
.BR CURSORBLOCKRIGHT ", "
|
||||
.BR END ", "
|
||||
.BR CURSORBLOCKDOWN ", "
|
||||
.BR PAGEDOWN ", "
|
||||
.BR INSERT ", and "
|
||||
.BR REMOVE "."
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_seteventhandler (3),
|
||||
.BR keyboard_init (3),
|
||||
.BR keyboard_init_return_fd (3),
|
||||
.BR keyboard_close (3),
|
||||
.BR keyboard_setdefaulteventhandler (3),
|
||||
.BR keyboard_keypressed (3),
|
||||
.BR keyboard_clearstate (3),
|
||||
.BR keyboard_translatekeys (3),
|
||||
.BR keyboard_update (3),
|
||||
.BR keyboard_waitforupdate (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
1
doc/man3/keyboard_setdefaulteventhandler.3
Normal file
1
doc/man3/keyboard_setdefaulteventhandler.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/keyboard_seteventhandler.3
|
||||
145
doc/man3/keyboard_seteventhandler.3
Normal file
145
doc/man3/keyboard_seteventhandler.3
Normal file
|
|
@ -0,0 +1,145 @@
|
|||
.TH keyboard_seteventhandler 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_seteventhandler, keyboard_setdefaulteventhandler \- define an event handler for keyboard events in raw mode
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "typedef void (*" __keyboard_handler ") (int " scancode ", int " press ");"
|
||||
|
||||
.BI "void keyboard_seteventhandler(__keyboard_handler " handler ");"
|
||||
.br
|
||||
.BI "void keyboard_setdefaulteventhandler(void);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
These functions allow to define a keyboard event handler which is called by
|
||||
.BR keyboard_update "(3) and "
|
||||
.BR keyboard_waitforupdate (3)
|
||||
when a keyboard event occured.
|
||||
|
||||
.I press
|
||||
is
|
||||
.BR KEY_EVENTRELEASE " or " KEY_EVENTPRESS
|
||||
if key
|
||||
.I scancode
|
||||
was released or pressed. Actually the first value is 0 and the second is 1 which are
|
||||
so intuitive s.t. you may use them in your program.
|
||||
|
||||
Even you specify an own handler, svgalib will check for
|
||||
.BR "<Alt>-F*" " or " "<Ctrl>-C"
|
||||
for console switches or generation of
|
||||
.BR SIGINT
|
||||
if allowed by
|
||||
.BR keyboard_translatekeys (3).
|
||||
|
||||
Calling
|
||||
.B keyboard_setdefaulteventhandler()
|
||||
reinstates the default handler which maintains the tables used by
|
||||
.BR keyboard_getstate "(3) and "
|
||||
.BR keyboard_keypressed (3).
|
||||
It is probably a good idea to call
|
||||
.BR keyboard_clearstate (3)
|
||||
after reenabling the default handler.
|
||||
|
||||
Here are the supported scancodes. The names of the
|
||||
.B #defines
|
||||
originate from the US keyboard layout, for other countries, they'll refer to the key
|
||||
in the same physical location, but the keycap will have a different inscription. For
|
||||
the list below, add
|
||||
.BR SCANCODE_
|
||||
in front of the names to get the right name for your C source. That means, if it lists
|
||||
.BR BACKSLASH
|
||||
below, you shall use
|
||||
.BR SCANCODE_BACKSLASH
|
||||
as symbol in your program. In addition to the names below we also have
|
||||
.BR SCANCODE_0 " - " SCANCODE_9 ", "
|
||||
.BR SCANCODE_KEYPAD0 " - " SCANCODE_KEYPAD9 ", "
|
||||
.BR SCANCODE_A " - " SCANCODE_Z ", and "
|
||||
.BR SCANCODE_F1 " - " SCANCODE_F12 "."
|
||||
|
||||
The other key names are
|
||||
.BR ESCAPE ", "
|
||||
.BR MINUS ", "
|
||||
.BR EQUAL ", "
|
||||
.BR BACKSPACE ", "
|
||||
.BR TAB ", "
|
||||
.BR BRACKET_LEFT ", "
|
||||
.BR BRACKET_RIGHT ", "
|
||||
.BR ENTER ", "
|
||||
.BR LEFTCONTROL ", "
|
||||
.BR SEMICOLON ", "
|
||||
.BR APOSTROPHE ", "
|
||||
.BR GRAVE ", "
|
||||
.BR LEFTSHIFT ", "
|
||||
.BR BACKSLASH ", "
|
||||
.BR COMMA ", "
|
||||
.BR PERIOD ", "
|
||||
.BR SLASH ", "
|
||||
.BR RIGHTSHIFT ", "
|
||||
.BR KEYPADMULTIPLY ", "
|
||||
.BR LEFTALT ", "
|
||||
.BR SPACE ", "
|
||||
.BR CAPSLOCK ", "
|
||||
.BR NUMLOCK ", "
|
||||
.BR SCROLLLOCK ", "
|
||||
.BR CURSORUPLEFT ", "
|
||||
.BR CURSORUP ", "
|
||||
.BR CURSORUPRIGHT ", "
|
||||
.BR KEYPADMINUS ", "
|
||||
.BR CURSORLEFT ", "
|
||||
.BR CURSORRIGHT ", "
|
||||
.BR KEYPADPLUS ", "
|
||||
.BR CURSORDOWNLEFT ", "
|
||||
.BR CURSORDOWN ", "
|
||||
.BR CURSORDOWNRIGHT ", "
|
||||
.BR KEYPADPERIOD ", "
|
||||
.BR LESS ", "
|
||||
.BR KEYPADENTER ", "
|
||||
.BR RIGHTCONTROL ", "
|
||||
.BR CONTROL ", "
|
||||
.BR KEYPADDIVIDE ", "
|
||||
.BR PRINTSCREEN ", "
|
||||
.BR RIGHTALT ", "
|
||||
.BR BREAK ", "
|
||||
.BR BREAK_ALTERNATIVE ", "
|
||||
.BR HOME ", "
|
||||
.BR CURSORBLOCKUP ", "
|
||||
.BR PAGEUP ", "
|
||||
.BR CURSORBLOCKLEFT ", "
|
||||
.BR CURSORBLOCKRIGHT ", "
|
||||
.BR END ", "
|
||||
.BR CURSORBLOCKDOWN ", "
|
||||
.BR PAGEDOWN ", "
|
||||
.BR INSERT ", and "
|
||||
.BR REMOVE "."
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_init (3),
|
||||
.BR keyboard_init_return_fd (3),
|
||||
.BR keyboard_close (3),
|
||||
.BR keyboard_getstate (3),
|
||||
.BR keyboard_keypressed (3),
|
||||
.BR keyboard_clearstate (3),
|
||||
.BR keyboard_translatekeys (3),
|
||||
.BR keyboard_update (3),
|
||||
.BR keyboard_waitforupdate (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
105
doc/man3/keyboard_translatekeys.3
Normal file
105
doc/man3/keyboard_translatekeys.3
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
.TH keyboard_translatekeys 3 "29 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_translatekeys \- modify scancode mappings in raw keyboard mode
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "void keyboard_translatekeys(int " mask );
|
||||
|
||||
.SH DESCRIPTION
|
||||
This function sets several flags which control how certain scancodes are mapped. At startup
|
||||
a
|
||||
.I mask
|
||||
value of 0 is active.
|
||||
|
||||
.I mask
|
||||
must be a logical or of zero or more of the following
|
||||
.B #predefined
|
||||
integers to turn the features listed on:
|
||||
|
||||
.TP
|
||||
.B TRANSLATE_CURSORKEYS
|
||||
Translate the scancodes of the
|
||||
.B SCANCODE_CURSORBLOCK*
|
||||
keys to those of the cursor keys on the number pad, s.t.
|
||||
.BR keyboard_getstate "(3) and " keyboard_keypressed (3)
|
||||
report a keypress of the corresponding number pad cursor key and not the one
|
||||
on the cursor block.
|
||||
.TP
|
||||
.B TRANSLATE_DIAGONAL
|
||||
Translates the scancodes of diagonal cursor keys (keypad 7, 9, 1, 3) to presses of two
|
||||
of the ordinary up, down, left, right keys. For example, instead of reporting
|
||||
a press of
|
||||
.B SCANCODE_CURSORUPRIGHT
|
||||
.BR keyboard_getstate "(3) and " keyboard_keypressed (3)
|
||||
report a simultaneous press of
|
||||
.BR SCANCODE_CURSORUP " and " SCANCODE_CURSORRIGHT .
|
||||
.TP
|
||||
.B TRANSLATE_KEYPADENTER
|
||||
The scancode of the keypad enter key is mapped to that of the ordinary enter key, s.t.
|
||||
.BR keyboard_getstate "(3) and " keyboard_keypressed (3)
|
||||
report a press of
|
||||
.B SCANCODE_ENTER
|
||||
regardless if keypad enter or ordinary enter is pressed.
|
||||
.TP
|
||||
.B DONT_CATCH_CTRLC
|
||||
Pressing
|
||||
.B <Ctrl>-C
|
||||
does
|
||||
.B not
|
||||
raise a
|
||||
.BR SIGINT .
|
||||
On contrary to the other flags this has also effect when a user defined keyboard event handler
|
||||
is used. Svgalib will
|
||||
.BR always " process " <Alt>-F1 " - " <Alt>-F10
|
||||
and perform console switches accordingly.
|
||||
|
||||
.SH BUGS
|
||||
The
|
||||
.B TRANSLATE_*
|
||||
options above do really do simple scancode translations. For example, when
|
||||
.B TRANSLATE_KEYPADENTER
|
||||
is active and the user presses both enter and keypad enter. Then, if he releases
|
||||
one of them (say keypad enter), it's release event will clear the common keyboard state, s.t.
|
||||
no keypress is reported even though enter is still pressed.
|
||||
|
||||
Similarly, if
|
||||
.B TRANSLATE_DIAGONAL
|
||||
is active, the user holds cursor upleft (keypad 7) down and then presses and release
|
||||
cursor up (keypad 8), svgalib will only report a pressed cursor left but the simulated
|
||||
cursor up will be lost. You can easily try this with the
|
||||
.BR keytest (6)
|
||||
demo to make the effect more clear to you.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_seteventhandler (3),
|
||||
.BR keyboard_init (3),
|
||||
.BR keyboard_init_return_fd (3),
|
||||
.BR keyboard_close (3),
|
||||
.BR keyboard_update (3),
|
||||
.BR keyboard_waitforupdate (3),
|
||||
.BR keyboard_setdefaulteventhandler (3),
|
||||
.BR keyboard_getstate (3),
|
||||
.BR keyboard_clearstate (3),
|
||||
.BR keyboard_keypressed (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
57
doc/man3/keyboard_update.3
Normal file
57
doc/man3/keyboard_update.3
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
.TH keyboard_update 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
keyboard_update, keyboard_waitforupdate \- process raw keyboard events
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgakeyboard.h>"
|
||||
|
||||
.BI "int keyboard_update(void);
|
||||
.br
|
||||
.BI "void keyboard_waitforupdate(void);
|
||||
|
||||
.SH DESCRIPTION
|
||||
These routines check the keyboard buffer for any raw keyboard events and do the
|
||||
necessary updates to the internal buffers of
|
||||
.BR keyboard_clearstate (3)
|
||||
and
|
||||
.BR keyboard_keypressed (3).
|
||||
|
||||
When there are no such events,
|
||||
.B keyboard_update()
|
||||
returns 0 immediately (non-zero else) whereas
|
||||
.B keyboard_waitforupdate()
|
||||
blocks and waits until an event occurs.
|
||||
|
||||
.BR vga_waitevent (3)
|
||||
allows to wait for keyboard and other events at the same time.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR keytest (6),
|
||||
.BR eventtest (6),
|
||||
.BR keyboard_seteventhandler (3),
|
||||
.BR keyboard_init (3),
|
||||
.BR keyboard_init_return_fd (3),
|
||||
.BR keyboard_close (3),
|
||||
.BR keyboard_setdefaulteventhandler (3),
|
||||
.BR keyboard_getstate (3),
|
||||
.BR keyboard_clearstate (3),
|
||||
.BR keyboard_translatekeys (3),
|
||||
.BR keyboard_keypressed (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
1
doc/man3/keyboard_waitforupdate.3
Normal file
1
doc/man3/keyboard_waitforupdate.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/keyboard_update.3
|
||||
45
doc/man3/mouse_close.3
Normal file
45
doc/man3/mouse_close.3
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
.TH mouse_close 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
|
||||
.SH NAME
|
||||
mouse_close \- explicitly close a mouse
|
||||
.SH SYNOPSIS
|
||||
|
||||
.B "#include <vgamouse.h>"
|
||||
|
||||
.BI "void mouse_close(void);"
|
||||
|
||||
.SH DESCRIPTION
|
||||
Closes the mouse device file. This should be called at
|
||||
the end of the program (if a mouse is used) because it
|
||||
tries to restore the original mouse state, if it has changed.
|
||||
.SH SEE ALSO
|
||||
|
||||
.BR svgalib (7),
|
||||
.BR vgagl (7),
|
||||
.BR libvga.config (5),
|
||||
.BR eventtest (6),
|
||||
.BR mousetest (6),
|
||||
.BR mouse_init (3),
|
||||
.BR mouse_getposition_6d (3),
|
||||
.BR mouse_getx (3),
|
||||
.BR mouse_setposition (3),
|
||||
.BR mouse_setscale (3),
|
||||
.BR mouse_setwrap (3),
|
||||
.BR mouse_setxrange (3),
|
||||
.BR mouse_update (3),
|
||||
.BR mouse_waitforupdate (3),
|
||||
.BR mouse_seteventhandler (3),
|
||||
.BR vga_setmousesupport (3),
|
||||
.BR vga_waitevent (3)
|
||||
|
||||
.SH AUTHOR
|
||||
|
||||
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
|
||||
exact source of the referenced function 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.
|
||||
1
doc/man3/mouse_getbutton.3
Normal file
1
doc/man3/mouse_getbutton.3
Normal file
|
|
@ -0,0 +1 @@
|
|||
.so man3/mouse_getx.3
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue