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:
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);
57 $VERSION = '2.2.2.15';
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
106 As with the C language API, SDL_perl initializes the SDL environment through
107 the C<SDL::Init> subroutine. This routine takes a mode flag constructed through
108 the bitwise OR product of the following functions:
135 C<SDL::Init> returns 0 on success, or -1 on error.
139 The last error message set by the SDL library can be retrieved using the subroutine
140 C<SDL::GetError>, which returns a scalar containing the text of the message if any.
144 This subroutine allows an application to delay further operations for atleast a
145 number of milliseconds provided as the argument. The actual delay may be longer
146 than the specified depending on the underlying OS.
150 An application may retrieve the number of milliseconds expired since the initilization
151 of the application through this subroutine. This value resets rougly ever 49 days.
153 =head2 AddTimer(interval,callback,param)
155 C<AddTimer> will register a SDL_NewTimerCallback function to be executed after
156 C<interval> milliseconds, with parameter C<param>. SDL_NewTimerCallback objects
157 can be constructed with the C<NewTimer> subroutine. C<SDL::PerlTimerCallback>
158 will return a valid callback for executing a perl subroutine or closure.
159 This subroutine returns a SDL_TimerID for the newly registered callback, or NULL
162 =head2 NewTimer(interval,subroutine)
164 The C<NewTimer> takes an interval in milliseconds and a reference to a subroutine
165 to call at that interval. The subroutine will be invoked in a void context
166 and accepts no parameters. The callback used is that returned by C<SDL::PerlTimerCallback>.
167 C<NewTimer> returns the SDL_TimerID for the new timer or NULL on error.
169 =head2 RemoveTimer(id)
171 This subroutine taks a SDL_TimerID and removes it from the list of active callbacks.
172 RemoveTimer returns false on failure.
176 This subroutine is depreciated, please use C<NewTimer> or C<AddTimer> instead.
180 C<SDL::CDNumDrives> returns the number of available CD-ROM drives in the system.
184 The subroutine C<SDL::CDName> returns the system specific human readable device name
185 for the given CD-ROM drive.
189 This subroutine opens a CD-ROM drive for access, returning NULL if the drive is busy
190 or otherwise unavailable. On success this subroutine returns a handle to the CD-ROM
193 =head2 CDTrackListing(cd)
195 C<SDL::CDTrackListing> returns a human readable description of a CD-ROM. For each
196 track one line will be produced with the following format:
198 Track index: %d, id %d, %2d.%2d
200 This is provided to ease the creation of human readable descriptions and debugging.
202 =head2 CDTrackId(track)
204 C<CDTrackId> returns the id field of the given SDL_CDtrack structure.
206 =head2 CDTrackType(track)
208 C<CDTrackType> returns the type field of the given SDL_CDtrack structure.
210 =head2 CDTrackLength(track)
212 C<CDTrackLength> returns the length field of the given SDL_CDtrack structure.
214 =head2 CDTrackOffset(track)
216 C<CDTrackOffset> returns the offset field of the given SDL_CDtrack structure.
220 The function C<CDStatus> returns the current status of the given SDL_CDrom.
221 C<CDStatus>'s return values are:
242 =head2 CDPlayTracks(cd,track,tracks,frame,frames)
244 To start playing from an arbitrary portion of a CD, one can provide
245 C<SDL::CDPlayTracks> with a CD, a starting track, the number of tracks,
246 a starting frame, and the number of frames to be played.
248 =head2 CDPlay(cd,track,length)
250 C<SDL::CDPlay> plays the next C<length> tracks starting from C<track>
254 This function will pause CD playback until resume is called.
258 This function will resume CD playback if paused.
262 C<SDL::CDStop> will stop CD playback if playing.
266 This function will eject the CD
270 This function will release an opened CD.
306 =head2 MOUSEBUTTONDOWN
316 =head2 ActiveEventGain
318 =head2 ActiveEventState
328 =head2 SDLK_BACKSPACE
350 =head2 SDLK_AMPERSAND
354 =head2 SDLK_LEFTPAREN
356 =head2 SDLK_RIGHTPAREN
392 =head2 SDLK_SEMICOLON
404 =head2 SDLK_LEFTBRACKET
406 =head2 SDLK_BACKSLASH
408 =head2 SDLK_RIGHTBRACKET
412 =head2 SDLK_UNDERSCORE
414 =head2 SDLK_BACKQUOTE
490 =head2 SDLK_KP_PERIOD
492 =head2 SDLK_KP_DIVIDE
494 =head2 SDLK_KP_MULTIPLY
502 =head2 SDLK_KP_EQUALS
556 =head2 SDLK_SCROLLOCK
622 =head2 KeyEventUnicode
624 =head2 KeyEventScanCode
626 =head2 MouseMotionState
632 =head2 MouseMotionXrel
634 =head2 MouseMotionYrel
636 =head2 MouseButtonState
648 =head2 EnableKeyRepeat
656 =head2 CreateRGBSurface
658 =head2 CreateRGBSurfaceFrom
664 =head2 SurfacePalette
666 =head2 SurfaceBitsPerPixel
668 =head2 SurfaceBytesPerPixel
686 =head2 SurfaceColorKey
706 =head2 GetVideoSurface
734 =head2 PaletteNColors
766 =head2 MapRGB (surface,r,g,b)
768 C<SDL::MapRGB> translates the composite red (r), green (g), blue (b)
769 colors according to the given surface to a interger color value. This
770 integer can be used in functions like C<SDL::FillRect>, and is not
771 the same as the format independent Color object returned by C<SDL::NewColor>.
773 =head2 MapRGBA (surface,r,g,b,a)
775 C<SDL::MapRGBA> works as C<SDL::MapRGB> but takes an additional alpha (a)
776 component for semi-transperant colors.
798 =head2 FillRect(surface,rect,color)
800 C<SDL::FillRect> draws a solid rectangle of color on the given surface.
801 If the rectangle is NULL, the entire surface will be painted.
841 =head2 ConvertAudioData
857 =head2 MIX_MAX_VOLUME
859 =head2 MIX_DEFAULT_FREQUENCY
861 =head2 MIX_DEFAULT_FORMAT
863 =head2 MIX_DEFAULT_CHANNELS
867 =head2 MIX_FADING_OUT
873 =head2 MixAllocateChannels
881 =head2 MixQuickLoadWAV
887 =head2 MixSetPostMixCallback
889 =head2 MixSetMusicHook
891 =head2 MixSetMusicFinishedHook
893 =head2 MixGetMusicHookData
895 =head2 MixReverseChannels
897 =head2 MixGroupChannel
899 =head2 MixGroupChannels
901 =head2 MixGroupAvailable
905 =head2 MixGroupOldest
909 =head2 MixPlayChannel
911 =head2 MixPlayChannelTimed
915 =head2 MixFadeInChannel
917 =head2 MixFadeInChannelTimed
919 =head2 MixFadeInMusic
923 =head2 MixVolumeChunk
925 =head2 MixVolumeMusic
927 =head2 MixHaltChannel
933 =head2 MixExpireChannel
935 =head2 MixFadeOutChannel
937 =head2 MixFadeOutGroup
939 =head2 MixFadeOutMusic
941 =head2 MixFadingMusic
943 =head2 MixFadingChannel
953 =head2 MixResumeMusic
955 =head2 MixRewindMusic
957 =head2 MixPausedMusic
961 =head2 MixPlayingMusic
981 =head2 GL_ACCUM_RED_SIZE
983 =head2 GL_ACCUM_GREEN_SIZE
985 =head2 GL_ACCUM_BLUE_SIZE
987 =head2 GL_ACCUM_ALPHA_SIZE
989 =head2 GL_BUFFER_SIZE
993 =head2 GL_STENCIL_SIZE
995 =head2 GL_DOUBLEBUFFER
997 =head2 GL_SetAttribute
999 =head2 GL_GetAttribute
1001 =head2 GL_SwapBuffers
1011 =head2 JoystickOpened
1013 =head2 JoystickIndex
1015 =head2 JoystickNumAxes
1017 =head2 JoystickNumBalls
1019 =head2 JoystickNumHats
1021 =head2 JoystickNumButtons
1023 =head2 JoystickUpdate
1025 =head2 JoystickGetAxis
1027 =head2 JoystickGetHat
1029 =head2 JoystickGetButton
1031 =head2 JoystickGetBall
1033 =head2 JoystickClose
1037 David J. Goehrig 2.1.3
1038 Kartik Thakore 2.2.0 +
1042 David J. Goehrig, Wayne Keenan, Guillaume Cottenceau, Kartik Thakore
1046 perl(1) SDL::App(3) SDL::Surface(3) SDL::Event(3) SDL::Rect(3)
1047 SDL::Palette(3) SDL::Mixer(3) SDL::Cdrom(3)