SDL_perl - Simple DirectMedia Layer for Perl
+SDL - Simple DirectMedia Layer for Perl
+ +Core
use SDL; +use SDL;
SDL_perl is a package of perl modules that provides both functional and object orient -interfaces to the Simple DirectMedia Layer for Perl 5. This package does take some -liberties with the SDL API, and attempts to adhere to the spirit of both the SDL -and Perl. This document describes the low-level functional SDL_perl API. For the -object oriented programming interface please see the documentation provided on a -per class basis.
+SDL_perl is a package of Perl modules that provide both functional and object oriented interfaces to the Simple DirectMedia Layer for Perl 5. +This package takes some liberties with the SDL API, and attempts to adhere to the spirit of both the SDL and Perl. +This document describes the low-level functional SDL Perl API. +For the object oriented programming interface please see the documentation provided on a per-class basis.
Nick: magnet +CONSTANTS
++-The constants are not exported by default. You can export them by doing:
+use SDL ':all';- -Perl Development
---Nick: Garu - Name: Breno G. de Oliveira - - Nick: Dngor - Name: Rocco Caputo - - Nick: nferraz - Name: Nelson Ferraz - - Nick: acme - Name: Leon Brocard - - Nick: FROGGS - Name: Tobias Leich +or access them directly:
+SDL::SDL_INIT_AUDIO;- -Maintainance
---Nick: kthakore - Name: Kartik Thakore +or by choosing the export tags below:
+Export tag: ':init'
+SDL_INIT_AUDIO + SDL_INIT_VIDEO + SDL_INIT_CDROM + SDL_INIT_EVERYTHING + SDL_INIT_NOPARACHUTE + SDL_INIT_JOYSTICK + SDL_INIT_TIMERMacOSX Experimental Usage
--Please get libsdl packages from Fink
-perl Build.PL - perl Build test - perl Build bundle - perl Build install - -+METHODS
+-Running SDL Perl Scripts in MacOSX
--First set the PERL5LIB environment variable to the dependencies of your script
-%export PERL5LIB=$PERL5LIB:./lib +init
++-SDL::init( $flags );-Use the SDLPerl executable made in the bundle and call your scripts
-%SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl +As with the C language API, SDL Perl initializes the SDL environment with the
+SDL::initsubroutine. +This routine takes a mode flag constructed through the bitwise OR product of theSDL_INIT_*constants. +The$flagstellSDL::initwhich subsystems to initialize.SDL::init(SDL_INIT_AUDIO | SDL_INIT_JOYSTICK);+
SDL::initreturns0on success, or-1on error.Functions exported by SDL.pm
-+init_subsystem
++-SDL::init_subsystem( $flags ); -init(flags)
---As with the C language API, SDL_perl initializes the SDL environment through -the
-SDL::initsubroutine. This routine takes a mode flag constructed through -the bitwise OR product of the following constants:-
-- * -INIT_AUDIO
-- * -INIT_VIDEO
-- * -INIT_CDROM
-- * -INIT_EVERYTHING
-- * -INIT_NOPARACHUTE
-- * -INIT_JOYSTICK
-- * -INIT_TIMER
-+ +
SDL::Initreturns 0 on success, or -1 on error.After SDL has been initialized with
+SDL::inityou may initialize any uninitialized subsystems withSDL::init_subsystem. +The$flagstellSDL::init_subsystemwhich subsystems to initialize, and are taken in the same way asSDL::init.
SDL::init_subsystemreturns0on success, or-1on error.init_subsystem(flags)
--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.
-SDL::init_subsystem returns 0 on success, or -1 on error.
+quit_subsystem
++-SDL::quit_subsystem( $flags ); -quit_subsystem(flags)
--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.
-SDL::quit_subsystem doesn't returns any value.
+ ++
SDL::quit_subsystemallows you to shut down a subsystem that has been previously initialized bySDL::initorSDL::init_subsystem. +The$flagstellSDL::quit_subsystemwhich subsystems to shut down, and are taken in the same way asSDL::init.
SDL::quit_subsystemdoesn't return any values.quit
--Shuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources. This should always be called before you exit.
-SDL::quit doesn't returns any value.
+SDL::quit; -was_init(flags)
--+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).
+ ++
SDL::quitShuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources.Note: This will be called automatically when Perl exits. You don't need to call this, except if you want to initialize SDL again after this.
++
SDL::quitdoesn't return any values.was_init
++-my $flags = SDL::was_init( $flags ); +++
SDL::was_initallows you to see which SDL subsytems have been initialized. +The$flagstellSDL::was_initwhich subsystems to check, and are taken in the same way asSDL::init.+
SDL::was_initreturns a mask of the initialized subsystems it checks. +If$flagsis0orSDL_INIT_EVERYTHING, a mask of all initialized subsystems will be returned (this does not includeSDL_INIT_EVENTTHREADorSDL_INIT_NOPARACHUTE).use SDL ':all'; + my $mask = SDL::was_init(SDL_INIT_AUDIO | SDL_INIT_JOYSTICK); + if($mask & SDL_INIT_AUDIO and $mask & SDL_INIT_JOYSTICK) { + # Both subsystems are initialized! + } +get_error()
+get_error
--The last error message set by the SDL library can be retrieved using the subroutine -
+SDL::get_error, which returns a scalar containing the text of the message if any.my $error = SDL::get_error; -set_error(error) *need to be coded
---SDL::get_error sets the SDL error to a printf style formatted string. -it doesn't returns any values.
+ +Returns a scalar value containing the last error message set by the SDL library (if any).
error(code) * need to be coded
--Sets the SDL error message to one of several predefined strings specified by code.
-code can be :
--
- - - - -- SDL_errorcode
-- -
-The corresponding error string
-- 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
-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.
-SDL::Error doesn't returns any value.
- - - +set_error_real
++-SDL::set_error_real( $printf_format, @values ) +++
SDL::set_error_realsets the SDL error to aprintfstyle formatted string.
SDL::set_error_realdoesn't return any values.clear_error() * need to be coded
--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.
+clear_error
++-SDL::clear_error; -load_object()
---Need to be coded.
+ ++
SDL::clear_errordeletes all information about the last SDL error. +This is useful if the error has been handled by the program.
SDL::clear_errordoesn't return any values.load_function()
--Need to be coded.
+version
++-my $version = SDL::version; -unload_object()
---Need to be coded.
+ +Returns an
+SDL::Versionobject of the SDL library at compile-time.use SDL; + use SDL::Version; -VERSION()
---Need to be coded.
+ my $v = SDL::version; + printf("got version: %d.%d.%d\n", $v->major, $v->minor, $v->patch); -version()
--Need to be coded.
+linked_version
--Need to be coded.
- -get_error()
---The last error message set by the SDL library can be retrieved using the subroutine -
+SDL::get_error, which returns a scalar containing the text of the message if any.
SDL::linked_versionworks in the same way asSDL::version, but returns anSDL::Versionobject of the SDL library at link-time.delay(ms)
--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.
+get_ticks
+++my $ticks = SDL::get_ticks; ++Returns the number of milliseconds since SDL library initialization. +This value wraps around if the program runs for more than 49.7 days
+delay
++-SDL::delay( $ms ); +++
SDL::delaywaits the specified number of milliseconds before returning. +The actual delay may be longer than specified depending on the underlying OS.+
SDL::delaydoesn't return anything.# Delay for half a second + SDL::delay(500); +STUFF TO BE DONE for the documentation
--\ No newline at end of file- - - SDL:: to improve - SDL::Video add examples, need general improvement. - Event.pod need to be checked against Events.pod - SDL::Events need to be completed - SDL::Cdrom need some examples. - SDL::MultiThread to be created( once implemented ). - SDL::Time to be completed. - SDL::RW to be created. - SDL::Mouse need to be created. - SDL::Joystick need to be created. - SDL::Audio need to be created. - -+AUTHOR
++magnet, kthakore, Blaizer