Mercurial > sdl-ios-xcode

view docs/man3/SDL_keysym.3 @ 3100:7dc982143c06

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Date: Sun, 22 Mar 2009 12:52:29 +0000 From: Luke Benstead Subject: OpenGL 3.0 Context Creation I've attached a patch which implements OpenGL 3.x context creation on the latest SVN. I've added two options to SDL_GL_SetAttribute, these are SDL_GL_CONTEXT_MAJOR_VERSION and SDL_GL_CONTEXT_MINOR_VERSION. These default to 2 and 1 respectively. If the major version is less than 3 then the current context creation method is used, otherwise the appropriate new context creation function is called (depending on the platform). Sample code: if (SDL_Init(SDL_INIT_VIDEO) != 0) { printf("Unable to initialize SDL: %s\n", SDL_GetError()); return 1; } SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3); //Without these 2 lines, SDL will create a GL 2.x context SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 0); SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1); SDL_Surface* screen = SDL_SetVideoMode( 640, 480, 16, SDL_OPENGL | SDL_FULLSCREEN ); I've implemented context creation on both Win32 and X and run basic tests on both. This patch doesn't provide access to all the options allowed by the new context creation (e.g. shared contexts, forward compatible contexts) but they can be added pretty easily.
author Sam Lantinga <slouken@libsdl.org>
date Tue, 24 Mar 2009 10:43:53 +0000
parents 546f7c1eb755
children 1238da4a7112
line wrap: on
line source

.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