aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_keysym.3
diff options
context:
space:
mode:
authorSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
committerSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
commita546c7006355a7bd1df4267ee53d0bfa2c017c8c (patch)
tree01be0bf6c0d6968e1468ec9661fd52110f9b05a7 /distrib/sdl-1.2.15/docs/man3/SDL_keysym.3
parentbaf3d7830396202df5cc47bd7bcee109c319cdb3 (diff)
parent0f809250987b64f491bd3b4b73c0f0d33036a786 (diff)
downloadexternal_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.zip
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.gz
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.bz2
Merge branch 'jb-mr1-release' of https://android.googlesource.com/platform/external/qemu into mr1-staging
Change-Id: I8a4a71ac65b08e6e17f26c942f67a15b85211115
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_keysym.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_keysym.369
1 files changed, 69 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_keysym.3 b/distrib/sdl-1.2.15/docs/man3/SDL_keysym.3
new file mode 100644
index 0000000..52065c1
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_keysym.3
@@ -0,0 +1,69 @@
+.TH "SDL_keysym" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_keysym \- Keysym structure
+.SH "STRUCTURE DEFINITION"
+.PP
+.nf
+\f(CWtypedef struct{
+ Uint8 scancode;
+ SDLKey sym;
+ SDLMod mod;
+ Uint16 unicode;
+} SDL_keysym;\fR
+.fi
+.PP
+.SH "STRUCTURE DATA"
+.TP 20
+\fBscancode\fR
+Hardware specific scancode
+.TP 20
+\fBsym\fR
+SDL virtual keysym
+.TP 20
+\fBmod\fR
+Current key modifiers
+.TP 20
+\fBunicode\fR
+Translated character
+.SH "DESCRIPTION"
+.PP
+The \fBSDL_keysym\fR structure is used by reporting key presses and releases since it is a part of the \fI\fBSDL_KeyboardEvent\fR\fR\&.
+.PP
+The \fBscancode\fR field should generally be left alone, it is the hardware dependent scancode returned by the keyboard\&. The \fBsym\fR field is extremely useful\&. It is the SDL-defined value of the key (see \fISDL Key Syms\fR\&. This field is very useful when you are checking for certain key presses, like so:
+.PP
+.nf
+\f(CW\&.
+\&.
+while(SDL_PollEvent(&event)){
+ switch(event\&.type){
+ case SDL_KEYDOWN:
+ if(event\&.key\&.keysym\&.sym==SDLK_LEFT)
+ move_left();
+ break;
+ \&.
+ \&.
+ \&.
+ }
+}
+\&.
+\&.\fR
+.fi
+.PP
+ \fBmod\fR stores the current state of the keyboard modifiers as explained in \fI\fBSDL_GetModState\fP\fR\&. The \fBunicode\fR is only used when UNICODE translation is enabled with \fI\fBSDL_EnableUNICODE\fP\fR\&. If \fBunicode\fR is non-zero then this a the UNICODE character corresponding to the keypress\&. If the high 9 bits of the character are 0, then this maps to the equivalent ASCII character:
+.PP
+.nf
+\f(CWchar ch;
+if ( (keysym\&.unicode & 0xFF80) == 0 ) {
+ ch = keysym\&.unicode & 0x7F;
+}
+else {
+ printf("An International Character\&.
+");
+}\fR
+.fi
+.PP
+ UNICODE translation does have a slight overhead so don\&'t enable it unless its needed\&.
+.SH "SEE ALSO"
+.PP
+\fI\fBSDLKey\fR\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00