5 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
7 # ------------------------------------------------------------------------------
9 # This library is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public
11 # License as published by the Free Software Foundation; either
12 # version 2.1 of the License, or (at your option) any later version.
14 # This library is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with this library; if not, write to the Free Software
21 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 # ------------------------------------------------------------------------------
25 # Please feel free to send questions, suggestions or improvements to:
41 my $class = ref($proto) || $proto;
43 $self = \SDL::NewEvent();
50 SDL::FreeEvent($$self);
56 SDL::SetEventType($$self,$_[0]);
58 return SDL::EventType($$self);
67 return SDL::PollEvent($$self);
72 return SDL::PushEvent($$self);
77 return SDL::WaitEvent($$self);
83 return SDL::EventState($self->type(),$state);
89 return SDL::EnableUnicode($toggle);
96 return SDL::EnableKeyRepeat($delay,$interval);
101 return SDL::ActiveEventGain($$self);
106 return SDL::ActiveEventState($$self);
111 return SDL::KeyEventState($$self);
116 return SDL::KeyEventSym($$self);
121 return SDL::GetKeyName(SDL::KeyEventSym($$self));
126 return SDL::KeyEventMod($$self);
131 return SDL::KeyEventUnicode($$self);
136 return SDL::KeyEventScanCode($$self);
141 return SDL::MouseMotionState($$self);
146 return SDL::MouseMotionX($$self);
151 return SDL::MouseMotionY($$self);
156 return SDL::MouseMotionXrel($$self);
161 return SDL::MouseMotionYrel($$self);
166 return SDL::MouseButtonState($$self);
171 return SDL::MouseButtonX($$self);
176 return SDL::MouseButtonY($$self);
181 return SDL::MouseButton($$self);
186 SDL::ResizeEventW($$self);
191 SDL::ResizeEventH($$self);
202 SDL::Event - a SDL perl extension
207 my $event = new SDL::Event; # create a new event
208 $event->pump(); # pump all events from SDL Event Queue
209 $event->poll(); # Get the top one from the queue
210 while ($event->wait()) {
211 my $type = $event->type(); # get event type
213 exit if $type == SDL_QUIT;
218 C<SDL::Event> offers an object-oriented approach to SDL events. By creating
219 an instance of SDL::Event via new() you can wait for events, and then determine
220 the type of the event and take an appropriate action.
224 Here is an example of a simple event handler loop routine.
225 See also L<SDL::App::loop>.
228 my ($self,$href) = @_;
229 my $event = new SDL::Event;
230 while ( $event->wait() ) {
231 # ... insert here your event handling like:
232 if ( ref($$href{$event->type()}) eq "CODE" ) {
233 &{$$href{$event->type()}}($event);
243 Create a new event object.
247 Returns the type of the event, see list of exported symbols for which are
256 Waits for an event end returns then. Always returns true.
258 =head2 set( type, state )
260 Set the state for all events of the given event's type
262 =head2 set_unicode( toggle )
264 Toggle unicode on the event.
266 =head2 set_key_repeat( delay, interval)
268 Sets the delay and intervall of the key repeat rate (e.g. when a user
269 holds down a key on the keyboard).
273 =head2 active_state()
285 =head2 key_scancode()
287 =head2 motion_state()
291 Returns the motion of the mouse in X direction as an absolute value.
295 Returns the motion of the mouse in Y direction as an absolute value.
299 Returns the motion of the mouse in X direction as a relative value.
303 Returns the motion of the mouse in Y direction as a relative value.
305 =head2 button_state()
307 Returns the state of the mouse buttons.
318 Documentation by Tels <http://bloodgate.com/>