update
Kartik Thakore [Wed, 14 Jul 2010 02:58:07 +0000 (02:58 +0000)]
pages/SDL-Deprecated.html-inc [new file with mode: 0644]
pages/SDLx-Rect.html-inc [new file with mode: 0644]
pages/SDLx-SFont.html-inc [new file with mode: 0644]
pages/SDLx-Sprite.html-inc [new file with mode: 0644]
pages/SDLx-Surface.html-inc [new file with mode: 0644]

diff --git a/pages/SDL-Deprecated.html-inc b/pages/SDL-Deprecated.html-inc
new file mode 100644 (file)
index 0000000..8131a11
--- /dev/null
@@ -0,0 +1,47 @@
+<div class="pod">
+<!-- INDEX START -->
+<h3 id="TOP">Index</h3>
+
+<ul><li><a href="#NAME">NAME</a></li>
+<li><a href="#CATEGORY">CATEGORY</a></li>
+<li><a href="#RELEASES">RELEASES</a>
+<ul><li><a href="#2_500">2.500</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::Deprecated - Log of Deprecated items per release</p>
+
+</div>
+<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="CATEGORY_CONTENT">
+<p>Core</p>
+
+</div>
+<h1 id="RELEASES">RELEASES</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="RELEASES_CONTENT">
+
+</div>
+<h2 id="2_500">2.500</h2>
+<div id="2_500_CONTENT">
+
+
+
+
+<dl>
+       <dt>SDL::App </dt>
+       <dd>
+               <p>SDL::App has migrated to SDLx::App namespace. The reason for this is because it is an extenstion and not a 1:1 XS/Constant Module to the c library.</p>
+       </dd>
+       <dt>SDL::Game::Rect </dt>
+       <dd>
+               <p>SDL::Game::Rect has migrated to SDLx::Rect namespace. Same reasoning as above.</p>
+       </dd>
+</dl>
+
+</div>
+</div>
\ No newline at end of file
diff --git a/pages/SDLx-Rect.html-inc b/pages/SDLx-Rect.html-inc
new file mode 100644 (file)
index 0000000..e3bedfa
--- /dev/null
@@ -0,0 +1,316 @@
+<div class="pod">
+<!-- INDEX START -->
+<h3 id="TOP">Index</h3>
+
+<ul><li><a href="#NAME">NAME</a></li>
+<li><a href="#CATEGORY">CATEGORY</a></li>
+<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#DESCRIPTION">DESCRIPTION</a>
+<ul><li><a href="#ATTRIBUTES">ATTRIBUTES</a></li>
+<li><a href="#METHODS">METHODS </a>
+<ul><li><a href="#new_left_top_width_height">new ($left, $top, $width, $height)</a></li>
+<li><a href="#copy">copy</a></li>
+<li><a href="#duplicate">duplicate</a></li>
+<li><a href="#move_x_y">move(x, y)</a></li>
+<li><a href="#move_ip_x_y">move_ip(x, y)</a></li>
+<li><a href="#inflate_x_y">inflate(x, y)</a></li>
+<li><a href="#inflate_ip_x_y">inflate_ip(x, y)</a></li>
+<li><a href="#clamp_rect">clamp($rect)</a></li>
+<li><a href="#clamp_ip_rect">clamp_ip($rect)</a></li>
+<li><a href="#clip_rect">clip($rect)</a></li>
+<li><a href="#clip_ip_rect">clip_ip($rect)</a></li>
+<li><a href="#union_rect">union($rect)</a></li>
+<li><a href="#union_ip_rect">union_ip($rect)</a></li>
+<li><a href="#unionall_rect1_rect2">unionall( [$rect1, $rect2, ...] )</a></li>
+<li><a href="#unionall_ip_rect1_rect2">unionall_ip( [$rect1, $rect2, ...] )</a></li>
+<li><a href="#fit_rect">fit($rect)</a></li>
+<li><a href="#fit_ip_rect">fit_ip($rect)</a></li>
+<li><a href="#normalize">normalize</a></li>
+<li><a href="#contains_rect">contains($rect)</a></li>
+<li><a href="#collidepoint_x_y">collidepoint(x, y)</a></li>
+<li><a href="#colliderect_rect">colliderect($rect)</a></li>
+<li><a href="#collidelist_rect1_rect2">collidelist( [$rect1, $rect2, ...] )</a></li>
+<li><a href="#collidelistall_rect1_rect2">collidelistall( [$rect1, $rect2, ...] )</a></li>
+<li><a href="#collidehash_key1_gt_rect1_key2_gt_re">collidehash( {key1 =&gt; $rect1, key2 =&gt; $rect2, ...} )</a></li>
+<li><a href="#collidehashall_key1_gt_rect1_key2_gt">collidehashall( {key1 =&gt; $rect1, key2 =&gt; $rect2, ...} )</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="#AUTHOR">AUTHOR</a></li>
+<li><a href="#BUGS">BUGS</a></li>
+<li><a href="#SUPPORT">SUPPORT</a></li>
+<li><a href="#ACKNOWLEDGEMENTS">ACKNOWLEDGEMENTS</a></li>
+<li><a href="#COPYRIGHT_amp_LICENSE">COPYRIGHT &amp; LICENSE</a></li>
+<li><a href="#SEE_ALSO">SEE ALSO</a>
+</li>
+</ul><hr />
+<!-- INDEX END -->
+
+<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="NAME_CONTENT">
+<p>SDLx::Rect - SDL extension for storing and manipulating rectangular coordinates</p>
+
+</div>
+<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="CATEGORY_CONTENT">
+<p>Extension</p>
+
+</div>
+<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SYNOPSIS_CONTENT">
+<p>SDLx::Rect works as a SDL::Rect in the lower layer (SDL::*) but provides more methods to users.</p>
+<pre>  use SDLx::Rect; #instead of SDL::Rect
+
+       my $rect = SDLx::Rect-&gt;new( $x, $y, $w, $h); #same as SDL::Rect
+
+       ...
+
+       SDL::Video::fill_rect( .. , $rect, ...); # use like SDL::Rect
+
+
+
+
+</pre>
+
+</div>
+<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="DESCRIPTION_CONTENT">
+<p><code>SDLx::Rect</code> object are used to store and manipulate rectangular areas. Rect objects are created from a combination of left (or x), top (or y), width (or w) and height (or h) values, just like raw <code>SDL::Rect objects</code>.</p>
+<p>All <code>SDLx::Rect</code> methods that change either position or size of a Rect return <strong>a new copy</strong> of the Rect with the affected changes. The original Rect is <strong>not</strong> modified. If you wish to modify the current Rect object, you can use the equivalent &quot;in-place&quot; methods that do not return but instead affects the original Rect. These &quot;in-place&quot; methods are denoted with the &quot;ip&quot; suffix. Note that changing a Rect's attribute is <i>always</i> an in-place operation.</p>
+
+
+
+
+
+</div>
+<h2 id="ATTRIBUTES">ATTRIBUTES</h2>
+<div id="ATTRIBUTES_CONTENT">
+<p>All Rect attributes are acessors, meaning you can get them by name, and set them by passing a value:</p>
+<pre>   $rect-&gt;left(15);
+   $rect-&gt;left;       # 15
+
+</pre>
+<p>The Rect object has several attributes which can be used to resize, move and align the Rect.</p>
+
+
+
+
+<dl>
+       <dt>* width, w - gets/sets object's width</dt>
+       <dt>* height, h - gets/sets object's height</dt>
+       <dt>* left, x - moves the object left position to match the given coordinate</dt>
+       <dt>* top, y  - moves the object top position to match the given coordinate</dt>
+       <dt>* bottom - moves the object bottom position to match the given coordinate</dt>
+       <dt>* right - moves the object right position to match the given coordinate</dt>
+       <dt>* centerx - moves the object's horizontal center to match the given coordinate</dt>
+       <dt>* centery - moves the object's vertical center to match the given coordinate</dt>
+</dl>
+<p>Some of the attributes above can be fetched or set in pairs:</p>
+<pre>  $rect-&gt;topleft(10, 15);   # top is now 10, left is now 15
+
+  my ($width, $height) = $rect-&gt;size;
+
+
+
+
+</pre>
+<dl>
+       <dt>* size - gets/sets object's size (width, height)</dt>
+       <dt>* topleft - gets/sets object's top and left positions</dt>
+       <dt>* midleft - gets/sets object's vertical center and left positions</dt>
+       <dt>* bottomleft - gets/sets object's bottom and left positions</dt>
+       <dt>* center - gets/sets object's center (horizontal(x), vertical(y))</dt>
+       <dt>* topright - gets/sets object's top and right positions</dt>
+       <dt>* midright - gets/sets object's vertical center and right positions</dt>
+       <dt>* bottomright - gets/sets object's bottom and right positions</dt>
+       <dt>* midtop - gets/sets object's horizontal center and top positions</dt>
+       <dt>* midbottom - gets/sets object's horizontal center and bottom positions</dt>
+</dl>
+
+
+
+
+
+</div>
+<h2 id="METHODS">METHODS </h2>
+<div id="METHODS_CONTENT">
+<p>Methods denoted as receiving Rect objects can receive either <code>&lt;SDLx::Rect</code>&gt; or raw <code>&lt;SDL::Rect</code>&gt; objects.</p>
+
+</div>
+<h3 id="new_left_top_width_height">new ($left, $top, $width, $height)</h3>
+<div id="new_left_top_width_height_CONTENT">
+<p>Returns a new Rect object with the given coordinates. If any value is omitted (by passing undef), 0 is used instead.</p>
+
+</div>
+<h3 id="copy">copy</h3>
+<div id="copy_CONTENT">
+
+</div>
+<h3 id="duplicate">duplicate</h3>
+<div id="duplicate_CONTENT">
+<p>Returns a new Rect object having the same position and size as the original</p>
+
+</div>
+<h3 id="move_x_y">move(x, y)</h3>
+<div id="move_x_y_CONTENT">
+<p>Returns a new Rect that is moved by the given offset. The x and y arguments can be any integer value, positive or negative.</p>
+
+</div>
+<h3 id="move_ip_x_y">move_ip(x, y)</h3>
+<div id="move_ip_x_y_CONTENT">
+<p>Same as <code>&lt;move</code>&gt; above, but moves the current Rect in place and returns nothing.</p>
+
+</div>
+<h3 id="inflate_x_y">inflate(x, y)</h3>
+<div id="inflate_x_y_CONTENT">
+<p>Grows or shrinks the rectangle. Returns a new Rect with the size changed by the given offset. The rectangle remains centered around its current center. Negative values will return a shrinked rectangle instead.</p>
+
+</div>
+<h3 id="inflate_ip_x_y">inflate_ip(x, y)</h3>
+<div id="inflate_ip_x_y_CONTENT">
+<p>Same as <code>&lt;inflate</code>&gt; above, but grows/shrinks the current Rect in place and returns nothing.</p>
+
+</div>
+<h3 id="clamp_rect">clamp($rect)</h3>
+<div id="clamp_rect_CONTENT">
+<p>Returns a new Rect moved to be completely inside the Rect object passed as an argument. If the current Rect is too large to fit inside the passed Rect, it is centered inside it, but its size is not changed.</p>
+
+</div>
+<h3 id="clamp_ip_rect">clamp_ip($rect)</h3>
+<div id="clamp_ip_rect_CONTENT">
+<p>Same as <code>&lt;clamp</code>&gt; above, but moves the current Rect in place and returns nothing.</p>
+
+</div>
+<h3 id="clip_rect">clip($rect)</h3>
+<div id="clip_rect_CONTENT">
+<p>Returns a new Rect with the intersection between the two Rect objects, that is, returns a new Rect cropped to be completely inside the Rect object passed as an argument. If the two rectangles do not overlap to begin with, a Rect with 0 size is returned, in the original Rect's (x,y) coordinates.</p>
+
+</div>
+<h3 id="clip_ip_rect">clip_ip($rect)</h3>
+<div id="clip_ip_rect_CONTENT">
+<p>Same as <code>&lt;clip</code>&gt; above, but crops the current Rect in place and returns nothing. As the original method, the Rect becomes zero-sized if the two rectangles do not overlap to begin with, retaining its (x, y) coordinates.</p>
+
+</div>
+<h3 id="union_rect">union($rect)</h3>
+<div id="union_rect_CONTENT">
+<p>Returns a new rectangle that completely covers the area of the current Rect and the one passed as an argument. There may be area inside the new Rect that is not covered by the originals.</p>
+
+</div>
+<h3 id="union_ip_rect">union_ip($rect)</h3>
+<div id="union_ip_rect_CONTENT">
+<p>Same as <code>&lt;union</code>&gt; above, but resizes the current Rect in place and returns nothing.</p>
+
+</div>
+<h3 id="unionall_rect1_rect2">unionall( [$rect1, $rect2, ...] )</h3>
+<div id="unionall_rect1_rect2_CONTENT">
+<p>Returns the union of one rectangle with a sequence of many rectangles, passed as an ARRAY REF.</p>
+
+</div>
+<h3 id="unionall_ip_rect1_rect2">unionall_ip( [$rect1, $rect2, ...] )</h3>
+<div id="unionall_ip_rect1_rect2_CONTENT">
+<p>Same as <code>&lt;unionall</code>&gt; above, but resizes the current Rect in place and returns nothing.</p>
+
+</div>
+<h3 id="fit_rect">fit($rect)</h3>
+<div id="fit_rect_CONTENT">
+<p>Returns a new Rect moved and resized to fit the Rect object passed as an argument. The aspect ratio of the original Rect is preserved, so the new rectangle may be smaller than the target in either width or height. </p>
+
+</div>
+<h3 id="fit_ip_rect">fit_ip($rect)</h3>
+<div id="fit_ip_rect_CONTENT">
+<p>Same as <code>&lt;fit</code>&gt; above, but moves/resizes the current Rect in place and returns nothing.</p>
+
+</div>
+<h3 id="normalize">normalize</h3>
+<div id="normalize_CONTENT">
+<p>Corrects negative sizes, flipping width/height of the Rect if they have a negative size. No repositioning is made so the rectangle will remain in the same place, but the negative sides will be swapped. This method returns nothing.</p>
+
+</div>
+<h3 id="contains_rect">contains($rect)</h3>
+<div id="contains_rect_CONTENT">
+<p>Returns true (non-zero) when the argument is completely inside the Rect. Otherwise returns undef.</p>
+
+</div>
+<h3 id="collidepoint_x_y">collidepoint(x, y)</h3>
+<div id="collidepoint_x_y_CONTENT">
+<p>Returns true (non-zero) if the given point is inside the Rect, otherwise returns undef. A point along the right or bottom edge is not considered to be inside the rectangle.</p>
+
+</div>
+<h3 id="colliderect_rect">colliderect($rect)</h3>
+<div id="colliderect_rect_CONTENT">
+<p>Returns true (non-zero) if any portion of either rectangles overlap (except for the top+bottom or left+right edges).</p>
+
+</div>
+<h3 id="collidelist_rect1_rect2">collidelist( [$rect1, $rect2, ...] )</h3>
+<div id="collidelist_rect1_rect2_CONTENT">
+<p>Test whether the rectangle collides with any in a sequence of rectangles, passed as an ARRAY REF. The index of the first collision found is returned. Returns undef if no collisions are found.</p>
+
+</div>
+<h3 id="collidelistall_rect1_rect2">collidelistall( [$rect1, $rect2, ...] )</h3>
+<div id="collidelistall_rect1_rect2_CONTENT">
+<p>Returns an ARRAY REF of all the indices that contain rectangles that collide with the Rect. If no intersecting rectangles are found, an empty list ref is returned. </p>
+
+</div>
+<h3 id="collidehash_key1_gt_rect1_key2_gt_re">collidehash( {key1 =&gt; $rect1, key2 =&gt; $rect2, ...} )</h3>
+<div id="collidehash_key1_gt_rect1_key2_gt_re-2">
+<p>Receives a HASH REF and returns the a (key, value) list with the key and value of the first hash item that collides with the Rect. If no collisions are found, returns (undef, undef).</p>
+
+</div>
+<h3 id="collidehashall_key1_gt_rect1_key2_gt">collidehashall( {key1 =&gt; $rect1, key2 =&gt; $rect2, ...} )</h3>
+<div id="collidehashall_key1_gt_rect1_key2_gt-2">
+<p>Returns a HASH REF of all the key and value pairs that intersect with the Rect. If no collisions are found an empty hash ref is returned. </p>
+
+
+
+
+
+</div>
+<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="AUTHOR_CONTENT">
+<p>Breno G. de Oliveira, <code>&lt;garu at cpan.org&gt;</code></p>
+
+</div>
+<h1 id="BUGS">BUGS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="BUGS_CONTENT">
+<p>Please report any bugs or feature requests to the bug tracker. I will be notified, and then you'll automatically be notified of progress on your bug as we make changes.</p>
+
+
+
+
+
+</div>
+<h1 id="SUPPORT">SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SUPPORT_CONTENT">
+<p>You can find documentation for this module with the perldoc command.</p>
+<pre>    perldoc SDLx::Rect
+
+
+
+
+</pre>
+
+</div>
+<h1 id="ACKNOWLEDGEMENTS">ACKNOWLEDGEMENTS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="ACKNOWLEDGEMENTS_CONTENT">
+<p>Many thanks to all SDL_Perl contributors, and to the authors of pygame.rect, in which this particular module is heavily based.</p>
+
+</div>
+<h1 id="COPYRIGHT_amp_LICENSE">COPYRIGHT &amp; LICENSE</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="COPYRIGHT_amp_LICENSE_CONTENT">
+<p>Copyright 2009 Breno G. de Oliveira, all rights reserved.</p>
+<p>This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.</p>
+
+
+
+
+
+</div>
+<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SEE_ALSO_CONTENT">
+<p>perl, <a href="SDL.html">SDL</a>, <a href="SDL-Rect.html">SDL::Rect</a>, <a href="SDL-Game.html">SDL::Game</a>
+</p>
+
+</div>
+</div>
\ No newline at end of file
diff --git a/pages/SDLx-SFont.html-inc b/pages/SDLx-SFont.html-inc
new file mode 100644 (file)
index 0000000..4e753c4
--- /dev/null
@@ -0,0 +1,109 @@
+<div class="pod">
+<!-- INDEX START -->
+<h3 id="TOP">Index</h3>
+
+<ul><li><a href="#NAME">NAME</a></li>
+<li><a href="#CATEGORY">CATEGORY </a></li>
+<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#USAGE">USAGE</a></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="#COPYRIGHT">COPYRIGHT</a></li>
+<li><a href="#SEE_ALSO">SEE ALSO</a>
+</li>
+</ul><hr />
+<!-- INDEX END -->
+
+<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="NAME_CONTENT">
+<p>SDLx::SFont - Extension making fonts out of images and printing them</p>
+
+</div>
+<h1 id="CATEGORY">CATEGORY </h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="CATEGORY_CONTENT">
+<p>Extension</p>
+
+</div>
+<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SYNOPSIS_CONTENT">
+<pre>  use SDLx::SFont;
+  use SDLx::App;
+
+   #Make a surface
+   #Select a font
+   my $d = SDLx::App-&gt;new( -title =&gt; 'app', -width =&gt; 200, -height =&gt; 200, -depth =&gt; 32 );
+
+   my $font = SDLx::SFont-&gt;new('t/font.png');
+
+   #print using $font
+
+   SDLx::SFont::print_text( $d, 10, 10, 'Huh' );
+
+   my $font2 = SDLx::SFont-&gt;new('t/font2.png');
+
+   #print using font2
+
+   SDLx::SFont::print_text( $d, 10, 10, 'Huh' );
+
+   $font-&gt;use();
+
+   #print using $font
+
+   SDLx::SFont::print_text( $d, 10, 10, 'Huh' );
+
+   #that is it folks ..
+
+</pre>
+
+</div>
+<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="DESCRIPTION_CONTENT">
+<p>a simpler print function for old SDL::SFont dependency on Frozen-Bubble and Pangzero.</p>
+
+</div>
+<h1 id="USAGE">USAGE</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="USAGE_CONTENT">
+<p>see synopsis</p>
+
+</div>
+<h1 id="BUGS">BUGS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="BUGS_CONTENT">
+<p>You tell me! at sdlperl.ath.cx</p>
+
+</div>
+<h1 id="SUPPORT">SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SUPPORT_CONTENT">
+<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>    Kartik Thakore
+    CPAN ID: KTHAKORE
+    ---
+    kthakore@cpan.org
+    http://sdl.perl.org
+
+</pre>
+
+</div>
+<h1 id="COPYRIGHT">COPYRIGHT</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="COPYRIGHT_CONTENT">
+<p>This program is free software; you can redistribute
+it and/or modify it under the same terms as Perl itself.</p>
+<p>The full text of the license can be found in the
+LICENSE file included with this module.</p>
+
+
+
+
+
+</div>
+<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SEE_ALSO_CONTENT">
+<p>perl(1), SDL(2).</p>
+
+</div>
+</div>
\ No newline at end of file
diff --git a/pages/SDLx-Sprite.html-inc b/pages/SDLx-Sprite.html-inc
new file mode 100644 (file)
index 0000000..9f50564
--- /dev/null
@@ -0,0 +1,343 @@
+<div class="pod">
+<!-- INDEX START -->
+<h3 id="TOP">Index</h3>
+
+<ul><li><a href="#NAME">NAME</a></li>
+<li><a href="#CATEGORY">CATEGORY</a></li>
+<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#WARNING_VOLATILE_CODE_AHEAD">WARNING! VOLATILE CODE AHEAD</a></li>
+<li><a href="#METHODS">METHODS</a>
+<ul><li><a href="#new">new</a></li>
+<li><a href="#new_options">new( %options )</a></li>
+<li><a href="#load_filename">load( $filename )</a></li>
+<li><a href="#surface">surface()</a></li>
+<li><a href="#surface_SDL_Surface">surface( SDL::Surface )</a></li>
+<li><a href="#rect">rect()</a></li>
+<li><a href="#rect_SDL_Rect">rect( SDL::Rect )</a></li>
+<li><a href="#clip">clip()</a></li>
+<li><a href="#clip_SDL_Rect">clip( SDL::Rect )</a></li>
+<li><a href="#x">x()</a></li>
+<li><a href="#x_int">x( $int )</a></li>
+<li><a href="#y">y()</a></li>
+<li><a href="#y_int">y( $int )</a></li>
+<li><a href="#w">w()</a></li>
+<li><a href="#h">h()</a></li>
+<li><a href="#draw_SDL_Surface">draw( SDL::Surface )</a></li>
+</ul>
+</li>
+<li><a href="#AUTHORS">AUTHORS</a></li>
+<li><a href="#SEE_ALSO">SEE ALSO</a>
+</li>
+</ul><hr />
+<!-- INDEX END -->
+
+<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="NAME_CONTENT">
+<p>SDLx::Sprite - interact with images quick and easily in SDL</p>
+
+</div>
+<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="CATEGORY_CONTENT">
+<p>Extension</p>
+
+</div>
+<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SYNOPSIS_CONTENT">
+<pre>    use SDLx::Sprite;
+
+    my $sprite = SDLx::Sprite-&gt;new;
+
+    # loads image file into a SDL::Surface and
+    # automatically sets a SDL::Rect inside with
+    # that image's dimensions.
+    $sprite-&gt;load('hero.png');
+
+    # set sprite image transparency
+    $sprite-&gt;alpha_key( $color );
+    $sprite-&gt;alpha(0.5);
+
+    # you can set and check the sprite position anytime
+    say $sprite-&gt;x;   # rect-&gt;x shortcut accessor
+    $sprite-&gt;y(30);   # rect-&gt;y shortcut accessor
+
+    # read-only surface dimensions
+    $sprite-&gt;w;   # width
+    $sprite-&gt;h;   # height
+
+    # you can also fetch the full rect
+    # (think destination coordinates for -&gt;draw)
+    my $rect = $sprite-&gt;rect;
+
+    # you can get the surface object too if you need it
+    my $surface = $sprite-&gt;surface;
+
+    # rotation() 
+
+    # if your SDL has gfx, rotation is also straightforward:
+    $sprite-&gt;rotation( $degrees );
+    $sprite-&gt;rotation( $degrees, $smooth );
+
+
+
+
+    # add() / remove() NOT YET IMPLEMENTED
+    # you can also attach other sprites to it
+    $sprite-&gt;add( armor =&gt; $other_sprite );
+    $sprite-&gt;remove('armor');
+
+    # blits $sprite (and attached sprites) into $screen,
+    # in the (x,y) coordinates of the sprite
+    $sprite-&gt;draw($screen);
+
+    # if you need to clip the original image/surface
+    # before drawing it
+    $sprite-&gt;clip-&gt;x(10);
+    $sprite-&gt;clip-&gt;y(3);
+    $sprite-&gt;clip-&gt;w(5);
+    $sprite-&gt;clip-&gt;h(5);
+
+    # ...or all at once:
+    $sprite-&gt;clip($x,$y,$w,$h);
+
+    # spawning can include almost all of the above:
+    my $sprite = SDLx::Sprite-&gt;new(
+              image   =&gt; 'hero.png',   # or surface =&gt; SDL::Surface
+              rect    =&gt; SDL::Rect,    # or x =&gt; $x, y =&gt; $y
+              clip    =&gt; SDL::Rect,
+              alpha_key =&gt; SDL::Color, # or [$r, $g, $b]
+              alpha     =&gt; 1,
+              rotation  =&gt; 45, # degrees
+         );
+
+
+
+
+</pre>
+
+</div>
+<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="DESCRIPTION_CONTENT">
+<p>SDLx::Sprite is a SDL::Surface on steroids! It let's you quickly
+load, setup and interact with images in your SDL application, abstracting
+all the drudge code and letting you concentrate on your app's logic instead.</p>
+<p>This module automatically creates and holds SDL::Rect objects for the source
+and destination surfaces, and provides several surface manipulation options
+like alpha blending and rotation.</p>
+
+</div>
+<h1 id="WARNING_VOLATILE_CODE_AHEAD">WARNING! VOLATILE CODE AHEAD</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="WARNING_VOLATILE_CODE_AHEAD_CONTENT">
+<p>This is a new module and the API is subject to change without notice.
+If you care, please join the discussion on the #sdl IRC channel in
+<i>irc.perl.org</i>. All thoughts on further improving the API are welcome.</p>
+<p>You have been warned :)</p>
+
+</div>
+<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="METHODS_CONTENT">
+
+</div>
+<h2 id="new">new</h2>
+<div id="new_CONTENT">
+
+</div>
+<h2 id="new_options">new( %options )</h2>
+<div id="new_options_CONTENT">
+<p>Creates a new SDLx::Sprite object. No option is mandatory.
+Available options are:</p>
+<dl>
+       <dt>* image =&gt; $filename</dt>
+       <dd>
+               <p>Uses $filename as source image for the Sprite's surface. See suported
+formats in <a href="SDL-Image.html">SDL::Image</a>. This option <strong>cannot</strong> be used together
+with the 'surface' option (see below).</p>
+       </dd>
+       <dt>* surface =&gt; SDL::Surface</dt>
+       <dd>
+               <p>Uses the provided <a href="SDL-Surface.html">SDL::Surface</a> object as source surface for this
+sprite, instead of creating one automatically. This option <strong>cannot</strong> be
+used together with the 'image' option (see above).</p>
+       </dd>
+       <dt>* clip =&gt; SDL::Rect</dt>
+       <dd>
+               <p>Uses the provided <a href="SDL-Rect.html">SDL::Rect</a> object as clipping rect for the source
+surface. This means the object will only blit that particular area from
+the surface.</p>
+       </dd>
+       <dt>* rect =&gt; SDL::Rect</dt>
+       <dd>
+               <p>Uses the provided <a href="SDL-Rect.html">SDL::Rect</a> object as destination coordinates to
+whatever surface you call draw() on. You <strong>cannot</strong> use this option together
+with 'x' and 'y' (see below)</p>
+       </dd>
+       <dt>* x =&gt; $x</dt>
+       <dd>
+               <p>Uses $x as the x-axis (left-to-right, 0 being leftmost) positioning of
+the Sprite into the destination you call draw() upon. This option <strong>cannot</strong>
+be used together with 'rect' (see above).</p>
+       </dd>
+       <dt>* y =&gt; $y</dt>
+       <dd>
+               <p>Uses $y as the y-axis (top-to-bottom, 0 being topmost) positioning of
+the Sprite into the destination you call draw() upon. This option <strong>cannot</strong>
+be used together with 'rect' (see above).</p>
+       </dd>
+       <dt>* draw_xy =&gt; $surface, $x, $y</dt>
+       <dd>
+               <p>A shortcut to draw at coordinates quickly. Calles x() , y() and draw()</p>
+       </dd>
+       <dt>* rotation =&gt; $degrees, [$smooth]</dt>
+       <dd>
+               <p>Uses $degrees as the angle to rotate the surface to, in degrees
+(0..360, remember? :). This option is only available if your compiled SDL
+library has support for GFX (see <a href="http://search.cpan.org/perldoc?Alien::SDL">Alien::SDL</a> for details).</p>
+               <p>if $smooth is set the spirte is antialiased. This may mess with your alpha_key.</p>
+       </dd>
+       <dt>* alpha_key =&gt; SDL::Color</dt>
+       <dd>
+               <p>MUST CALL <a href="/SDL-Video.html#get_video_mode">SDL::Video::get_video_mode</a> prior to this. </p>
+               <p>Uses the provided <a href="SDL-Color.html">SDL::Color</a> object (or an array reference with red,
+green and blue values) as the color to be turned into transparent
+(see 'alpha' below).</p>
+       </dd>
+       <dt>* alpha =&gt; $percentage or $integer</dt>
+       <dd>
+
+
+
+
+               <p>Uses $percentage (0 &lt;-&gt; 1 ) or $integer ( 0x01 - 0xff) as how much transparency to add to the surface. If you use
+this, it is mandatory that you also provide the alpha_key (see above).</p>
+       </dd>
+</dl>
+
+</div>
+<h2 id="load_filename">load( $filename )</h2>
+<div id="load_filename_CONTENT">
+<p>Loads the given image file into the object's internal surface. A new surface
+is <strong>always</strong> created, so whatever you had on the previous surface will be
+lost. Croaks on errors such as no support built for the image or a file
+reading error (the error message is SDL::get_error and should give more
+details).</p>
+<p>Returns the own Sprite object, to allow method chaining.</p>
+
+</div>
+<h2 id="surface">surface()</h2>
+<div id="surface_CONTENT">
+
+</div>
+<h2 id="surface_SDL_Surface">surface( SDL::Surface )</h2>
+<div id="surface_SDL_Surface_CONTENT">
+<p>Returns the object's internal surface, or undef if there is none.</p>
+<p>If you pass a SDL::Surface to it, it will overwrite the original surface
+with it, while returning the <strong>old</strong> (previous) surface. Note that, as such,
+it will return <code>undef</code> if you use it without having previously loaded
+either an image or a previous surface. It will croak if you pass anything
+that's not an SDL::Surface object (or SDL::Surface subclassed objects).</p>
+
+</div>
+<h2 id="rect">rect()</h2>
+<div id="rect_CONTENT">
+
+</div>
+<h2 id="rect_SDL_Rect">rect( SDL::Rect )</h2>
+<div id="rect_SDL_Rect_CONTENT">
+<p>Returns the destination <a href="SDL-Rect.html">SDL::Rect</a> object used when you call draw().</p>
+<p>If you haven't explicitly set it, it will be a SDL::Rect with the same
+dimensions as the object's internal surface. If no surface was set yet,
+it will be an empty SDL::Rect (dimensions 0,0,0,0).</p>
+<p>If you pass it a <a href="SDL-Rect.html">SDL::Rect</a> object, it will set rect() to that object
+before returning, but it will <strong>overwrite</strong> any width and height values, as
+those are read only and set to the size of the underlying surface.</p>
+<p>If you want to clip the source surface, set clip() instead.</p>
+
+</div>
+<h2 id="clip">clip()</h2>
+<div id="clip_CONTENT">
+
+</div>
+<h2 id="clip_SDL_Rect">clip( SDL::Rect )</h2>
+<div id="clip_SDL_Rect_CONTENT">
+<p>Returns the source <a href="SDL-Rect.html">SDL::Rect</a> object used when you call draw().</p>
+<p>You can use this method to choose only a small subset of the object's
+internal surface to be used on calls to draw().</p>
+<p>If you haven't explicitly set it, it will be a SDL::Rect with the same
+dimensions as the object's internal surface. If no surface was set yet,
+it will be an empty SDL::Rect (dimensions 0,0,0,0).</p>
+<p>If you pass it a <a href="SDL-Rect.html">SDL::Rect</a> object, it will set clip() to that object
+before returning.</p>
+
+</div>
+<h2 id="x">x()</h2>
+<div id="x_CONTENT">
+
+</div>
+<h2 id="x_int">x( $int )</h2>
+<div id="x_int_CONTENT">
+<p>Gets/sets the x-axis (left-to-right, 0 being leftmost) positioning of
+the Sprite into the destination you call draw() upon.</p>
+<p>It is a shortcut to <code>$sprite-&gt;rect-&gt;x</code>.</p>
+
+
+
+
+
+</div>
+<h2 id="y">y()</h2>
+<div id="y_CONTENT">
+
+</div>
+<h2 id="y_int">y( $int )</h2>
+<div id="y_int_CONTENT">
+<p>Gets/sets the y-axis (top-to-bottom, 0 being topmost) positioning of
+the Sprite into the destination you call draw() upon.</p>
+<p>It is a shortcut to <code>$sprite-&gt;rect-&gt;y</code>.</p>
+
+
+
+
+
+</div>
+<h2 id="w">w()</h2>
+<div id="w_CONTENT">
+<p>Returns the Sprite surface's width. This method is read-only.</p>
+<p>It is a shortcut to <code>$sprite-&gt;surface-&gt;w</code>.</p>
+
+
+
+
+
+</div>
+<h2 id="h">h()</h2>
+<div id="h_CONTENT">
+<p>Returns the Sprite surface's height. This method is read-only.</p>
+<p>It is a shortcut to <code>$sprite-&gt;surface-&gt;h</code>.</p>
+
+
+
+
+
+</div>
+<h2 id="draw_SDL_Surface">draw( SDL::Surface )</h2>
+<div id="draw_SDL_Surface_CONTENT">
+<p>Draws the Sprite on the provided SDL::Surface object - usually the screen -
+using the blit_surface SDL function, using the source rect from clip() and the
+destination rect (position) from rect().</p>
+<p>Returns the own Sprite object, to allow method chaining.</p>
+
+</div>
+<h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="AUTHORS_CONTENT">
+<p>Dustin Mays, <code>&lt;dork.fish.wat@gmail.com&gt;</code></p>
+<p>Breno G. de Oliveira, <code>&lt;garu at cpan.org&gt;</code></p>
+<p>Kartik thakore <code>&lt;kthakore at cpan.org&gt;</code></p>
+
+</div>
+<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SEE_ALSO_CONTENT">
+<p><a href="SDL-Surface.html">SDL::Surface</a>, <a href="SDL.html">SDL</a>
+</p>
+
+</div>
+</div>
\ No newline at end of file
diff --git a/pages/SDLx-Surface.html-inc b/pages/SDLx-Surface.html-inc
new file mode 100644 (file)
index 0000000..195a24d
--- /dev/null
@@ -0,0 +1,148 @@
+<div class="pod">
+<!-- INDEX START -->
+<h3 id="TOP">Index</h3>
+
+<ul><li><a href="#NAME">NAME</a></li>
+<li><a href="#CATEGORY">CATEGORY</a></li>
+<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#METHODS">METHODS</a>
+<ul><li><a href="#new">new</a></li>
+<li><a href="#surface">surface</a></li>
+<li><a href="#get_display">get_display</a></li>
+</ul>
+</li>
+<li><a href="#EXTENSIONS">EXTENSIONS</a>
+<ul><li><a href="#blit">blit </a></li>
+<li><a href="#flip">flip</a></li>
+<li><a href="#update">update</a></li>
+</ul>
+</li>
+<li><a href="#AUTHOR">AUTHOR</a>
+</li>
+</ul><hr />
+<!-- INDEX END -->
+
+<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="NAME_CONTENT">
+<p>SDLx::Surface - Graphic surface matrix extension</p>
+
+</div>
+<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="CATEGORY_CONTENT">
+<p>Extension</p>
+
+</div>
+<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="SYNOPSIS_CONTENT">
+<pre> use SDL;
+ use SDL::Video;
+ use SDLx::Surface;
+
+ # Create the main surface (display)
+ SDL::init(SDL_INIT_VIDEO);
+ my $display = SDL::Video::set_video_mode(640, 480, 16, SDL_SWSURFACE);
+
+ my $surf_matrix = SDLx::Surface-&gt;new( surface =&gt; $display);
+
+ $surf__matrix-&gt;[10][10] = 0xFFFF; #for 16bpp write white at x = 10 and y=10
+
+ $surf_matrix-&gt;surface( $new_surface );
+
+ my $orig_surface = $surf_matrix-&gt;surface();
+
+</pre>
+
+</div>
+<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="DESCRIPTION_CONTENT">
+<p>An <code>SDLx::Surface</code> allows matrix read and write to a surface, safely. </p>
+
+</div>
+<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="METHODS_CONTENT">
+
+</div>
+<h2 id="new">new</h2>
+<div id="new_CONTENT">
+<p>Takes a SDL::Surface in hash format.</p>
+<p>If a surface is passed to 'surface =&gt;' that is loaded. Otherwise you can define at least a width and a height. </p>
+<pre>  SDLx::Surface-&gt;new(  surface =&gt; $surface) # The $surface is loaded
+
+       SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200) 
+               # A SDL::Surface-&gt;new( SDL_ANYFORMAT, 400, 200, 32) is loaded
+
+       SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200, flags=&gt; SDL_SWSURFACE, depth=&gt;24 ) 
+               # A SDL::Surface-&gt;new( SDL_SWSURFACE, 400, 200, 24) is loaded 
+
+       SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200, flags=&gt; SDL_SWSURFACE, depth=&gt;32, greenmask=&gt;0xFF000000 )
+               # A SDL::Surface-&gt;new( SDL_ANYFORMAT, 400, 200, 32, 0, 0xFF000000,0, 0, 0 ) is loaded
+
+</pre>
+
+</div>
+<h2 id="surface">surface</h2>
+<div id="surface_CONTENT">
+<p>If a SDL::Surface is passed it is attached to the matrix. Returns the SDL::Surface that is currently attached to this SDLx::Surface</p>
+
+</div>
+<h2 id="get_display">get_display</h2>
+<div id="get_display_CONTENT">
+<p>If <a href="http://search.cpan.org/perldoc?SDLx::App::new">SDLx::App::new</a> or <a href="/SDL-Video.html#get_video_mode">SDL::Video::get_video_mode</a> called before then:</p>
+<pre> my $appx = SDLx::Surface::get_display(); 
+
+</pre>
+<p>gets the display if it is already made. Passed options are ignored. Otherwise you can quickly make the display with :</p>
+<pre> SDLx::Surface::get_display( width =&gt; 20, height =&gt; 20) #depth =&gt; 32 and SDL_ANYFORMAT used
+
+</pre>
+<p>or you can also pass flags and depth. </p>
+<pre> SDLx::Surface::get_display( width =&gt; 20, height =&gt; 20, flags=&gt; SDL_HWSURFACE, depth=&gt;24) 
+
+</pre>
+<p>Get or create the main display surface and attach to a SDLx::Surface.</p>
+
+</div>
+<h1 id="EXTENSIONS">EXTENSIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="EXTENSIONS_CONTENT">
+
+</div>
+<h2 id="blit">blit </h2>
+<div id="blit_CONTENT">
+<pre> $sdlx_surface-&gt;blit( $dest, $src_rect, $dest_rect );
+
+</pre>
+<p>Blits SDLx::Surface onto $dest surface. 
+$src_rect or $dest_rect are optional. $src_rect or $dest_rect can be array refs or SDL::Rect. $dest can be SDLx::Surface or SDL::Surface. </p>
+<p>Returns $self</p>
+
+</div>
+<h2 id="flip">flip</h2>
+<div id="flip_CONTENT">
+<p>Applies <a href="/SDL-Video.html#flip">SDL::Video::flip</a> to the Surface, with error checking.</p>
+<p>Returns $self</p>
+
+</div>
+<h2 id="update">update</h2>
+<div id="update_CONTENT">
+<pre> $sdlx_surface-&gt;update(); # whole surface is updated
+ $sdlx_surface-&gt;update([0,0,1,1]); # only that area (0,0,1,1) is updated
+
+ $sdlx_surface-&gt;update( [ SDL::Rect-&gt;new(0,0,1,2) ... ]); # defined rects are updated
+
+</pre>
+<p>Applies <a href="/SDL-Video.html#update_rect">SDL::Video::update_rect</a> for no rect or 1 array ref. Applies <a href="/SDL-Video.html#update_rects">SDL::Video::update_rects</a> for array of <a href="SDL-Rect.html">SDL::Rect</a>s. </p>
+<p>Returns $self</p>
+
+</div>
+<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="AUTHOR_CONTENT">
+<pre> kthakore 
+
+
+
+
+</pre>
+
+</div>
+</div>
\ No newline at end of file