SDL::Event(3) User Contributed Perl Documentation SDL::Event(3)NAME
SDL::Event - a SDL perl extension
SYNOPSIS
use SDL::Event;
my $event = new SDL::Event; # create a new event
$event->pump(); # pump all events from SDL Event Queue
$event->poll(); # Get the top one from the queue
while ($event->wait()) {
my $type = $event->type(); # get event type
# ... handle event
exit if $type == SDL_QUIT;
}
DESCRIPTION
"SDL::Event" offers an object-oriented approach to SDL events. By creating an instance of SDL::Event via new() you can wait for events, and
then determine the type of the event and take an appropriate action.
EXAMPLE
Here is an example of a simple event handler loop routine. See also SDL::App::loop.
sub loop {
my ($self,$href) = @_;
my $event = new SDL::Event;
while ( $event->wait() ) {
# ... insert here your event handling like:
if ( ref($$href{$event->type()}) eq "CODE" ) {
&{$$href{$event->type()}}($event);
$self->sync();
}
}
}
METHODS
new()
Create a new event object.
type()
Returns the type of the event, see list of exported symbols for which are available.
pump()
poll()
wait()
Waits for an event end returns then. Always returns true.
set( type, state )
Set the state for all events of the given event's type
set_unicode( toggle )
Toggle unicode on the event.
set_key_repeat( delay, interval)
Sets the delay and intervall of the key repeat rate (e.g. when a user holds down a key on the keyboard).
active_gain()
active_state()
key_state()
key_sym()
key_name()
key_mod()
key_unicode()
key_scancode()
motion_state()
motion_x()
Returns the motion of the mouse in X direction as an absolute value.
motion_y()
Returns the motion of the mouse in Y direction as an absolute value.
motion_xrel()
Returns the motion of the mouse in X direction as a relative value.
motion_yrel()
Returns the motion of the mouse in Y direction as a relative value.
button_state()
Returns the state of the mouse buttons.
button_x()
button_y()
button()
AUTHOR
David J. Goehrig Documentation by Tels <http://bloodgate.com/>
SEE ALSO
perl SDL::App
perl v5.12.1 2010-07-05 SDL::Event(3)
Check Out this Related Man Page
SDL::App(3) User Contributed Perl Documentation SDL::App(3)NAME
SDL::App - a SDL perl extension
SYNOPSIS
use SDL;
use SDL::Event;
use SDL::App;
my $app = new SDL::App (
-title => 'Application Title',
-width => 640,
-height => 480,
-depth => 32 );
This is the manual way of doing things
my $event = new SDL::Event; # create a new event
$event->pump();
$event->poll();
while ($event->wait()) {
my $type = $event->type(); # get event type
print $type;
exit if $type == SDL_QUIT;
}
An alternative to the manual Event processing is the L<SDL::App::loop> .
DESCRIPTION
SDL::App controls the root window of the of your SDL based application. It extends the SDL::Surface class, and provides an interface to
the window manager oriented functions.
METHODS
new
"SDL::App::new" initializes the SDL, creates a new screen, and initializes some of the window manager properties. "SDL::App::new" takes a
series of named parameters:
o -title
o -icon_title
o -icon
o -width
o -height
o -depth
o -flags
o -resizeable
title
"SDL::App::title" takes 0, 1, or 2 arguments. It returns the current application window title. If one parameter is passed, both the
window title and icon title will be set to its value. If two parameters are passed the window title will be set to the first, and the icon
title to the second.
delay
"SDL::App::delay" takes 1 argument, and will sleep the application for that many ms.
ticks
"SDL::App::ticks" returns the number of ms since the application began.
error
"SDL::App::error" returns the last error message set by the SDL.
resize
"SDL::App::resize" takes a new height and width of the application if the application was originally created with the -resizable option.
fullscreen
"SDL::App::fullscreen" toggles the application in and out of fullscreen mode.
iconify
"SDL::App::iconify" iconifies the applicaiton window.
grab_input
"SDL::App::grab_input" can be used to change the input focus behavior of the application. It takes one argument, which should be one of
the following:
o SDL_GRAB_QUERY
o SDL_GRAB_ON
o SDL_GRAB_OFF
loop
"SDL::App::loop" is a simple event loop method which takes a reference to a hash of event handler subroutines. The keys of the hash must
be SDL event types such as SDL_QUIT(), SDL_KEYDOWN(), and the like. The event method recieves as its parameter the event object used in
the loop.
Example:
my $app = new SDL::App -title => "test.app",
-width => 800,
-height => 600,
-depth => 32;
my %actions = (
SDL_QUIT() => sub { exit(0); },
SDL_KEYDOWN() => sub { print "Key Pressed" },
);
$app->loop(\%actions);
sync
"SDL::App::sync" encapsulates the various methods of syncronizing the screen with the current video buffer. "SDL::App::sync" will do a
fullscreen update, using the double buffer or OpenGL buffer if applicable. This is prefered to calling flip on the application window.
attribute ( attr, [value] )
"SDL::App::attribute" allows one to set and get GL attributes. By passing a value in addition to the attribute selector, the value will be
set. "SDL:::App::attribute" always returns the current value of the given attribute, or croaks on failure.
AUTHOR
David J. Goehrig Kartik Thakore
SEE ALSO
perl SDL::Surface SDL::Event SDL::OpenGL
perl v5.12.1 2010-07-05 SDL::App(3)