.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "pods::SDL 3pm" .TH pods::SDL 3pm 2024-03-28 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME SDL \- Simple DirectMedia Layer for Perl .SH CATEGORY .IX Header "CATEGORY" Core .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use SDL; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" 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. .SH CONSTANTS .IX Header "CONSTANTS" The constants are not exported by default. You can export them by doing: .PP .Vb 1 \& use SDL \*(Aq:all\*(Aq; .Ve .PP or access them directly: .PP .Vb 1 \& SDL::SDL_INIT_AUDIO; .Ve .PP or by choosing the export tags below: .PP Export tag: ':init' .PP .Vb 7 \& SDL_INIT_AUDIO \& SDL_INIT_VIDEO \& SDL_INIT_CDROM \& SDL_INIT_EVERYTHING \& SDL_INIT_NOPARACHUTE \& SDL_INIT_JOYSTICK \& SDL_INIT_TIMER .Ve .SH METHODS .IX Header "METHODS" .SS init .IX Subsection "init" .Vb 1 \& SDL::init( $flags ); .Ve .PP As with the C language API, SDL Perl initializes the SDL environment with the \f(CW\*(C`SDL::init\*(C'\fR subroutine. This routine takes a mode flag constructed through the bitwise OR product of the \f(CW\*(C`SDL_INIT_*\*(C'\fR constants. The \f(CW$flags\fR tell \f(CW\*(C`SDL::init\*(C'\fR which subsystems to initialize. .PP .Vb 1 \& SDL::init(SDL_INIT_AUDIO | SDL_INIT_JOYSTICK); .Ve .PP \&\f(CW\*(C`SDL::init\*(C'\fR returns \f(CW0\fR on success, or \f(CW\-1\fR on error. .SS init_sub_system .IX Subsection "init_sub_system" .Vb 1 \& SDL::init_sub_system( $flags ); .Ve .PP After SDL has been initialized with \f(CW\*(C`SDL::init\*(C'\fR you may initialize any uninitialized subsystems with \f(CW\*(C`SDL::init_sub_system\*(C'\fR. The \f(CW$flags\fR tell \f(CW\*(C`SDL::init_sub_system\*(C'\fR which subsystems to initialize, and are taken in the same way as \f(CW\*(C`SDL::init\*(C'\fR. .PP \&\f(CW\*(C`SDL::init_sub_system\*(C'\fR returns \f(CW0\fR on success, or \f(CW\-1\fR on error. .SS quit_sub_system .IX Subsection "quit_sub_system" .Vb 1 \& SDL::quit_sub_system( $flags ); .Ve .PP \&\f(CW\*(C`SDL::quit_sub_system\*(C'\fR allows you to shut down a subsystem that has been previously initialized by \f(CW\*(C`SDL::init\*(C'\fR or \f(CW\*(C`SDL::init_sub_system\*(C'\fR. The \f(CW$flags\fR tell \f(CW\*(C`SDL::quit_sub_system\*(C'\fR which subsystems to shut down, and are taken in the same way as \f(CW\*(C`SDL::init\*(C'\fR. .PP \&\f(CW\*(C`SDL::quit_sub_system\*(C'\fR doesn't return any values. .SS quit .IX Subsection "quit" .Vb 1 \& SDL::quit; .Ve .PP \&\f(CW\*(C`SDL::quit\*(C'\fR Shuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources. .PP \&\fBNote:\fR 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. .PP \&\f(CW\*(C`SDL::quit\*(C'\fR doesn't return any values. .SS was_init .IX Subsection "was_init" .Vb 1 \& my $flags = SDL::was_init( $flags ); .Ve .PP \&\f(CW\*(C`SDL::was_init\*(C'\fR allows you to see which SDL subsystems have been initialized. The \f(CW$flags\fR tell \f(CW\*(C`SDL::was_init\*(C'\fR which subsystems to check, and are taken in the same way as \f(CW\*(C`SDL::init\*(C'\fR. .PP \&\f(CW\*(C`SDL::was_init\*(C'\fR returns a mask of the initialized subsystems it checks. If \f(CW$flags\fR is \f(CW0\fR or \f(CW\*(C`SDL_INIT_EVERYTHING\*(C'\fR, a mask of all initialized subsystems will be returned (this does not include \f(CW\*(C`SDL_INIT_EVENTTHREAD\*(C'\fR or \f(CW\*(C`SDL_INIT_NOPARACHUTE\*(C'\fR). .PP .Vb 1 \& use SDL \*(Aq:all\*(Aq; \& \& 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! \& } .Ve .SS get_error .IX Subsection "get_error" .Vb 1 \& my $error = SDL::get_error; .Ve .PP Returns a scalar value containing the last error message set by the SDL library (if any). .SS set_error_real .IX Subsection "set_error_real" .Vb 1 \& SDL::set_error_real( $printf_format, @values ) .Ve .PP \&\f(CW\*(C`SDL::set_error_real\*(C'\fR sets the SDL error to a \f(CW\*(C`printf\*(C'\fR style formatted string. .PP \&\f(CW\*(C`SDL::set_error_real\*(C'\fR doesn't return any values. .SS clear_error .IX Subsection "clear_error" .Vb 1 \& SDL::clear_error; .Ve .PP \&\f(CW\*(C`SDL::clear_error\*(C'\fR deletes all information about the last SDL error. This is useful if the error has been handled by the program. .PP \&\f(CW\*(C`SDL::clear_error\*(C'\fR doesn't return any values. .SS version .IX Subsection "version" .Vb 1 \& my $version = SDL::version; .Ve .PP Returns an \f(CW\*(C`SDL::Version\*(C'\fR object of the SDL library at compile-time. .PP .Vb 2 \& use SDL; \& use SDL::Version; \& \& my $v = SDL::version; \& printf("got version: %d.%d.%d\en", $v\->major, $v\->minor, $v\->patch); .Ve .SS linked_version .IX Subsection "linked_version" \&\f(CW\*(C`SDL::linked_version\*(C'\fR works in the same way as \f(CW\*(C`SDL::version\*(C'\fR, but returns an \f(CW\*(C`SDL::Version\*(C'\fR object of the SDL library at link-time. .SS get_ticks .IX Subsection "get_ticks" .Vb 1 \& my $ticks = SDL::get_ticks; .Ve .PP Returns the number of milliseconds since SDL library initialization. This value wraps around if the program runs for more than 49.7 days .SS get_handle .IX Subsection "get_handle" .Vb 1 \& my $win32_handle = SDL::get_handle; .Ve .PP A video surface must be inited to get a handle. .SS delay .IX Subsection "delay" .Vb 1 \& SDL::delay( $ms ); .Ve .PP \&\f(CW\*(C`SDL::delay\*(C'\fR waits the specified number of milliseconds before returning. The actual delay may be longer than specified depending on the underlying OS. .PP \&\f(CW\*(C`SDL::delay\*(C'\fR doesn't return anything. .PP .Vb 2 \& # Delay for half a second \& SDL::delay(500); .Ve .SH "SDL Manual: Getting Started" .IX Header "SDL Manual: Getting Started" A new book has been started to provide a complete tutorial for SDL. See . .SH AUTHORS .IX Header "AUTHORS" .SS "Project Founder" .IX Subsection "Project Founder" David J. Goehrig .SS "Current Maintainers" .IX Subsection "Current Maintainers" Kartik Thakore (kthakore) .PP Tobias Leich (FROGGS) .SS "Core Developers and Contributors" .IX Subsection "Core Developers and Contributors" The following people have dedicated blood sweat and tears to making SDL Perl possible. .PP See the impact graph on our github repository. .PP Andy Bakun .PP Benedikt Meurer .PP Blaise Roth (Blaizer) .PP Breno G. de Oliveira (garu) .PP Brian Cassidy (bricas) .PP chromatic .PP Daniel Mantovani .PP Daniel Ruoso http://daniel.ruoso.com/ .PP David J. Goehrig .PP Dustin Mays (dorkfish) .PP Fedora .PP Gabor Szabo (szabgab) .PP Guillaue Cottenceau (gc) .PP Heikki MehtÃnen (hmehta/hejki) .PP James King .PP James Wright .PP Jeffrey T. Palmer (jtpalmer) .PP Kartik Thakore (kthakore) .PP KatrinaTheLamia .PP kmx .PP Luke .PP Michael Lamertz .PP morgoth.666 .PP Peter BARABAS .PP Russell Valentine .PP Ryan Hanlon .PP Stephane Desneux .PP Tels .PP Thomas Tongue .PP Tobias Leich (FROGGS) .PP Tony C .PP Yuval Kogman (nothingmuch) .PP Wayne Keenan .PP If you would like to contribute to SDL Perl, please post a message on the mailing list: .PP sdl\-devel@perl.org .PP And request access to the github repository. Or drop us a line on #sdl over at irc.perl.org .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2002\-2010 SDL Authors as listed above, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. .PP IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.