home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_GetKeyState.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.7 KB  |  57 lines
  1. <!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
  2. <!-- available at http://polyglotman.sourceforge.net/ -->
  3.  
  4. <html>
  5. <head>
  6. <title>"SDL_GetKeyState"("3") manual page</title>
  7. </head>
  8. <body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
  9. <a href='#toc'>Table of Contents</a><p>
  10.  
  11. <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12. SDL_GetKeyState- Get a snapshot of the current keyboard state 
  13. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  14. <p>
  15. <b>#include
  16. "SDL.h" <p>
  17. </b><b>Uint8 *<b>SDL_GetKeyState</b></b>(<b>int *numkeys</b>); 
  18. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  19. <p>
  20. Gets a snapshot
  21. of the current keyboard state. The current state is return as a pointer
  22. to an array, the size of this array is stored in <b>numkeys</b>. The array is indexed
  23. by the <i><b>SDLK_*</b></i> symbols. A value of 1 means the key is pressed and a value
  24. of 0 means its not. The pointer returned is a pointer to an internal SDL
  25. array and should not be freed by the caller. <p>
  26. <blockquote><b>Note:   <p>
  27. Use <i><b>SDL_PumpEvents</b></i></b>
  28. to update the state array. </blockquote>
  29.  
  30. <h2><a name='sect3' href='#toc3'>Example</a></h2>
  31. <p>
  32. <p>
  33. <br>
  34. <pre>CWUint8 *keystate = SDL_GetKeyState(NULL);
  35. if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed.
  36. ");
  37. </pre><p>
  38.  
  39. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  40. <p>
  41. <i><b>SDL Key Symbols</b></i>, <i><b>SDL_PumpEvents</b></i> 
  42. <!--
  43.   
  44.  <p>
  45.  
  46. <hr><p>
  47. <a name='toc'><b>Table of Contents</b></a><p>
  48. <ul>
  49. <li><a name='toc0' href='#sect0'>Name</a></li>
  50. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  51. <li><a name='toc2' href='#sect2'>Description</a></li>
  52. <li><a name='toc3' href='#sect3'>Example</a></li>
  53. <li><a name='toc4' href='#sect4'>See Also</a></li>
  54. </ul>
  55. </body>
  56. </html>
  57.