cleanup
[sdlgit/SDL-Site.git] / htdocs / assets / SDL.html-inc
diff --git a/htdocs/assets/SDL.html-inc b/htdocs/assets/SDL.html-inc
deleted file mode 100644 (file)
index 34e5c9f..0000000
+++ /dev/null
@@ -1,282 +0,0 @@
-<div class="pod">
-<!-- INDEX START -->
-<h3 id="TOP">Index</h3>
-
-<ul><li><a href="#NAME">NAME</a></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>
-<li><a href="#quit_subsystem_flags">quit_subsystem(flags)</a></li>
-<li><a href="#quit">quit</a></li>
-<li><a href="#was_init_flags">was_init(flags)</a></li>
-<li><a href="#get_error">get_error()</a></li>
-<li><a href="#set_error_error_need_to_be_coded">set_error(error)  *need to be coded</a></li>
-<li><a href="#error_code_need_to_be_coded">error(code) * need to be coded</a></li>
-<li><a href="#clear_error_need_to_be_coded">clear_error() * need to be coded</a></li>
-<li><a href="#load_object">load_object()</a></li>
-<li><a href="#load_function">load_function()</a></li>
-<li><a href="#unload_object">unload_object()</a></li>
-<li><a href="#VERSION">VERSION()</a></li>
-<li><a href="#version">version()</a></li>
-<li><a href="#linked_version">linked_version</a></li>
-<li><a href="#get_error-2">get_error()</a></li>
-<li><a href="#delay_ms">delay(ms)</a>
-</li>
-</ul>
-</li>
-</ul><hr />
-<!-- INDEX END -->
-
-<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>
-
-</div>
-<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SYNOPSIS_CONTENT">
-<pre>  use SDL;
-
-</pre>
-
-</div>
-<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="DESCRIPTION_CONTENT">
-<p>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.</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">
-
-</div>
-<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>
-<dl>
-       <dt>*
-INIT_AUDIO</dt>
-       <dt>*
-INIT_VIDEO</dt>
-       <dt>*
-INIT_CDROM</dt>
-       <dt>*
-INIT_EVERYTHING</dt>
-       <dt>*
-INIT_NOPARACHUTE</dt>
-       <dt>*
-INIT_JOYSTICK</dt>
-       <dt>*
-INIT_TIMER</dt>
-</dl>
-<p><code>SDL::Init</code> returns 0 on success, or -1 on error.</p>
-
-</div>
-<h2 id="init_subsystem_flags">init_subsystem(flags)</h2>
-<div id="init_subsystem_flags_CONTENT">
-<p>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. </p>
-<p>SDL::init_subsystem returns 0 on success, or -1 on error.</p>
-
-</div>
-<h2 id="quit_subsystem_flags">quit_subsystem(flags)</h2>
-<div id="quit_subsystem_flags_CONTENT">
-<p>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. </p>
-<p>SDL::quit_subsystem doesn't returns any value.</p>
-
-</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>SDL::quit doesn't returns any value.</p>
-
-</div>
-<h2 id="was_init_flags">was_init(flags)</h2>
-<div id="was_init_flags_CONTENT">
-<p>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).</p>
-
-
-
-
-
-</div>
-<h2 id="get_error">get_error()</h2>
-<div id="get_error_CONTENT">
-<p>The last error message set by the SDL library can be retrieved using the subroutine
-<code>SDL::get_error</code>, which returns a scalar containing the text of the message if any.</p>
-
-</div>
-<h2 id="set_error_error_need_to_be_coded">set_error(error)  *need to be coded</h2>
-<div id="set_error_error_need_to_be_coded_CON">
-<p>SDL::get_error sets the SDL error to a printf style formatted string. 
-it doesn't returns any values.</p>
-
-</div>
-<h2 id="error_code_need_to_be_coded">error(code) * need to be coded</h2>
-<div id="error_code_need_to_be_coded_CONTENT">
-<p>Sets the SDL error message to one of several predefined strings specified by code. </p>
-<p>code can be :</p>
-<pre>          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. 
-
-</pre>
-<p>SDL::Error doesn't returns any value.</p>
-
-
-
-
-
-</div>
-<h2 id="clear_error_need_to_be_coded">clear_error() * need to be coded</h2>
-<div id="clear_error_need_to_be_coded_CONTENT">
-<p>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.</p>
-
-</div>
-<h2 id="load_object">load_object()</h2>
-<div id="load_object_CONTENT">
-<p>Need to be coded.</p>
-
-</div>
-<h2 id="load_function">load_function()</h2>
-<div id="load_function_CONTENT">
-<p>Need to be coded.</p>
-
-</div>
-<h2 id="unload_object">unload_object()</h2>
-<div id="unload_object_CONTENT">
-<p>Need to be coded.</p>
-
-</div>
-<h2 id="VERSION">VERSION()</h2>
-<div id="VERSION_CONTENT">
-<p>Need to be coded. </p>
-
-</div>
-<h2 id="version">version()</h2>
-<div id="version_CONTENT">
-<p>Need to be coded.</p>
-
-</div>
-<h2 id="linked_version">linked_version</h2>
-<div id="linked_version_CONTENT">
-<p>Need to be coded.</p>
-
-</div>
-<h2 id="get_error-2">get_error()</h2>
-<div id="get_error_CONTENT-2">
-<p>The last error message set by the SDL library can be retrieved using the subroutine
-<code>SDL::get_error</code>, which returns a scalar containing the text of the message if any.</p>
-
-</div>
-<h2 id="delay_ms">delay(ms)</h2>
-<div id="delay_ms_CONTENT">
-<p>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.</p>
-
-
-
-
-
-
-
-
-</div>
-</div>
\ No newline at end of file