home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_PushEvent.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.7 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_PushEvent"("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_PushEvent- Pushes an event onto the event queue 
  13. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  14. <p>
  15. <b>#include
  16. "SDL.h" <p>
  17. </b><b>int <b>SDL_PushEvent</b></b>(<b>SDL_Event *event</b>); 
  18. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  19. <p>
  20. The event queue
  21. can actually be used as a two way communication channel. Not only can events
  22. be read from the queue, but the user can also push their own events onto
  23. it. <b>event</b> is a pointer to the event structure you wish to push onto the
  24. queue. <p>
  25. <blockquote><b>Note:   <p>
  26. Pushing device input events onto the queue doesn't modify
  27. the state of the device within SDL. </blockquote>
  28.  
  29. <h2><a name='sect3' href='#toc3'></b>Return Value</a></h2>
  30. <p>
  31. Returns <b>0</b> on success or
  32. <b>-1</b> if the event couldn't be pushed. 
  33. <h2><a name='sect4' href='#toc4'>Examples</a></h2>
  34. <p>
  35. See <i><b>SDL_Event</b></i>. 
  36. <h2><a name='sect5' href='#toc5'>See Also</a></h2>
  37. <p>
  38. <i><b>SDL_PollEvent</b></i>,
  39. <i><b>SDL_PeepEvents</b></i>, <i><b>SDL_Event</b></i> 
  40. <!--
  41.   
  42.  <p>
  43.  
  44. <hr><p>
  45. <a name='toc'><b>Table of Contents</b></a><p>
  46. <ul>
  47. <li><a name='toc0' href='#sect0'>Name</a></li>
  48. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  49. <li><a name='toc2' href='#sect2'>Description</a></li>
  50. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  51. <li><a name='toc4' href='#sect4'>Examples</a></li>
  52. <li><a name='toc5' href='#sect5'>See Also</a></li>
  53. </ul>
  54. </body>
  55. </html>
  56.