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 );
53 print "$VERSION" if (defined($ARGV[0]) && ($ARGV[0] eq '--SDLperl'));
63 (scalar grep { defined $_ && $_ eq $k } @t) <=> 0;
67 my ($options,@valid_options) = @_;
68 for (keys %$options) {
69 croak "Invalid option $_\n" unless in ($_, @valid_options);
79 SDL_perl - Simple DirectMedia Layer for Perl
87 SDL_perl is a package of perl modules that provides both functional and object orient
88 interfaces to the Simple DirectMedia Layer for Perl 5. This package does take some
89 liberties with the SDL API, and attempts to adhere to the spirit of both the SDL
90 and Perl. This document describes the low-level functional SDL_perl API. For the
91 object oriented programming interface please see the documentation provided on a
96 As with the C language API, SDL_perl initializes the SDL environment through
97 the C<SDL::Init> subroutine. This routine takes a mode flag constructed through
98 the bitwise OR product of the following functions:
124 C<SDL::Init> returns 0 on success, or -1 on error.
128 The last error message set by the SDL library can be retrieved using the subroutine
129 C<SDL::GetError>, which returns a scalar containing the text of the message if any.
133 This subroutine allows an application to delay further operations for atleast a
134 number of milliseconds provided as the argument. The actual delay may be longer
135 than the specified depending on the underlying OS.
139 An application may retrieve the number of milliseconds expired since the initilization
140 of the application through this subroutine. This value resets rougly ever 49 days.
142 =head2 AddTimer(interval,callback,param)
144 C<AddTimer> will register a SDL_NewTimerCallback function to be executed after
145 C<interval> milliseconds, with parameter C<param>. SDL_NewTimerCallback objects
146 can be constructed with the C<NewTimer> subroutine. C<SDL::PerlTimerCallback>
147 will return a valid callback for executing a perl subroutine or closure.
148 This subroutine returns a SDL_TimerID for the newly registered callback, or NULL
151 =head2 NewTimer(interval,subroutine)
153 The C<NewTimer> takes an interval in milliseconds and a reference to a subroutine
154 to call at that interval. The subroutine will be invoked in a void context
155 and accepts no parameters. The callback used is that returned by C<SDL::PerlTimerCallback>.
156 C<NewTimer> returns the SDL_TimerID for the new timer or NULL on error.
158 =head2 RemoveTimer(id)
160 This subroutine taks a SDL_TimerID and removes it from the list of active callbacks.
161 RemoveTimer returns false on failure.
165 This subroutine is depreciated, please use C<NewTimer> or C<AddTimer> instead.
169 C<SDL::CDNumDrives> returns the number of available CD-ROM drives in the system.
173 The subroutine C<SDL::CDName> returns the system specific human readable device name
174 for the given CD-ROM drive.
178 This subroutine opens a CD-ROM drive for access, returning NULL if the drive is busy
179 or otherwise unavailable. On success this subroutine returns a handle to the CD-ROM
182 =head2 CDTrackListing(cd)
184 C<SDL::CDTrackListing> returns a human readable description of a CD-ROM. For each
185 track one line will be produced with the following format:
187 Track index: %d, id %d, %2d.%2d
189 This is provided to ease the creation of human readable descriptions and debugging.
191 =head2 CDTrackId(track)
193 C<CDTrackId> returns the id field of the given SDL_CDtrack structure.
195 =head2 CDTrackType(track)
197 C<CDTrackType> returns the type field of the given SDL_CDtrack structure.
199 =head2 CDTrackLength(track)
201 C<CDTrackLength> returns the length field of the given SDL_CDtrack structure.
203 =head2 CDTrackOffset(track)
205 C<CDTrackOffset> returns the offset field of the given SDL_CDtrack structure.
209 The function C<CDStatus> returns the current status of the given SDL_CDrom.
210 C<CDStatus>'s return values are:
231 =head2 CDPlayTracks(cd,track,tracks,frame,frames)
233 To start playing from an arbitrary portion of a CD, one can provide
234 C<SDL::CDPlayTracks> with a CD, a starting track, the number of tracks,
235 a starting frame, and the number of frames to be played.
237 =head2 CDPlay(cd,track,length)
239 C<SDL::CDPlay> plays the next C<length> tracks starting from C<track>
243 This function will pause CD playback until resume is called.
247 This function will resume CD playback if paused.
251 C<SDL::CDStop> will stop CD playback if playing.
255 This function will eject the CD
259 This function will release an opened CD.
295 =head2 MOUSEBUTTONDOWN
305 =head2 ActiveEventGain
307 =head2 ActiveEventState
317 =head2 SDLK_BACKSPACE
339 =head2 SDLK_AMPERSAND
343 =head2 SDLK_LEFTPAREN
345 =head2 SDLK_RIGHTPAREN
381 =head2 SDLK_SEMICOLON
393 =head2 SDLK_LEFTBRACKET
395 =head2 SDLK_BACKSLASH
397 =head2 SDLK_RIGHTBRACKET
401 =head2 SDLK_UNDERSCORE
403 =head2 SDLK_BACKQUOTE
479 =head2 SDLK_KP_PERIOD
481 =head2 SDLK_KP_DIVIDE
483 =head2 SDLK_KP_MULTIPLY
491 =head2 SDLK_KP_EQUALS
545 =head2 SDLK_SCROLLOCK
611 =head2 KeyEventUnicode
613 =head2 KeyEventScanCode
615 =head2 MouseMotionState
621 =head2 MouseMotionXrel
623 =head2 MouseMotionYrel
625 =head2 MouseButtonState
637 =head2 EnableKeyRepeat
645 =head2 CreateRGBSurface
647 =head2 CreateRGBSurfaceFrom
653 =head2 SurfacePalette
655 =head2 SurfaceBitsPerPixel
657 =head2 SurfaceBytesPerPixel
675 =head2 SurfaceColorKey
695 =head2 GetVideoSurface
723 =head2 PaletteNColors
755 =head2 MapRGB (surface,r,g,b)
757 C<SDL::MapRGB> translates the composite red (r), green (g), blue (b)
758 colors according to the given surface to a interger color value. This
759 integer can be used in functions like C<SDL::FillRect>, and is not
760 the same as the format independent Color object returned by C<SDL::NewColor>.
762 =head2 MapRGBA (surface,r,g,b,a)
764 C<SDL::MapRGBA> works as C<SDL::MapRGB> but takes an additional alpha (a)
765 component for semi-transperant colors.
787 =head2 FillRect(surface,rect,color)
789 C<SDL::FillRect> draws a solid rectangle of color on the given surface.
790 If the rectangle is NULL, the entire surface will be painted.
830 =head2 ConvertAudioData
846 =head2 MIX_MAX_VOLUME
848 =head2 MIX_DEFAULT_FREQUENCY
850 =head2 MIX_DEFAULT_FORMAT
852 =head2 MIX_DEFAULT_CHANNELS
856 =head2 MIX_FADING_OUT
862 =head2 MixAllocateChannels
870 =head2 MixQuickLoadWAV
876 =head2 MixSetPostMixCallback
878 =head2 MixSetMusicHook
880 =head2 MixSetMusicFinishedHook
882 =head2 MixGetMusicHookData
884 =head2 MixReverseChannels
886 =head2 MixGroupChannel
888 =head2 MixGroupChannels
890 =head2 MixGroupAvailable
894 =head2 MixGroupOldest
898 =head2 MixPlayChannel
900 =head2 MixPlayChannelTimed
904 =head2 MixFadeInChannel
906 =head2 MixFadeInChannelTimed
908 =head2 MixFadeInMusic
912 =head2 MixVolumeChunk
914 =head2 MixVolumeMusic
916 =head2 MixHaltChannel
922 =head2 MixExpireChannel
924 =head2 MixFadeOutChannel
926 =head2 MixFadeOutGroup
928 =head2 MixFadeOutMusic
930 =head2 MixFadingMusic
932 =head2 MixFadingChannel
942 =head2 MixResumeMusic
944 =head2 MixRewindMusic
946 =head2 MixPausedMusic
950 =head2 MixPlayingMusic
970 =head2 GL_ACCUM_RED_SIZE
972 =head2 GL_ACCUM_GREEN_SIZE
974 =head2 GL_ACCUM_BLUE_SIZE
976 =head2 GL_ACCUM_ALPHA_SIZE
978 =head2 GL_BUFFER_SIZE
982 =head2 GL_STENCIL_SIZE
984 =head2 GL_DOUBLEBUFFER
986 =head2 GL_SetAttribute
988 =head2 GL_GetAttribute
990 =head2 GL_SwapBuffers
1000 =head2 JoystickOpened
1002 =head2 JoystickIndex
1004 =head2 JoystickNumAxes
1006 =head2 JoystickNumBalls
1008 =head2 JoystickNumHats
1010 =head2 JoystickNumButtons
1012 =head2 JoystickUpdate
1014 =head2 JoystickGetAxis
1016 =head2 JoystickGetHat
1018 =head2 JoystickGetButton
1020 =head2 JoystickGetBall
1022 =head2 JoystickClose
1030 David J. Goehrig, Wayne Keenan, Guillaume Cottenceau
1034 perl(1) SDL::App(3) SDL::Surface(3) SDL::Event(3) SDL::Rect(3)
1035 SDL::Palette(3) SDL::Mixer(3) SDL::Cdrom(3)