From: magnet <magnet@ci0.org>
Date: Sat, 19 Sep 2009 15:20:12 +0000 (+0200)
Subject: test Doc for PumpEvents
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=4e2f93c3d07cd235f82c721e3028b5900928401a;p=sdlgit%2FSDL_perl.git

test Doc for PumpEvents
---

diff --git a/lib/SDL.pm b/lib/SDL.pm
index d51344b..f977011 100644
--- a/lib/SDL.pm
+++ b/lib/SDL.pm
@@ -279,6 +279,18 @@ This function will release an opened CD.
 
 =head2 PumpEvents 
 
+Pumps the event loop, gathering events from the input devices.
+
+PumpEvents gathers all the pending input information from devices and places
+it on the event queue.
+Without calls to PumpEvents no events would ever be placed on the queue.
+Often the need for calls to PumpEvents is hidden from the user 
+since L</ PollEvent> and WaitEvent implicitly call PumpEvents. 
+However, if you are not polling or waiting for events (e.g. you are filtering them), 
+then you must call PumpEvents to force an event queue update.
+
+Note: You can only call this function in the thread that set the video mode. 
+
 =head2 NewEvent 
 
 =head2 FreeEvent
@@ -665,4 +677,4 @@ This function will release an opened CD.
 
 =head2 SurfaceBitsPerPixel 
 
-=head2 SurfaceBy
\ No newline at end of file
+=head2 SurfaceBy