SvgaLib/doc/man3/keyboard_clearstate.3

48 lines
1.6 KiB
Groff

.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.