updated docs

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

diff --git a/pages/SDLx-LayerManager.html-inc b/pages/SDLx-LayerManager.html-inc
index 5429bca..4aed8af 100644 (file)
--- a/pages/SDLx-LayerManager.html-inc
+++ b/pages/SDLx-LayerManager.html-inc
@@ -24,7 +24,7 @@
 </li>
 <li><a href="#BUGS">BUGS</a></li>
 <li><a href="#SUPPORT">SUPPORT</a></li>
-<li><a href="#AUTHOR">AUTHOR</a></li>
+<li><a href="#AUTHORS">AUTHORS</a></li>
 <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
 <li><a href="#SEE_ALSO">SEE ALSO</a>
 </li>
@@ -71,7 +71,9 @@
 </div>
 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="DESCRIPTION_CONTENT">
-<p>The LayerManager ...</p>
+<p>SDLx::LayerManager is a package to handle a bunch of layers. A layer (see SDLx::Layer) is an SDL::Surface, the position of the surface on screen and some additional information.</p>
+<p>The layermanager gives you the opportunity to obtain the layer at a given point on screen and get the layers that are ahead or behind a layer.</p>
+<p>You will even be able to attach one or more layers to the mouse, e.g. for simulation some drag&amp;drop functionality.</p>
 
 </div>
 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
@@ -80,26 +82,52 @@
 </div>
 <h2 id="new">new</h2>
 <div id="new_CONTENT">
+<pre>  my $layermanager = SDLx::LayerManager-&gt;new();
+
+</pre>
+<p>This creates your layermanager object. It doesn't take any parameters.</p>
 
 </div>
 <h2 id="add">add</h2>
 <div id="add_CONTENT">
+<pre>  $layermanager-&gt;add( $layer );
+  $layermanager-&gt;add( SDLx::Layer-&gt;new( $surface, $x, $y, $options ) );
+
+</pre>
+<p>Call <code>add</code> to push an SDLx::Layer object to the layermanager.</p>
 
 </div>
 <h2 id="layers">layers</h2>
 <div id="layers_CONTENT">
+<pre>  my @layers = @{ $layermanager-&gt;layers };
+  my $first_layer = $layermanager-&gt;layers-&gt;[0];
+
+</pre>
+<p>The method <code>layers</code> returns all layers that were added before.</p>
 
 </div>
 <h2 id="layer">layer</h2>
 <div id="layer_CONTENT">
+<pre>  my $layer = $layermanager-&gt;layer( $index );
+
+</pre>
+<p>To obtain only one layer at index <code>$index</code> use this function. <code>$index</code> ranges from <code>0</code> to <code>lenght - 1</code>.</p>
 
 </div>
 <h2 id="length">length</h2>
 <div id="length_CONTENT">
+<pre>  my $length = $layermanager-&gt;length();
+
+</pre>
+<p>This method returns the count of the added layers.</p>
 
 </div>
 <h2 id="blit">blit</h2>
 <div id="blit_CONTENT">
+<pre>  $layermanager-&gt;blit( $surface );
+
+</pre>
+<p>This method blits all layers to the surface (e.g. your video surface).</p>
 
 </div>
 <h2 id="by_position">by_position</h2>
@@ -107,14 +135,27 @@
 <pre>  my $layer = $layermanager-&gt;by_position( $x, $y );
 
 </pre>
+<p><code>by_position</code> returns the <code>SDLx::Layer</code> object at point <code>$x $y</code>, which is not fully transparent at this pixel.</p>
 
 </div>
 <h2 id="ahead">ahead</h2>
 <div id="ahead_CONTENT">
+<pre>  my @layers = @{ $layermanager-&gt;ahead( $index ) };
+
+</pre>
+<p>This method returns all layers that are ahead of the given layer indicated by <code>$index</code>.
+Ahead means that a layer has a higher z-index and is blitted over the given layer.</p>
+<p><strong>Note</strong>: This method doesn't check for transparency. This will change in future versions.</p>
 
 </div>
 <h2 id="behind">behind</h2>
 <div id="behind_CONTENT">
+<pre>  my @layers = @{ $layermanager-&gt;behind( $index ) };
+
+</pre>
+<p>This method returns all layers that are behind of the given layer indicated by <code>$index</code>.
+Behind means that a layer has a lower z-index and is blitted before the given layer.</p>
+<p><strong>Note</strong>: This method doesn't check for transparency. This will change in future versions.</p>
 
 </div>
 <h2 id="attach">attach</h2>
@@ -143,15 +184,9 @@
 <p>#sdl irc.perl.org</p>
 
 </div>
-<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="AUTHOR_CONTENT">
-<pre>    Tobias Leich
-    CPAN ID: FROGGS
-    ---
-    froggs@cpan.org
-    http://sdl.perl.org
-
-</pre>
+<h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="AUTHORS_CONTENT">
+<p>See <b>AUTHORS</b> in <cite>SDL</cite>.</p>
 
 </div>
 <h1 id="COPYRIGHT">COPYRIGHT</h1><p><a href="#TOP" class="toplink">Top</a></p>