pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated from the SDL Documentation Project

Browse source 
--HG--
extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%40182
This commit is contained in:
Sam Lantinga 2001-09-14 02:41:09 +00:00
parent 627578c0d5
commit 8dd601989f
355 changed files with 2317 additions and 1398 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/man3/SDL_EnableUNICODE.3
View file

@ -1,4 +1,4 @@
.TH "SDL_EnableUNICODE" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_EnableUNICODE\- Enable UNICODE translation
.SH "SYNOPSIS"
@ -8,13 +8,17 @@ SDL_EnableUNICODE\- Enable UNICODE translation
\fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR);
.SH "DESCRIPTION"
.PP
Enables/Disables UNICODE keyboard translation\&.
Enables/Disables Unicode keyboard translation\&.
.PP
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\&.
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\&.
.SH "RETURN VALUE"
.PP
Returns the previous translation mode\&.
Returns the previous translation mode (\fB0\fR or \fB1\fR)\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_keysym\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59