home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_GetModState.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.9 KB  |  75 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_GetModState"("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_GetModState- Get the state of modifier keys. 
  13. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  14. <p>
  15. <b>#include "SDL.h"
  16. <p>
  17. </b><b>SDLMod <b>SDL_GetModState</b></b>(<b>void</b>); 
  18. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  19. <p>
  20. Returns the current state of the
  21. modifier keys (CTRL, ALT, etc.). 
  22. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  23. <p>
  24. The return value can be an OR'd
  25. combination of the SDLMod enum. <p>
  26. <p>
  27. <blockquote><b>SDLMod</b> <p>
  28. <p>
  29. <br>
  30. <pre>CWtypedef enum {
  31.   KMOD_NONE  = 0x0000,
  32.   KMOD_LSHIFT= 0x0001,
  33.   KMOD_RSHIFT= 0x0002,
  34.   KMOD_LCTRL = 0x0040,
  35.   KMOD_RCTRL = 0x0080,
  36.   KMOD_LALT  = 0x0100,
  37.   KMOD_RALT  = 0x0200,
  38.   KMOD_LMETA = 0x0400,
  39.   KMOD_RMETA = 0x0800,
  40.   KMOD_NUM   = 0x1000,
  41.   KMOD_CAPS  = 0x2000,
  42.   KMOD_MODE  = 0x4000,
  43. } SDLMod;
  44. </pre><p>
  45. </blockquote>
  46.  SDL also defines the following symbols for convenience: <br>
  47.  <p>
  48. <blockquote><p>
  49. <br>
  50. <pre>CW#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL)
  51. #define KMOD_SHIFT  (KMOD_LSHIFT|KMOD_RSHIFT)
  52. #define KMOD_ALT  (KMOD_LALT|KMOD_RALT)
  53. #define KMOD_META (KMOD_LMETA|KMOD_RMETA)
  54. </pre><p>
  55. </blockquote>
  56.  
  57. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  58. <p>
  59. <i><b>SDL_GetKeyState</b></i> 
  60. <!--
  61.   
  62.  <p>
  63.  
  64. <hr><p>
  65. <a name='toc'><b>Table of Contents</b></a><p>
  66. <ul>
  67. <li><a name='toc0' href='#sect0'>Name</a></li>
  68. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  69. <li><a name='toc2' href='#sect2'>Description</a></li>
  70. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  71. <li><a name='toc4' href='#sect4'>See Also</a></li>
  72. </ul>
  73. </body>
  74. </html>
  75.