blob: d9d20270090761be6d7e5caa0454dbb6a8f8442d [file] [log] [blame]
.TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
SDL_EnableUNICODE \- Enable UNICODE translation
\fB#include "SDL\&.h"
\fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR);
Enables/Disables Unicode keyboard translation\&.
To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function\&. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default\&. For each subsequently received key down event, the \fBunicode\fR member of the \fI\fBSDL_keysym\fR\fR 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 \fBenable\fR 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\&.
Returns the previous translation mode (\fB0\fR or \fB1\fR)\&.
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59