added credits
[sdlgit/SDL-Site.git] / pages / SDL.html-inc
index b74b8be..15eab1c 100644 (file)
@@ -8,16 +8,6 @@
 </li>
 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
-<li><a href="#The_SDL_Perl_2009_Development_Team">The SDL Perl 2009 Development Team</a>
-<ul><li><a href="#Documentation">Documentation</a></li>
-<li><a href="#Perl_Development">Perl Development</a></li>
-<li><a href="#Maintainance">Maintainance </a></li>
-</ul>
-</li>
-<li><a href="#MacOSX_Experimental_Usage">MacOSX Experimental Usage</a>
-<ul><li><a href="#Running_SDL_Perl_Scripts_in_MacOSX">Running SDL Perl Scripts in MacOSX</a></li>
-</ul>
-</li>
 <li><a href="#Functions_exported_by_SDL_pm">Functions exported by SDL.pm</a>
 <ul><li><a href="#init_flags">init(flags) </a></li>
 <li><a href="#init_subsystem_flags">init_subsystem(flags)</a></li>
@@ -45,7 +35,7 @@
 
 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="NAME_CONTENT">
-<p>SDL_perl - Simple DirectMedia Layer for Perl</p>
+<p>SDL - Simple DirectMedia Layer for Perl</p>
 
 </div>
 <h2 id="CATEGORY">CATEGORY</h2>
@@ -55,7 +45,7 @@
 </div>
 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="SYNOPSIS_CONTENT">
-<pre>  use SDL;
+<pre>  use SDL ':all';
 
 </pre>
 
@@ -70,68 +60,6 @@ object oriented programming interface please see the documentation provided on a
 per class basis.</p>
 
 </div>
-<h1 id="The_SDL_Perl_2009_Development_Team">The SDL Perl 2009 Development Team</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="The_SDL_Perl_2009_Development_Team_C">
-
-</div>
-<h2 id="Documentation">Documentation</h2>
-<div id="Documentation_CONTENT">
-<pre>  Nick: magnet
-
-</pre>
-
-</div>
-<h2 id="Perl_Development">Perl Development</h2>
-<div id="Perl_Development_CONTENT">
-<pre>  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
-
-</pre>
-
-</div>
-<h2 id="Maintainance">Maintainance </h2>
-<div id="Maintainance_CONTENT">
-<pre>  Nick: kthakore
-       Name: Kartik Thakore
-
-</pre>
-
-</div>
-<h1 id="MacOSX_Experimental_Usage">MacOSX Experimental Usage</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="MacOSX_Experimental_Usage_CONTENT">
-<p>Please get libsdl packages from Fink</p>
-<pre>  perl Build.PL
-       perl Build test
-       perl Build bundle
-       perl Build install
-
-</pre>
-
-</div>
-<h2 id="Running_SDL_Perl_Scripts_in_MacOSX">Running SDL Perl Scripts in MacOSX</h2>
-<div id="Running_SDL_Perl_Scripts_in_MacOSX_C">
-<p>First set the PERL5LIB environment variable to the dependencies of your script</p>
-<pre>  %export PERL5LIB=$PERL5LIB:./lib
-
-</pre>
-<p>Use the SDLPerl executable made in the bundle and call your scripts</p>
-<pre>  %SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl
-
-</pre>
-
-</div>
 <h1 id="Functions_exported_by_SDL_pm">Functions exported by SDL.pm</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="Functions_exported_by_SDL_pm_CONTENT">
 
@@ -139,23 +67,31 @@ per class basis.</p>
 <h2 id="init_flags">init(flags) </h2>
 <div id="init_flags_CONTENT">
 <p>As with the C language API, SDL_perl initializes the SDL environment through
-the <code>SDL::init</code> subroutine.  This routine takes a mode flag constructed through
-the bitwise OR product of the following constants:</p>
+the <code>SDL::init</code> subroutine. This routine takes a mode flag constructed through
+the bitwise OR product of the SDL_INIT_* constants.</p>
+<p>The constants are not exported by default. You can export them into your namespace by doing:</p>
+<pre> use SDL ':all';
+
+</pre>
+<p>or access them directly:</p>
+<pre> SDL::SDL_INIT_AUDIO;
+
+</pre>
 <dl>
        <dt>*
-INIT_AUDIO</dt>
+SDL_INIT_AUDIO</dt>
        <dt>*
-INIT_VIDEO</dt>
+SDL_INIT_VIDEO</dt>
        <dt>*
-INIT_CDROM</dt>
+SDL_INIT_CDROM</dt>
        <dt>*
-INIT_EVERYTHING</dt>
+SDL_INIT_EVERYTHING</dt>
        <dt>*
-INIT_NOPARACHUTE</dt>
+SDL_INIT_NOPARACHUTE</dt>
        <dt>*
-INIT_JOYSTICK</dt>
+SDL_INIT_JOYSTICK</dt>
        <dt>*
-INIT_TIMER</dt>
+SDL_INIT_TIMER</dt>
 </dl>
 <p><code>SDL::Init</code> returns 0 on success, or -1 on error.</p>
 
@@ -176,7 +112,8 @@ The flags tells SDL::quit_subSystem which subsystems to shut down, it uses the s
 </div>
 <h2 id="quit">quit</h2>
 <div id="quit_CONTENT">
-<p>Shuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources. This should always be called before you exit.</p>
+<p>Shuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources.</p>
+<p><strong>Note</strong>: This will be called automatically when perl exits. You don't need to call this, except you want to initialize SDL after this again.</p>
 <p>SDL::quit doesn't returns any value.</p>
 
 </div>
@@ -241,10 +178,6 @@ it doesn't returns any values.</p>
                <p>Unknown SDL error</p>
        </dd>
 </dl>
-
-
-
-
 <p>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. </p>