5 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
6 # Copyright (C) 2009 Kartik Thakore <kthakore@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:
37 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
46 @ISA = qw(Exporter DynaLoader);
47 @EXPORT = qw( in verify &NULL );
50 # Give our caller SDL::Constant's stuff as well as ours.
54 $self->export_to_level(1, @_);
55 SDL::Constants->export_to_level(1);
59 print "$VERSION" if (defined($ARGV[0]) && ($ARGV[0] eq '--SDLperl'));
69 return 0 unless defined $k;
70 my $r = ((scalar grep { defined $_ && $_ eq $k } @t) <=> 0);
77 my ($options,@valid_options) = @_;
78 for (keys %$options) {
79 croak "Invalid option $_\n" unless in ($_, @valid_options);
89 SDL_perl - Simple DirectMedia Layer for Perl
97 SDL_perl is a package of perl modules that provides both functional and object orient
98 interfaces to the Simple DirectMedia Layer for Perl 5. This package does take some
99 liberties with the SDL API, and attempts to adhere to the spirit of both the SDL
100 and Perl. This document describes the low-level functional SDL_perl API. For the
101 object oriented programming interface please see the documentation provided on a
104 =head1 The SDL Perl 2009 Development Team
110 =head2 Perl Development
113 Name: Breno G. de Oliveira
132 =head1 MacOSX Experimental Usage
134 Please get libsdl packages from Fink
141 =head2 Running SDL Perl Scripts in MacOSX
143 First set the PERL5LIB environment variable to the dependencies of your script
145 %export PERL5LIB=$PERL5LIB:./lib
147 Use the SDLPerl executable made in the bundle and call your scripts
149 %SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl
151 =head1 Functions exported by SDL.pm
155 As with the C language API, SDL_perl initializes the SDL environment through
156 the C<SDL::Init> subroutine. This routine takes a mode flag constructed through
157 the bitwise OR product of the following constants:
184 C<SDL::Init> returns 0 on success, or -1 on error.
188 The last error message set by the SDL library can be retrieved using the subroutine
189 C<SDL::GetError>, which returns a scalar containing the text of the message if any.
193 This subroutine allows an application to delay further operations for atleast a
194 number of milliseconds provided as the argument. The actual delay may be longer
195 than the specified depending on the underlying OS.
199 An application may retrieve the number of milliseconds expired since the initilization
200 of the application through this subroutine. This value resets rougly ever 49 days.
202 =head2 AddTimer(interval,callback,param)
204 C<AddTimer> will register a SDL_NewTimerCallback function to be executed after
205 C<interval> milliseconds, with parameter C<param>. SDL_NewTimerCallback objects
206 can be constructed with the C<NewTimer> subroutine. C<SDL::PerlTimerCallback>
207 will return a valid callback for executing a perl subroutine or closure.
208 This subroutine returns a SDL_TimerID for the newly registered callback, or NULL
211 =head2 NewTimer(interval,subroutine)
213 The C<NewTimer> takes an interval in milliseconds and a reference to a subroutine
214 to call at that interval. The subroutine will be invoked in a void context
215 and accepts no parameters. The callback used is that returned by C<SDL::PerlTimerCallback>.
216 C<NewTimer> returns the SDL_TimerID for the new timer or NULL on error.
218 =head2 RemoveTimer(id)
220 This subroutine taks a SDL_TimerID and removes it from the list of active callbacks.
221 RemoveTimer returns false on failure.
225 This subroutine is depreciated, please use C<NewTimer> or C<AddTimer> instead.
229 C<SDL::CDNumDrives> returns the number of available CD-ROM drives in the system.
233 The subroutine C<SDL::CDName> returns the system specific human readable device name
234 for the given CD-ROM drive.
238 This subroutine opens a CD-ROM drive for access, returning NULL if the drive is busy
239 or otherwise unavailable. On success this subroutine returns a handle to the CD-ROM
242 =head2 CDTrackListing(cd)
244 C<SDL::CDTrackListing> returns a human readable description of a CD-ROM. For each
245 track one line will be produced with the following format:
247 Track index: %d, id %d, %2d.%2d
249 This is provided to ease the creation of human readable descriptions and debugging.
251 =head2 CDTrackId(track)
253 C<CDTrackId> returns the id field of the given SDL_CDtrack structure.
255 =head2 CDTrackType(track)
257 C<CDTrackType> returns the type field of the given SDL_CDtrack structure.
259 =head2 CDTrackLength(track)
261 C<CDTrackLength> returns the length field of the given SDL_CDtrack structure.
263 =head2 CDTrackOffset(track)
265 C<CDTrackOffset> returns the offset field of the given SDL_CDtrack structure.
269 The function C<CDStatus> returns the current status of the given SDL_CDrom.
270 C<CDStatus>'s return values are:
291 =head2 CDPlayTracks(cd,track,tracks,frame,frames)
293 To start playing from an arbitrary portion of a CD, one can provide
294 C<SDL::CDPlayTracks> with a CD, a starting track, the number of tracks,
295 a starting frame, and the number of frames to be played.
297 =head2 CDPlay(cd,track,length)
299 C<SDL::CDPlay> plays the next C<length> tracks starting from C<track>
303 This function will pause CD playback until resume is called.
307 This function will resume CD playback if paused.
311 C<SDL::CDStop> will stop CD playback if playing.
315 This function will eject the CD.
319 This function will release an opened CD.
323 This function return the number of tracks on a CD,
324 it take a SDL_CD as first parameter.
328 This function return the number of the current track on a CD,
329 it take a SDL_CD as first parameter.
333 this function return the frame offset within the current track on a CD.
334 it take a SDL_CD as first parameter.
338 CDtrack stores data on each track on a CD, its fields should be pretty self explainatory.
339 CDtrack take a SDL::CD as input and return a SDL_CDTrack.
343 Pumps the event loop, gathering events from the input devices.
345 PumpEvents gathers all the pending input information from devices and places
346 it on the event queue.
347 Without calls to PumpEvents no events would ever be placed on the queue.
348 Often the need for calls to PumpEvents is hidden from the user
349 since L</ PollEvent> and WaitEvent implicitly call PumpEvents.
350 However, if you are not polling or waiting for events (e.g. you are filtering them),
351 then you must call PumpEvents to force an event queue update.
352 PumpEvents doesn't return any value and doesn't take any parameters.
354 Note: You can only call this function in the thread that set the video mode.
358 Create a new event.It return a SDL::Event.
362 FreeEvent delete the SDL::Event given as first parameter.
363 it doesn't return anything.
367 Polls for currently pending events.
368 If event is not undef, the next event is removed from the queue and returned as a L< SDL::Event>.
369 As this function implicitly calls L</ PumpEvents>, you can only call this function in the thread that set the video mode.
370 it take a SDL::Event as first parameter.
374 Waits indefinitely for the next available event, returning undef if there was an error while waiting for events,
375 a L< SDL::Event> otherwise.
376 If event is not NULL, the next event is removed.
377 As this function implicitly calls L</ PumpEvents>, you can only call this function in the thread that set the video mode.
378 WaitEvent take a SDL::Event as first parameter.
382 This function allows you to set the state of processing certain event types.
384 it take an event type as first argument, and a state as second.
386 If state is set to SDL_IGNORE, that event type will be automatically
387 dropped from the event queue and will not be filtered.
388 If state is set to SDL_ENABLE, that event type will be processed
390 If state is set to SDL_QUERY, SDL_EventState will return the current
391 processing state of the specified event type.
393 A list of event types can be found in the L</ SDL_Event section>.
395 it returns a state(?).
411 =head2 MOUSEBUTTONDOWN
421 EventType return the type of the SDL::Event given as first parameter.
423 =head2 ActiveEventGain
425 ActiveEventGain return the active gain from the SDL::Event given as first parameter.
426 see L</ SDL::Event> for more informations about the active state.
428 =head2 ActiveEventState
430 ActiveEventState return the active state from the SDL::Event given as first parameter.
431 see L</ SDL::Event> for more informations about the active state.
441 KeyEventState return the active key state from the SDL::Event given as first parameter.
442 see L</ SDL::Event> for me more informations about the active key.
444 =head2 SDLK_BACKSPACE
466 =head2 SDLK_AMPERSAND
470 =head2 SDLK_LEFTPAREN
472 =head2 SDLK_RIGHTPAREN
508 =head2 SDLK_SEMICOLON
520 =head2 SDLK_LEFTBRACKET
522 =head2 SDLK_BACKSLASH
524 =head2 SDLK_RIGHTBRACKET
528 =head2 SDLK_UNDERSCORE
530 =head2 SDLK_BACKQUOTE
606 =head2 SDLK_KP_PERIOD
608 =head2 SDLK_KP_DIVIDE
610 =head2 SDLK_KP_MULTIPLY
618 =head2 SDLK_KP_EQUALS
672 =head2 SDLK_SCROLLOCK
736 KeyEventSym return the key pressed/released information from the SDL::Event given as first parameter.
737 see L</ SDL::Event> for more informations about the keyboard events.
741 KeyEventMod return the mod keys pressed information from the SDL::Event given as first parameter.
742 see L</ SDL::Event> for more informations about the keyboard events.
744 =head2 KeyEventUnicode
746 KeyEventMod return the unicode translated keys pressed/released information from the SDL::Event given as first parameter.
747 see L</ SDL::Event> for more informations about the keyboard events.
749 =head2 KeyEventScanCode
751 =head2 MouseMotionState
757 =head2 MouseMotionXrel
759 =head2 MouseMotionYrel
761 =head2 MouseButtonState
773 =head2 EnableKeyRepeat
781 =head2 CreateRGBSurface
783 =head2 CreateRGBSurfaceFrom
789 =head2 SurfacePalette
791 =head2 SurfaceBitsPerPixel