home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_PeepEvents.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.9 KB  |  56 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_PeepEvents"("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_PeepEvents- Checks the event queue for messages and optionally returns
  13. them. 
  14. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  15. <p>
  16. <b>#include "SDL.h" <p>
  17. </b><b>int <b>SDL_PeepEvents</b></b>(<b>SDL_Event *events, int
  18. numevents, SDL_eventaction action, Uint32 mask</b>); 
  19. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  20. <p>
  21. Checks the
  22. event queue for messages and optionally returns them. <p>
  23. If <b>action</b> is <b>SDL_ADDEVENT</b>,
  24. up to <b>numevents</b> events will be added to the back of the event queue. <p>
  25. If
  26. <b>action</b> is <b>SDL_PEEKEVENT</b>, up to <b>numevents</b> events at the front of the event
  27. queue, matching <i><b>mask</b></i>, will be returned and will not be removed from the
  28. queue. <p>
  29. If <b>action</b> is <b>SDL_GETEVENT</b>, up to <b>numevents</b> events at the front of
  30. the event queue, matching <i><b>mask</b></i>, will be returned and will be removed from
  31. the queue. <p>
  32. This function is thread-safe. 
  33. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  34. <p>
  35. This function returns
  36. the number of events actually stored, or <b>-1</b> if there was an error.  
  37. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  38. <p>
  39. <i><b>SDL_Event</b></i>,
  40. <i><b>SDL_PollEvent</b></i>, <i><b>SDL_PushEvent</b></i> 
  41. <!--
  42.   
  43.  <p>
  44.  
  45. <hr><p>
  46. <a name='toc'><b>Table of Contents</b></a><p>
  47. <ul>
  48. <li><a name='toc0' href='#sect0'>Name</a></li>
  49. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  50. <li><a name='toc2' href='#sect2'>Description</a></li>
  51. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  52. <li><a name='toc4' href='#sect4'>See Also</a></li>
  53. </ul>
  54. </body>
  55. </html>
  56.