bionic (3) ureadkey.3alleg4.gz

Provided by: allegro4-doc_4.4.2-10_all bug

NAME
       ureadkey - Returns the next unicode character from the keyboard buffer. Allegro game programming library.


SYNOPSIS
       #include <allegro.h>

       int ureadkey(int *scancode);


DESCRIPTION
       Returns the next character from the keyboard buffer, in Unicode format.  If the buffer is empty, it waits
       until a key is pressed. You can see if there are queued keypresses with keypressed().  The  return  value
       contains the Unicode value of the key, and if not NULL, the pointer argument will be set to the scancode.
       Unlike readkey(), this function is able to return character values greater than 255. Example:

          int val, scancode;
          ...
          val = ureadkey(&scancode);
          if (val == 0x00F1)
             allegro_message("You pressed n with tilde\n");

          if (val == 0x00DF)
             allegro_message("You pressed sharp s\n");

       You should be able to find Unicode character maps at http://www.unicode.org/. Remember that  on  DOS  you
       must  specify  a  custom  keyboard  map  (like  those found in `keyboard.dat') usually with the help of a
       configuration  file  specifying  the  language  mapping  (keyboard  variable   in   system   section   of
       `allegro.cfg'), or you will get the default US keyboard mapping.


SEE ALSO
       install_keyboard(3alleg4),       readkey(3alleg4),       keypressed(3alleg4),      clear_keybuf(3alleg4),
       simulate_ukeypress(3alleg4), exkeys(3alleg4)