Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_EnableUNICODE (3)

Name

SDL_EnableUNICODE - Enable UNICODE translation

Synopsis

#include "SDL.h"

int SDL_EnableUNICODE(int enable);

Description

SDL_EnableUNICODE(3)           SDL API Reference          SDL_EnableUNICODE(3)



NAME
       SDL_EnableUNICODE - Enable UNICODE translation

SYNOPSIS
       #include "SDL.h"

       int SDL_EnableUNICODE(int enable);

DESCRIPTION
       Enables/Disables Unicode keyboard translation.

       To  obtain  the  character  codes  corresponding  to  received keyboard
       events, Unicode translation must first be turned on  using  this  func-
       tion.  The translation incurs a slight overhead for each keyboard event
       and is therefore disabled by default. For  each  subsequently  received
       key  down  event,  the  unicode member of the SDL_keysym structure will
       then contain the corresponding character code, or zero for keysyms that
       do not correspond to any character code.

       A value of 1 for enable enables Unicode translation; 0 disables it, and
       -1 leaves it unchanged (useful for  querying  the  current  translation
       mode).

       Note that only key press events will be translated, not release events.

RETURN VALUE
       Returns the previous translation mode (0 or 1).


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_keysym



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from        https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 22:59        SDL_EnableUNICODE(3)