note on how to import contants

[sdlgit/SDL-Site.git] / pages / SDL.html-inc

diff --git a/pages/SDL.html-inc b/pages/SDL.html-inc
index b74b8be..bb561e5 100644 (file)
--- a/pages/SDL.html-inc
+++ b/pages/SDL.html-inc
@@ -45,7 +45,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>
@@ -139,23 +139,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 +184,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 +250,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>