SvgaLib/doc/man3/vga_getkey.3

47 lines
1.3 KiB
Groff

.TH vga_getkey 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
.SH NAME
vga_getkey \- read a character from the keyboard without waiting
.SH SYNOPSIS
.B "#include <vga.h>"
.BI "int vga_getkey(void);"
.SH DESCRIPTION
Read a character from the keyboard without waiting; returns
zero if no key pressed and the ASCII value otherwise. This function must not be used
in raw keyboard mode. In this situation use
.BR keyboard_getstate (3)
or
.BR keyboard_keypressed (3)
instead.
.SH SEE ALSO
.BR svgalib (7),
.BR vgagl (7),
.BR libvga.config (5),
.BR eventtest (6),
.BR keytest (6),
.BR keyboard_init (3),
.BR keyboard_close (3),
.BR keyboard_setdefaulteventhandler (3),
.BR keyboard_seteventhandler (3),
.BR keyboard_getstate (3),
.BR keyboard_clearstate (3),
.BR keyboard_translatekeys (3),
.BR keyboard_keypressed (3),
.BR vga_getch (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.