Mercurial > sdl-ios-xcode

<HTML
><HEAD
><TITLE
>SDL_PumpEvents</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><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
SUMMARY="Header navigation 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"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlpeepevents.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLPUMPEVENTS"
></A
>SDL_PumpEvents</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5387"
></A
><H2
>Name</H2
>SDL_PumpEvents&nbsp;--&nbsp;Pumps the event loop, gathering events from the input devices.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5390"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN5391"
></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="AEN5397"
></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. you are 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="AEN5412"
></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
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="eventfunctions.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlpeepevents.html"
ACCESSKEY="N"
>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"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_PeepEvents</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
author	Sam Lantinga <slouken@libsdl.org>
date	Thu, 07 May 2009 12:40:16 +0000
parents	355632dca928
children