diff 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
line wrap: on
line diff
--- a/docs/man3/SDL_EnableUNICODE.3	Thu Sep 13 16:41:03 2001 +0000
+++ b/docs/man3/SDL_EnableUNICODE.3	Fri Sep 14 02:41:09 2001 +0000
@@ -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 @@
 \fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR);
 .SH "DESCRIPTION"
 .PP
-Enables/Disables UNICODE keyboard translation\&.
+Enables/Disables Unicode keyboard translation\&.
+.PP
+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
-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\&.
+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