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);
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:
134 C<SDL::Init> returns 0 on success, or -1 on error.
138 The last error message set by the SDL library can be retrieved using the subroutine
139 C<SDL::GetError>, which returns a scalar containing the text of the message if any.
143 This subroutine allows an application to delay further operations for atleast a
144 number of milliseconds provided as the argument. The actual delay may be longer
145 than the specified depending on the underlying OS.
149 An application may retrieve the number of milliseconds expired since the initilization
150 of the application through this subroutine. This value resets rougly ever 49 days.
152 =head2 AddTimer(interval,callback,param)
154 C<AddTimer> will register a SDL_NewTimerCallback function to be executed after
155 C<interval> milliseconds, with parameter C<param>. SDL_NewTimerCallback objects
156 can be constructed with the C<NewTimer> subroutine. C<SDL::PerlTimerCallback>
157 will return a valid callback for executing a perl subroutine or closure.
158 This subroutine returns a SDL_TimerID for the newly registered callback, or NULL
161 =head2 NewTimer(interval,subroutine)
163 The C<NewTimer> takes an interval in milliseconds and a reference to a subroutine
164 to call at that interval. The subroutine will be invoked in a void context
165 and accepts no parameters. The callback used is that returned by C<SDL::PerlTimerCallback>.
166 C<NewTimer> returns the SDL_TimerID for the new timer or NULL on error.
168 =head2 RemoveTimer(id)
170 This subroutine taks a SDL_TimerID and removes it from the list of active callbacks.
171 RemoveTimer returns false on failure.
175 This subroutine is depreciated, please use C<NewTimer> or C<AddTimer> instead.
179 C<SDL::CDNumDrives> returns the number of available CD-ROM drives in the system.
183 The subroutine C<SDL::CDName> returns the system specific human readable device name
184 for the given CD-ROM drive.
188 This subroutine opens a CD-ROM drive for access, returning NULL if the drive is busy
189 or otherwise unavailable. On success this subroutine returns a handle to the CD-ROM
192 =head2 CDTrackListing(cd)
194 C<SDL::CDTrackListing> returns a human readable description of a CD-ROM. For each
195 track one line will be produced with the following format:
197 Track index: %d, id %d, %2d.%2d
199 This is provided to ease the creation of human readable descriptions and debugging.
201 =head2 CDTrackId(track)
203 C<CDTrackId> returns the id field of the given SDL_CDtrack structure.
205 =head2 CDTrackType(track)
207 C<CDTrackType> returns the type field of the given SDL_CDtrack structure.
209 =head2 CDTrackLength(track)
211 C<CDTrackLength> returns the length field of the given SDL_CDtrack structure.
213 =head2 CDTrackOffset(track)
215 C<CDTrackOffset> returns the offset field of the given SDL_CDtrack structure.
219 The function C<CDStatus> returns the current status of the given SDL_CDrom.
220 C<CDStatus>'s return values are:
241 =head2 CDPlayTracks(cd,track,tracks,frame,frames)
243 To start playing from an arbitrary portion of a CD, one can provide
244 C<SDL::CDPlayTracks> with a CD, a starting track, the number of tracks,
245 a starting frame, and the number of frames to be played.
247 =head2 CDPlay(cd,track,length)
249 C<SDL::CDPlay> plays the next C<length> tracks starting from C<track>
253 This function will pause CD playback until resume is called.
257 This function will resume CD playback if paused.
261 C<SDL::CDStop> will stop CD playback if playing.
265 This function will eject the CD
269 This function will release an opened CD.
305 =head2 MOUSEBUTTONDOWN
315 =head2 ActiveEventGain
317 =head2 ActiveEventState
327 =head2 SDLK_BACKSPACE
349 =head2 SDLK_AMPERSAND
353 =head2 SDLK_LEFTPAREN
355 =head2 SDLK_RIGHTPAREN
391 =head2 SDLK_SEMICOLON
403 =head2 SDLK_LEFTBRACKET
405 =head2 SDLK_BACKSLASH
407 =head2 SDLK_RIGHTBRACKET
411 =head2 SDLK_UNDERSCORE
413 =head2 SDLK_BACKQUOTE
489 =head2 SDLK_KP_PERIOD
491 =head2 SDLK_KP_DIVIDE
493 =head2 SDLK_KP_MULTIPLY
501 =head2 SDLK_KP_EQUALS
555 =head2 SDLK_SCROLLOCK
621 =head2 KeyEventUnicode
623 =head2 KeyEventScanCode
625 =head2 MouseMotionState
631 =head2 MouseMotionXrel
633 =head2 MouseMotionYrel
635 =head2 MouseButtonState
647 =head2 EnableKeyRepeat
655 =head2 CreateRGBSurface
657 =head2 CreateRGBSurfaceFrom
663 =head2 SurfacePalette
665 =head2 SurfaceBitsPerPixel
667 =head2 SurfaceBytesPerPixel
685 =head2 SurfaceColorKey
705 =head2 GetVideoSurface
733 =head2 PaletteNColors
765 =head2 MapRGB (surface,r,g,b)
767 C<SDL::MapRGB> translates the composite red (r), green (g), blue (b)
768 colors according to the given surface to a interger color value. This
769 integer can be used in functions like C<SDL::FillRect>, and is not
770 the same as the format independent Color object returned by C<SDL::NewColor>.
772 =head2 MapRGBA (surface,r,g,b,a)
774 C<SDL::MapRGBA> works as C<SDL::MapRGB> but takes an additional alpha (a)
775 component for semi-transperant colors.
797 =head2 FillRect(surface,rect,color)
799 C<SDL::FillRect> draws a solid rectangle of color on the given surface.
800 If the rectangle is NULL, the entire surface will be painted.
840 =head2 ConvertAudioData
856 =head2 MIX_MAX_VOLUME
858 =head2 MIX_DEFAULT_FREQUENCY
860 =head2 MIX_DEFAULT_FORMAT
862 =head2 MIX_DEFAULT_CHANNELS
866 =head2 MIX_FADING_OUT
872 =head2 MixAllocateChannels
880 =head2 MixQuickLoadWAV
886 =head2 MixSetPostMixCallback
888 =head2 MixSetMusicHook
890 =head2 MixSetMusicFinishedHook
892 =head2 MixGetMusicHookData
894 =head2 MixReverseChannels
896 =head2 MixGroupChannel
898 =head2 MixGroupChannels
900 =head2 MixGroupAvailable
904 =head2 MixGroupOldest
908 =head2 MixPlayChannel
910 =head2 MixPlayChannelTimed
914 =head2 MixFadeInChannel
916 =head2 MixFadeInChannelTimed
918 =head2 MixFadeInMusic
922 =head2 MixVolumeChunk
924 =head2 MixVolumeMusic
926 =head2 MixHaltChannel
932 =head2 MixExpireChannel
934 =head2 MixFadeOutChannel
936 =head2 MixFadeOutGroup
938 =head2 MixFadeOutMusic
940 =head2 MixFadingMusic
942 =head2 MixFadingChannel
952 =head2 MixResumeMusic
954 =head2 MixRewindMusic
956 =head2 MixPausedMusic
960 =head2 MixPlayingMusic
980 =head2 GL_ACCUM_RED_SIZE
982 =head2 GL_ACCUM_GREEN_SIZE
984 =head2 GL_ACCUM_BLUE_SIZE
986 =head2 GL_ACCUM_ALPHA_SIZE
988 =head2 GL_BUFFER_SIZE
992 =head2 GL_STENCIL_SIZE
994 =head2 GL_DOUBLEBUFFER
996 =head2 GL_SetAttribute
998 =head2 GL_GetAttribute
1000 =head2 GL_SwapBuffers
1010 =head2 JoystickOpened
1012 =head2 JoystickIndex
1014 =head2 JoystickNumAxes
1016 =head2 JoystickNumBalls
1018 =head2 JoystickNumHats
1020 =head2 JoystickNumButtons
1022 =head2 JoystickUpdate
1024 =head2 JoystickGetAxis
1026 =head2 JoystickGetHat
1028 =head2 JoystickGetButton
1030 =head2 JoystickGetBall
1032 =head2 JoystickClose
1040 David J. Goehrig, Wayne Keenan, Guillaume Cottenceau
1044 perl(1) SDL::App(3) SDL::Surface(3) SDL::Event(3) SDL::Rect(3)
1045 SDL::Palette(3) SDL::Mixer(3) SDL::Cdrom(3)