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
127 =head1 MacOSX Experimental Usage
129 Please get libsdl packages from Fink
136 =head2 Running SDL Perl Scripts in MacOSX
138 First set the PERL5LIB environment variable to the dependencies of your script
140 %export PERL5LIB=$PERL5LIB:./lib
142 Use the SDLPerl executable made in the bundle and call your scripts
144 %SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl
146 =head1 Functions exported by SDL.pm
150 As with the C language API, SDL_perl initializes the SDL environment through
151 the C<SDL::Init> subroutine. This routine takes a mode flag constructed through
152 the bitwise OR product of the following functions:
179 C<SDL::Init> returns 0 on success, or -1 on error.
183 The last error message set by the SDL library can be retrieved using the subroutine
184 C<SDL::GetError>, which returns a scalar containing the text of the message if any.
188 This subroutine allows an application to delay further operations for atleast a
189 number of milliseconds provided as the argument. The actual delay may be longer
190 than the specified depending on the underlying OS.
194 An application may retrieve the number of milliseconds expired since the initilization
195 of the application through this subroutine. This value resets rougly ever 49 days.
197 =head2 AddTimer(interval,callback,param)
199 C<AddTimer> will register a SDL_NewTimerCallback function to be executed after
200 C<interval> milliseconds, with parameter C<param>. SDL_NewTimerCallback objects
201 can be constructed with the C<NewTimer> subroutine. C<SDL::PerlTimerCallback>
202 will return a valid callback for executing a perl subroutine or closure.
203 This subroutine returns a SDL_TimerID for the newly registered callback, or NULL
206 =head2 NewTimer(interval,subroutine)
208 The C<NewTimer> takes an interval in milliseconds and a reference to a subroutine
209 to call at that interval. The subroutine will be invoked in a void context
210 and accepts no parameters. The callback used is that returned by C<SDL::PerlTimerCallback>.
211 C<NewTimer> returns the SDL_TimerID for the new timer or NULL on error.
213 =head2 RemoveTimer(id)
215 This subroutine taks a SDL_TimerID and removes it from the list of active callbacks.
216 RemoveTimer returns false on failure.
220 This subroutine is depreciated, please use C<NewTimer> or C<AddTimer> instead.
224 C<SDL::CDNumDrives> returns the number of available CD-ROM drives in the system.
228 The subroutine C<SDL::CDName> returns the system specific human readable device name
229 for the given CD-ROM drive.
233 This subroutine opens a CD-ROM drive for access, returning NULL if the drive is busy
234 or otherwise unavailable. On success this subroutine returns a handle to the CD-ROM
237 =head2 CDTrackListing(cd)
239 C<SDL::CDTrackListing> returns a human readable description of a CD-ROM. For each
240 track one line will be produced with the following format:
242 Track index: %d, id %d, %2d.%2d
244 This is provided to ease the creation of human readable descriptions and debugging.
246 =head2 CDTrackId(track)
248 C<CDTrackId> returns the id field of the given SDL_CDtrack structure.
250 =head2 CDTrackType(track)
252 C<CDTrackType> returns the type field of the given SDL_CDtrack structure.
254 =head2 CDTrackLength(track)
256 C<CDTrackLength> returns the length field of the given SDL_CDtrack structure.
258 =head2 CDTrackOffset(track)
260 C<CDTrackOffset> returns the offset field of the given SDL_CDtrack structure.
264 The function C<CDStatus> returns the current status of the given SDL_CDrom.
265 C<CDStatus>'s return values are:
286 =head2 CDPlayTracks(cd,track,tracks,frame,frames)
288 To start playing from an arbitrary portion of a CD, one can provide
289 C<SDL::CDPlayTracks> with a CD, a starting track, the number of tracks,
290 a starting frame, and the number of frames to be played.
292 =head2 CDPlay(cd,track,length)
294 C<SDL::CDPlay> plays the next C<length> tracks starting from C<track>
298 This function will pause CD playback until resume is called.
302 This function will resume CD playback if paused.
306 C<SDL::CDStop> will stop CD playback if playing.
310 This function will eject the CD.
314 This function will release an opened CD.
318 This function return the number of tracks on a CD,
319 it take a SDL_CD as first parameter.
323 This function return the number of the current track on a CD,
324 it take a SDL_CD as first parameter.
328 this function return the frame offset within the current track on a CD.
329 it take a SDL_CD as first parameter.
333 CDtrack stores data on each track on a CD, its fields should be pretty self explainatory.
334 CDtrack take a SDL::CD as input and return a SDL_CDTrack.
338 Pumps the event loop, gathering events from the input devices.
340 PumpEvents gathers all the pending input information from devices and places
341 it on the event queue.
342 Without calls to PumpEvents no events would ever be placed on the queue.
343 Often the need for calls to PumpEvents is hidden from the user
344 since L</ PollEvent> and WaitEvent implicitly call PumpEvents.
345 However, if you are not polling or waiting for events (e.g. you are filtering them),
346 then you must call PumpEvents to force an event queue update.
347 PumpEvents doesn't return any value and doesn't take any parameters.
349 Note: You can only call this function in the thread that set the video mode.
353 Create a new event.It return a SDL::Event.
357 FreeEvent delete the SDL::Event given as first parameter.
358 it doesn't return anything.
362 Polls for currently pending events.
363 If event is not undef, the next event is removed from the queue and returned as a L< SDL::Event>.
364 As this function implicitly calls L</ PumpEvents>, you can only call this function in the thread that set the video mode.
365 it take a SDL::Event as first parameter.
369 Waits indefinitely for the next available event, returning undef if there was an error while waiting for events,
370 a L< SDL::Event> otherwise.
371 If event is not NULL, the next event is removed.
372 As this function implicitly calls L</ PumpEvents>, you can only call this function in the thread that set the video mode.
373 WaitEvent take a SDL::Event as first parameter.
377 This function allows you to set the state of processing certain event types.
379 it take an event type as first argument, and a state as second.
381 If state is set to SDL_IGNORE, that event type will be automatically
382 dropped from the event queue and will not be filtered.
383 If state is set to SDL_ENABLE, that event type will be processed
385 If state is set to SDL_QUERY, SDL_EventState will return the current
386 processing state of the specified event type.
388 A list of event types can be found in the L</ SDL_Event section>.
390 it returns a state(?).
406 =head2 MOUSEBUTTONDOWN
416 EventType return the type of the SDL::Event given as first parameter.
418 =head2 ActiveEventGain
420 ActiveEventGain return the active gain from the SDL::Event given as first parameter.
421 see L</ SDL::Event> for more informations about the active state.
423 =head2 ActiveEventState
425 ActiveEventState return the active state from the SDL::Event given as first parameter.
426 see L</ SDL::Event> for more informations about the active state.
436 KeyEventState return the active key state from the SDL::Event given as first parameter.
437 see L</ SDL::Event> for me more informations about the active key.
439 =head2 SDLK_BACKSPACE
461 =head2 SDLK_AMPERSAND
465 =head2 SDLK_LEFTPAREN
467 =head2 SDLK_RIGHTPAREN
503 =head2 SDLK_SEMICOLON
515 =head2 SDLK_LEFTBRACKET
517 =head2 SDLK_BACKSLASH
519 =head2 SDLK_RIGHTBRACKET
523 =head2 SDLK_UNDERSCORE
525 =head2 SDLK_BACKQUOTE
601 =head2 SDLK_KP_PERIOD
603 =head2 SDLK_KP_DIVIDE
605 =head2 SDLK_KP_MULTIPLY
613 =head2 SDLK_KP_EQUALS
667 =head2 SDLK_SCROLLOCK
731 KeyEventSym return the key pressed/released information from the SDL::Event given as first parameter.
732 see L</ SDL::Event> for more informations about the keyboard events.
736 KeyEventMod return the mod keys pressed information from the SDL::Event given as first parameter.
737 see L</ SDL::Event> for more informations about the keyboard events.
739 =head2 KeyEventUnicode
741 KeyEventMod return the unicode translated keys pressed/released information from the SDL::Event given as first parameter.
742 see L</ SDL::Event> for more informations about the keyboard events.
744 =head2 KeyEventScanCode
746 =head2 MouseMotionState
752 =head2 MouseMotionXrel
754 =head2 MouseMotionYrel
756 =head2 MouseButtonState
768 =head2 EnableKeyRepeat
776 =head2 CreateRGBSurface
778 =head2 CreateRGBSurfaceFrom
784 =head2 SurfacePalette
786 =head2 SurfaceBitsPerPixel