5 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
6 # Copyright (C) 2009 Kartik Thakore <kthakore@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
104 =head1 The SDL Perl 2009 Development Team
110 =head2 Perl Development
113 Name: Breno G. de Oliveira
132 =head1 MacOSX Experimental Usage
134 Please get libsdl packages from Fink
141 =head2 Running SDL Perl Scripts in MacOSX
143 First set the PERL5LIB environment variable to the dependencies of your script
145 %export PERL5LIB=$PERL5LIB:./lib
147 Use the SDLPerl executable made in the bundle and call your scripts
149 %SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl
151 =head1 Functions exported by SDL.pm
155 As with the C language API, SDL_perl initializes the SDL environment through
156 the C<SDL::init> subroutine. This routine takes a mode flag constructed through
157 the bitwise OR product of the following constants:
184 C<SDL::Init> returns 0 on success, or -1 on error.
186 =head2 init_subsystem(flags)
188 After SDL has been initialized with SDL::init you may initialize uninitialized subsystems with SDL::init_subsystem.
189 The flags parameter is the same as that used in SDL::init.
191 SDL::init_subsystem returns 0 on success, or -1 on error.
193 =head2 quit_subsystem(flags)
195 SDL::quit_subsystem allows you to shut down a subsystem that has been previously initialized by SDL::init or SDL::init_subsystem.
196 The flags tells SDL::quit_subSystem which subsystems to shut down, it uses the same values that are passed to SDL::init.
198 SDL::quit_subsystem doesn't returns any value.
202 Shuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources. This should always be called before you exit.
204 SDL::quit doesn't returns any value.
206 =head2 was_init(flags)
208 SDL::was_init allows you to see which SDL subsytems have been initialized.
209 flags is a bitwise OR'd combination of the subsystems you wish to check (see SDL::init for a list of subsystem flags).
210 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).
215 The last error message set by the SDL library can be retrieved using the subroutine
216 C<SDL::get_error>, which returns a scalar containing the text of the message if any.
218 =head2 set_error(error) *need to be coded
220 SDL::get_error sets the SDL error to a printf style formatted string.
221 it doesn't returns any values.
223 =head2 error(code) * need to be coded
225 Sets the SDL error message to one of several predefined strings specified by code.
231 SDL_errorcode The corresponding error string
233 SDL_ENOMEM Out of memory
234 SDL_EFREAD Error reading from datastream
235 SDL_EFWRITE Error writing to datastream
236 SDL_EFSEEK Error seeking in datastream
237 SDL_UNSUPPORTED Unknown SDL error
238 SDL_LASTERROR Unknown SDL error
239 any other value Unknown SDL error
242 Note 1: SDL_LASTERROR marks the highest numbered predefined error.
243 Note 2: SDL also defines SDL_OutOfMemory() and SDL_Unsupported() for internal use
244 which are equivalent to SDL_Error(SDL_ENOMEM) and SDL_Error(SDL_UNSUPPORTED) respectively.
248 SDL::Error doesn't returns any value.
251 =head2 clear_error() * need to be coded
253 SDL::clear_error deletes all information about the last internal SDL error. Useful if the error has been handled by the program.
254 it doesn't returns any value.
260 =head2 load_function()
264 =head2 unload_object()
276 =head2 linked_version
282 The last error message set by the SDL library can be retrieved using the subroutine
283 C<SDL::get_error>, which returns a scalar containing the text of the message if any.
287 This subroutine allows an application to delay further operations for atleast a
288 number of milliseconds provided as the argument. The actual delay may be longer
289 than the specified depending on the underlying OS.