Mercurial > sdl-ios-xcode
comparison docs/man3/SDL_EnableUNICODE.3 @ 181:e5bc29de3f0a
Updated from the SDL Documentation Project
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 14 Sep 2001 02:41:09 +0000 |
parents | 55f1f1b3e27d |
children | 546f7c1eb755 |
comparison
equal
deleted
inserted
replaced
180:578815880307 | 181:e5bc29de3f0a |
---|---|
1 .TH "SDL_EnableUNICODE" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" | 1 .TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" |
2 .SH "NAME" | 2 .SH "NAME" |
3 SDL_EnableUNICODE\- Enable UNICODE translation | 3 SDL_EnableUNICODE\- Enable UNICODE translation |
4 .SH "SYNOPSIS" | 4 .SH "SYNOPSIS" |
5 .PP | 5 .PP |
6 \fB#include "SDL\&.h" | 6 \fB#include "SDL\&.h" |
7 .sp | 7 .sp |
8 \fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR); | 8 \fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR); |
9 .SH "DESCRIPTION" | 9 .SH "DESCRIPTION" |
10 .PP | 10 .PP |
11 Enables/Disables UNICODE keyboard translation\&. | 11 Enables/Disables Unicode keyboard translation\&. |
12 .PP | 12 .PP |
13 If you wish to translate a keysym to it\&'s printable representation, you need to enable UNICODE translation using this function (\fBenable\fR=0) and then look in the \fBunicode\fR member of the \fI\fBSDL_keysym\fR\fR structure\&. This value will be zero for keysyms that do not have a printable representation\&. UNICODE translation is disabled by default as the conversion can cause a slight overhead\&. | 13 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\&. |
14 .PP | |
15 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)\&. | |
16 .PP | |
17 Note that only key press events will be translated, not release events\&. | |
14 .SH "RETURN VALUE" | 18 .SH "RETURN VALUE" |
15 .PP | 19 .PP |
16 Returns the previous translation mode\&. | 20 Returns the previous translation mode (\fB0\fR or \fB1\fR)\&. |
17 .SH "SEE ALSO" | 21 .SH "SEE ALSO" |
18 .PP | 22 .PP |
19 \fI\fBSDL_keysym\fR\fR | 23 \fI\fBSDL_keysym\fR\fR |
20 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 | 24 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 |