# SDL.pm
#
# Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
-#
+# Copyright (C) 2009 Kartik Thakore <kthakore@cpan.org>
# ------------------------------------------------------------------------------
#
# This library is free software; you can redistribute it and/or
#
# Please feel free to send questions, suggestions or improvements to:
#
-# David J. Goehrig
-# dgoehrig@cpan.org
+# Kartik Thakore
+# kthakore@cpan.org
#
package SDL;
$self->export_to_level(1, @_);
SDL::Constants->export_to_level(1);
}
-$VERSION = '2.2.2.17';
+$VERSION = '2.3';
print "$VERSION" if (defined($ARGV[0]) && ($ARGV[0] eq '--SDLperl'));
object oriented programming interface please see the documentation provided on a
per class basis.
-=head2 Init(flags)
-
-As with the C language API, SDL_perl initializes the SDL environment through
-the C<SDL::Init> subroutine. This routine takes a mode flag constructed through
-the bitwise OR product of the following functions:
-
-=over 4
-
-=item *
-INIT_AUDIO()
-
-=item *
-INIT_VIDEO()
-
-=item *
-INIT_CDROM()
-
-=item *
-INIT_EVERYTHING()
-
-=item *
-INIT_NOPARACHUTE()
-
-=item *
-INIT_JOYSTICK()
-
-=item *
-INIT_TIMER()
-
-=back
+=head1 The SDL Perl 2009 Development Team
-C<SDL::Init> returns 0 on success, or -1 on error.
-
-=head2 GetError()
-
-The last error message set by the SDL library can be retrieved using the subroutine
-C<SDL::GetError>, which returns a scalar containing the text of the message if any.
+=head2 Documentation
-=head2 Delay(ms)
+ Nick: magnet
-This subroutine allows an application to delay further operations for atleast a
-number of milliseconds provided as the argument. The actual delay may be longer
-than the specified depending on the underlying OS.
+=head2 Perl Development
-=head2 GetTicks()
+ Nick: Garu
+ Name: Breno G. de Oliveira
+
+ Nick: Dngor
+ Name: Rocco Caputo
-An application may retrieve the number of milliseconds expired since the initilization
-of the application through this subroutine. This value resets rougly ever 49 days.
+ Nick: nferraz
+ Name: Nelson Ferraz
-=head2 AddTimer(interval,callback,param)
+ Nick: acme
+ Name: Leon Brocard
+
+ Nick: FROGGS
+ Name: Tobias Leich
-C<AddTimer> will register a SDL_NewTimerCallback function to be executed after
-C<interval> milliseconds, with parameter C<param>. SDL_NewTimerCallback objects
-can be constructed with the C<NewTimer> subroutine. C<SDL::PerlTimerCallback>
-will return a valid callback for executing a perl subroutine or closure.
-This subroutine returns a SDL_TimerID for the newly registered callback, or NULL
-on error.
+=head2 Maintainance
+
+ Nick: kthakore
+ Name: Kartik Thakore
-=head2 NewTimer(interval,subroutine)
+=head1 MacOSX Experimental Usage
-The C<NewTimer> takes an interval in milliseconds and a reference to a subroutine
-to call at that interval. The subroutine will be invoked in a void context
-and accepts no parameters. The callback used is that returned by C<SDL::PerlTimerCallback>.
-C<NewTimer> returns the SDL_TimerID for the new timer or NULL on error.
+Please get libsdl packages from Fink
+
+ perl Build.PL
+ perl Build test
+ perl Build bundle
+ perl Build install
-=head2 RemoveTimer(id)
+=head2 Running SDL Perl Scripts in MacOSX
-This subroutine taks a SDL_TimerID and removes it from the list of active callbacks.
-RemoveTimer returns false on failure.
+First set the PERL5LIB environment variable to the dependencies of your script
+
+ %export PERL5LIB=$PERL5LIB:./lib
-=head2 SetTimer
+Use the SDLPerl executable made in the bundle and call your scripts
-This subroutine is depreciated, please use C<NewTimer> or C<AddTimer> instead.
+ %SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl
-=head2 CDNumDrives()
+=head1 Functions exported by SDL.pm
-C<SDL::CDNumDrives> returns the number of available CD-ROM drives in the system.
+=head2 init(flags)
-=head2 CDName(drive)
-
-The subroutine C<SDL::CDName> returns the system specific human readable device name
-for the given CD-ROM drive.
-
-=head2 CDOpen(drive)
-
-This subroutine opens a CD-ROM drive for access, returning NULL if the drive is busy
-or otherwise unavailable. On success this subroutine returns a handle to the CD-ROM
-drive.
-
-=head2 CDTrackListing(cd)
-
-C<SDL::CDTrackListing> returns a human readable description of a CD-ROM. For each
-track one line will be produced with the following format:
-
- Track index: %d, id %d, %2d.%2d
-
-This is provided to ease the creation of human readable descriptions and debugging.
-
-=head2 CDTrackId(track)
-
-C<CDTrackId> returns the id field of the given SDL_CDtrack structure.
-
-=head2 CDTrackType(track)
-
-C<CDTrackType> returns the type field of the given SDL_CDtrack structure.
-
-=head2 CDTrackLength(track)
-
-C<CDTrackLength> returns the length field of the given SDL_CDtrack structure.
-
-=head2 CDTrackOffset(track)
-
-C<CDTrackOffset> returns the offset field of the given SDL_CDtrack structure.
-
-=head2 CDStatus(cd)
-
-The function C<CDStatus> returns the current status of the given SDL_CDrom.
-C<CDStatus>'s return values are:
+As with the C language API, SDL_perl initializes the SDL environment through
+the C<SDL::init> subroutine. This routine takes a mode flag constructed through
+the bitwise OR product of the following constants:
=over 4
=item *
-CD_TRAYEMPTY
+INIT_AUDIO
=item *
-CD_PLAYING
+INIT_VIDEO
=item *
-CD_STOPPED
+INIT_CDROM
=item *
-CD_PAUSED
+INIT_EVERYTHING
=item *
-CD_ERROR
-
-=back
-
-=head2 CDPlayTracks(cd,track,tracks,frame,frames)
-
-To start playing from an arbitrary portion of a CD, one can provide
-C<SDL::CDPlayTracks> with a CD, a starting track, the number of tracks,
-a starting frame, and the number of frames to be played.
-
-=head2 CDPlay(cd,track,length)
-
-C<SDL::CDPlay> plays the next C<length> tracks starting from C<track>
-
-=head2 CDPause(cd)
-
-This function will pause CD playback until resume is called.
-
-=head2 CDResume(cd)
-
-This function will resume CD playback if paused.
-
-=head2 CDStop(cd)
-
-C<SDL::CDStop> will stop CD playback if playing.
-
-=head2 CDEject(cd)
-
-This function will eject the CD
-
-=head2 CDClose(cd)
-
-This function will release an opened CD.
-
-=head2 CDNumTracks
-
-=head2 CDCurTrack
-
-=head2 CDCurFrame
-
-=head2 CDTrack
-
-=head2 PumpEvents
-
-=head2 NewEvent
-
-=head2 FreeEvent
-
-=head2 PollEvent
-
-=head2 WaitEvent
-
-=head2 EventState
-
-=head2 IGNORE
-
-=head2 ENABLE
-
-=head2 QUERY
-
-=head2 ACTIVEEVENT
-
-=head2 KEYDOWN
-
-=head2 KEYUP
-
-=head2 MOUSEMOTION
-
-=head2 MOUSEBUTTONDOWN
-
-=head2 MOUSEBUTTONUP
-
-=head2 QUIT
-
-=head2 SYSWMEVENT
-
-=head2 EventType
-
-=head2 ActiveEventGain
-
-=head2 ActiveEventState
-
-=head2 APPMOUSEFOCUS
-
-=head2 APPINPUTFOCUS
-
-=head2 APPACTIVE
-
-=head2 KeyEventState
-
-=head2 SDLK_BACKSPACE
-
-=head2 SDLK_TAB
-
-=head2 SDLK_CLEAR
-
-=head2 SDLK_RETURN
-
-=head2 SDLK_PAUSE
-
-=head2 SDLK_ESCAPE
-
-=head2 SDLK_SPACE
-
-=head2 SDLK_EXCLAIM
-
-=head2 SDLK_QUOTEDBL
-
-=head2 SDLK_HASH
-
-=head2 SDLK_DOLLAR
-
-=head2 SDLK_AMPERSAND
-
-=head2 SDLK_QUOTE
-
-=head2 SDLK_LEFTPAREN
-
-=head2 SDLK_RIGHTPAREN
-
-=head2 SDLK_ASTERISK
-
-=head2 SDLK_PLUS
-
-=head2 SDLK_COMMA
-
-=head2 SDLK_MINUS
-
-=head2 SDLK_PERIOD
+INIT_NOPARACHUTE
-=head2 SDLK_SLASH
-
-=head2 SDLK_0
-
-=head2 SDLK_1
-
-=head2 SDLK_2
-
-=head2 SDLK_3
-
-=head2 SDLK_4
-
-=head2 SDLK_5
-
-=head2 SDLK_6
-
-=head2 SDLK_7
-
-=head2 SDLK_8
-
-=head2 SDLK_9
-
-=head2 SDLK_COLON
-
-=head2 SDLK_SEMICOLON
-
-=head2 SDLK_LESS
-
-=head2 SDLK_EQUALS
-
-=head2 SDLK_GREATER
-
-=head2 SDLK_QUESTION
-
-=head2 SDLK_AT
-
-=head2 SDLK_LEFTBRACKET
-
-=head2 SDLK_BACKSLASH
-
-=head2 SDLK_RIGHTBRACKET
-
-=head2 SDLK_CARET
-
-=head2 SDLK_UNDERSCORE
-
-=head2 SDLK_BACKQUOTE
-
-=head2 SDLK_a
-
-=head2 SDLK_b
-
-=head2 SDLK_c
-
-=head2 SDLK_d
-
-=head2 SDLK_e
-
-=head2 SDLK_f
-
-=head2 SDLK_g
-
-=head2 SDLK_h
-
-=head2 SDLK_i
-
-=head2 SDLK_j
-
-=head2 SDLK_k
-
-=head2 SDLK_l
-
-=head2 SDLK_m
-
-=head2 SDLK_n
-
-=head2 SDLK_o
-
-=head2 SDLK_p
-
-=head2 SDLK_q
-
-=head2 SDLK_r
-
-=head2 SDLK_s
-
-=head2 SDLK_t
-
-=head2 SDLK_u
-
-=head2 SDLK_v
-
-=head2 SDLK_w
-
-=head2 SDLK_x
-
-=head2 SDLK_y
-
-=head2 SDLK_z
-
-=head2 SDLK_DELETE
-
-=head2 SDLK_KP0
-
-=head2 SDLK_KP1
-
-=head2 SDLK_KP2
-
-=head2 SDLK_KP3
-
-=head2 SDLK_KP4
-
-=head2 SDLK_KP5
-
-=head2 SDLK_KP6
-
-=head2 SDLK_KP7
-
-=head2 SDLK_KP8
-
-=head2 SDLK_KP9
-
-=head2 SDLK_KP_PERIOD
-
-=head2 SDLK_KP_DIVIDE
-
-=head2 SDLK_KP_MULTIPLY
-
-=head2 SDLK_KP_MINUS
-
-=head2 SDLK_KP_PLUS
-
-=head2 SDLK_KP_ENTER
-
-=head2 SDLK_KP_EQUALS
-
-=head2 SDLK_UP
-
-=head2 SDLK_DOWN
-
-=head2 SDLK_RIGHT
-
-=head2 SDLK_LEFT
-
-=head2 SDLK_INSERT
-
-=head2 SDLK_HOME
-
-=head2 SDLK_END
-
-=head2 SDLK_PAGEUP
-
-=head2 SDLK_PAGEDOWN
-
-=head2 SDLK_F1
-
-=head2 SDLK_F2
-
-=head2 SDLK_F3
-
-=head2 SDLK_F4
-
-=head2 SDLK_F5
-
-=head2 SDLK_F6
-
-=head2 SDLK_F7
-
-=head2 SDLK_F8
-
-=head2 SDLK_F9
-
-=head2 SDLK_F10
-
-=head2 SDLK_F11
-
-=head2 SDLK_F12
-
-=head2 SDLK_F13
-
-=head2 SDLK_F14
-
-=head2 SDLK_F15
-
-=head2 SDLK_NUMLOCK
-
-=head2 SDLK_CAPSLOCK
-
-=head2 SDLK_SCROLLOCK
-
-=head2 SDLK_RSHIFT
-
-=head2 SDLK_LSHIFT
-
-=head2 SDLK_RCTRL
-
-=head2 SDLK_LCTRL
-
-=head2 SDLK_RALT
+=item *
+INIT_JOYSTICK
-=head2 SDLK_LALT
+=item *
+INIT_TIMER
-=head2 SDLK_RMETA
+=back
-=head2 SDLK_LMETA
+C<SDL::Init> returns 0 on success, or -1 on error.
-=head2 SDLK_LSUPER
+=head2 init_subsystem(flags)
-=head2 SDLK_RSUPER
+After SDL has been initialized with SDL::init you may initialize uninitialized subsystems with SDL::init_subsystem.
+The flags parameter is the same as that used in SDL::init.
-=head2 SDLK_MODE
+SDL::init_subsystem returns 0 on success, or -1 on error.
-=head2 SDLK_HELP
+=head2 quit_subsystem(flags)
-=head2 SDLK_PRINT
+SDL::quit_subsystem allows you to shut down a subsystem that has been previously initialized by SDL::init or SDL::init_subsystem.
+The flags tells SDL::quit_subSystem which subsystems to shut down, it uses the same values that are passed to SDL::init.
-=head2 SDLK_SYSREQ
+SDL::quit_subsystem doesn't returns any value.
-=head2 SDLK_BREAK
+=head2 quit
-=head2 SDLK_MENU
+Shuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources. This should always be called before you exit.
-=head2 SDLK_POWER
+SDL::quit doesn't returns any value.
-=head2 SDLK_EURO
+=head2 was_init(flags)
-=head2 KMOD_NONE
+SDL::was_init allows you to see which SDL subsytems have been initialized.
+flags is a bitwise OR'd combination of the subsystems you wish to check (see SDL::init for a list of subsystem flags).
+If 'flags' is 0 or SDL_INIT_EVERYTHING, it returns a mask of all initialized subsystems (this does not include SDL_INIT_EVENTTHREAD or SDL_INIT_NOPARACHUTE).
-=head2 KMOD_NUM
-=head2 KMOD_CAPS
+=head2 get_error()
-=head2 KMOD_LCTRL
+The last error message set by the SDL library can be retrieved using the subroutine
+C<SDL::get_error>, which returns a scalar containing the text of the message if any.
-=head2 KMOD_RCTRL
+=head2 set_error(error) *need to be coded
-=head2 KMOD_RSHIFT
+SDL::get_error sets the SDL error to a printf style formatted string.
+it doesn't returns any values.
-=head2 KMOD_LSHIFT
+=head2 error(code) * need to be coded
-=head2 KMOD_RALT
+Sets the SDL error message to one of several predefined strings specified by code.
-=head2 KMOD_LALT
+code can be :
-=head2 KMOD_CTRL
+=over 4
-=head2 KMOD_SHIFT
+ SDL_errorcode The corresponding error string
-=head2 KMOD_ALT
+ SDL_ENOMEM Out of memory
+ SDL_EFREAD Error reading from datastream
+ SDL_EFWRITE Error writing to datastream
+ SDL_EFSEEK Error seeking in datastream
+ SDL_UNSUPPORTED Unknown SDL error
+ SDL_LASTERROR Unknown SDL error
+ any other value Unknown SDL error
-=head2 KeyEventSym
-=head2 KeyEventMod
+ Note 1: SDL_LASTERROR marks the highest numbered predefined error.
+ Note 2: SDL also defines SDL_OutOfMemory() and SDL_Unsupported() for internal use
+ which are equivalent to SDL_Error(SDL_ENOMEM) and SDL_Error(SDL_UNSUPPORTED) respectively.
-=head2 KeyEventUnicode
+=back
-=head2 KeyEventScanCode
+SDL::Error doesn't returns any value.
-=head2 MouseMotionState
-=head2 MouseMotionX
+=head2 clear_error() * need to be coded
-=head2 MouseMotionY
+SDL::clear_error deletes all information about the last internal SDL error. Useful if the error has been handled by the program.
+it doesn't returns any value.
-=head2 MouseMotionXrel
+=head2 load_object()
-=head2 MouseMotionYrel
+Need to be coded.
-=head2 MouseButtonState
+=head2 load_function()
-=head2 MouseButton
+Need to be coded.
-=head2 MouseButtonX
+=head2 unload_object()
-=head2 MouseButtonY
+Need to be coded.
-=head2 SysWMEventMsg
+=head2 VERSION()
-=head2 EnableUnicode
+Need to be coded.
-=head2 EnableKeyRepeat
+=head2 version()
-=head2 GetKeyName
+Need to be coded.
-=head2 PRESSED
+=head2 linked_version
-=head2 RELEASED
+Need to be coded.
-=head2 CreateRGBSurface
+=head2 get_error()
-=head2 CreateRGBSurfaceFrom
+The last error message set by the SDL library can be retrieved using the subroutine
+C<SDL::get_error>, which returns a scalar containing the text of the message if any.
-=head2 IMG_Load
+=head2 delay(ms)
-=head2 FreeSurface
+This subroutine allows an application to delay further operations for atleast a
+number of milliseconds provided as the argument. The actual delay may be longer
+than the specified depending on the underlying OS.
-=head2 SurfacePalette
-=head2 SurfaceBitsPerPixel
-=head2 SurfaceBy
\ No newline at end of file
projects / sdlgit/SDL_perl.git / blobdiff