This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_EnableUNICODE.3
24 lines (24 loc) · 1.19 KB
1
.TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
2
3
4
5
6
7
8
9
10
.SH "NAME"
SDL_EnableUNICODE\- Enable UNICODE translation
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR);
.SH "DESCRIPTION"
.PP
11
Enables/Disables Unicode keyboard translation\&.
12
.PP
13
14
15
16
17
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\&.
.PP
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)\&.
.PP
Note that only key press events will be translated, not release events\&.
18
19
.SH "RETURN VALUE"
.PP
20
Returns the previous translation mode (\fB0\fR or \fB1\fR)\&.
21
22
23
.SH "SEE ALSO"
.PP
\fI\fBSDL_keysym\fR\fR
24
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59