Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
poll_keyboard(3)		 Allegro manual 		poll_keyboard(3)

NAME
     poll_keyboard - Polls the keyboard. Allegro game programming library.

SYNOPSIS
     #include <allegro.h>

     int poll_keyboard();

DESCRIPTION
     Wherever possible, Allegro will read the keyboard input asynchronously (ie.
     from  inside  an  interrupt handler), but on some platforms that may not be
     possible, in which case you must call this routine at regular intervals  to
     update the keyboard state variables.

     To  help you test your keyboard polling code even if you are programming on
     a platform that doesn't require it, after the first time that you call this
     function Allegro will switch into polling mode, so from that point  onwards
     you  will	have  to call this routine in order to get any keyboard input at
     all, regardless of whether the current driver actually needs to  be  polled
     or not.

     The  keypressed(), readkey(), and ureadkey() functions call poll_keyboard()
     automatically, so you only need to use this  function  when  accessing  the
     key[] array and key_shifts variable.

RETURN VALUE
     Returns  zero  on success, or a negative number on failure (ie. no keyboard
     driver installed).

SEE ALSO
     keyboard_needs_poll(3), install_keyboard(3), key(3), key_shifts(3),  excam-
     era(3), exsample(3), exstars(3)

Allegro 			  version 4.4.3 		poll_keyboard(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=poll_keyboard&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help