man SDL::App () - a SDL perl extension

NAME

SDL::App - a SDL perl extension

SYNOPSIS

        my $app = new SDL::App (
                -title => 'Application Title',
                -width => 640, 
                -height => 480,
                -depth => 32 );

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.

EXPORTS

        SDL_TEXTWIDTH

METHODS

new

CWSDL::App::new initializes the SDL, creates a new screen, and initializes some of the window manager properties. CWSDL::App::new takes a series of named parameters:

•
-title
•
-icon_title
•
-icon
•
-width
•
-height
•
-depth
•
-flags
•
-resizeable

title

CWSDL::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

CWSDL::App::delay takes 1 argument, and will sleep the application for that many ms.

ticks

CWSDL::App::ticks returns the number of ms since the application began.

error

CWSDL::App::error returns the last error message set by the SDL.

resize

CWSDL::App::resize takes a new height and width of the application if the application was originally created with the -resizable option.

fullscreen

CWSDL::App::fullscreen toggles the application in and out of fullscreen mode.

iconify

CWSDL::App::iconify iconifies the applicaiton window.

grab_input

CWSDL::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:

* SDL_GRAB_QUERY
* SDL_GRAB_ON
* SDL_GRAB_OFF

loop

CWSDL::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

CWSDL::App::sync encapsulates the various methods of syncronizing the screen with the current video buffer. CWSDL::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] )

CWSDL::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. CWSDL:::App::attribute always returns the current value of the given attribute, or dies on failure.

AUTHOR

David J. Goehrig

SEE ALSO

perl SDL::Surface SDL::Event SDL::OpenGL