Mercurial > sdl-ios-xcode
diff docs/html/sdlpumpevents.html @ 0:74212992fb08
Initial revision
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Thu, 26 Apr 2001 16:45:43 +0000 |
parents | |
children | 55f1f1b3e27d |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/sdlpumpevents.html Thu Apr 26 16:45:43 2001 +0000 @@ -0,0 +1,236 @@ +<HTML +><HEAD +><TITLE +>SDL_PumpEvents</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.61 +"><LINK +REL="HOME" +TITLE="SDL Library Documentation" +HREF="index.html"><LINK +REL="UP" +TITLE="Event Functions." +HREF="eventfunctions.html"><LINK +REL="PREVIOUS" +TITLE="Event Functions." +HREF="eventfunctions.html"><LINK +REL="NEXT" +TITLE="SDL_PeepEvents" +HREF="sdlpeepevents.html"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFF8DC" +TEXT="#000000" +LINK="#0000ee" +VLINK="#551a8b" +ALINK="#ff0000" +><DIV +CLASS="NAVHEADER" +><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>SDL Library Documentation</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="eventfunctions.html" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +></TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="sdlpeepevents.html" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><H1 +><A +NAME="SDLPUMPEVENTS" +>SDL_PumpEvents</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN4773" +></A +><H2 +>Name</H2 +>SDL_PumpEvents -- Pumps the event loop, gathering events from the input devices.</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN4776" +></A +><H2 +>Synopsis</H2 +><DIV +CLASS="FUNCSYNOPSIS" +><A +NAME="AEN4777" +></A +><P +></P +><PRE +CLASS="FUNCSYNOPSISINFO" +>#include "SDL.h"</PRE +><P +><CODE +><CODE +CLASS="FUNCDEF" +>void <B +CLASS="FSFUNC" +>SDL_PumpEvents</B +></CODE +>(void);</CODE +></P +><P +></P +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN4783" +></A +><H2 +>Description</H2 +><P +>Pumps the event loop, gathering events from the input devices.</P +><P +><TT +CLASS="FUNCTION" +>SDL_PumpEvents</TT +> gathers all the pending input information from devices and places it on the event queue. Without calls to <TT +CLASS="FUNCTION" +>SDL_PumpEvents</TT +> no events would ever be placed on the queue. Often calls the need for <TT +CLASS="FUNCTION" +>SDL_PumpEvents</TT +> is hidden from the user since <A +HREF="sdlpollevent.html" +><TT +CLASS="FUNCTION" +>SDL_PollEvent</TT +></A +> and <A +HREF="sdlwaitevent.html" +><TT +CLASS="FUNCTION" +>SDL_WaitEvent</TT +></A +> implicitly call <TT +CLASS="FUNCTION" +>SDL_PumpEvents</TT +>. However, if you are not polling or waiting for events (e.g. your filtering them), then you must call <TT +CLASS="FUNCTION" +>SDL_PumpEvents</TT +> to force an event queue update.</P +><DIV +CLASS="NOTE" +><BLOCKQUOTE +CLASS="NOTE" +><P +><B +>Note: </B +>You can only call this function in the thread that set the video mode.</P +></BLOCKQUOTE +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN4798" +></A +><H2 +>See Also</H2 +><P +><A +HREF="sdlpollevent.html" +><TT +CLASS="FUNCTION" +>SDL_PollEvent</TT +></A +></P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="eventfunctions.html" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="sdlpeepevents.html" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Event Functions.</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="eventfunctions.html" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>SDL_PeepEvents</TD +></TR +></TABLE +></DIV +></BODY +></HTML +> \ No newline at end of file