docs for SDL::Mouse

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

<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="#METHODS">METHODS</a>
<ul><li><a href="#new">new</a></li>
</ul>
</li>
<li><a href="#AUTHOR">AUTHOR</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>SDL::Cursor - a SDL perl extension</p>

</div>
<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="SYNOPSIS_CONTENT">
<pre> my $cursor = SDL::Cursor-&gt;new(
     SDL::Video::load_BMP(&quot;cursor.png&quot;),
     SDL::Video::load_BMP(&quot;mask.png&quot;),
	 0, 0 );
 SDL::Mouse::set_cursor($cursor);

</pre>

</div>
<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="DESCRIPTION_CONTENT">
<p>the <code>SDL::Cursor</code> module handles mouse cursors, and provide the developer to
use custom made cursors. Note that the cursors can only be in black and
white.</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">
<pre> object new( object $data, object $mask, int $x, int $y )

</pre>
<p>Creates a new cursor. The <code>data</code> and <code>mask</code> parameters should be both black and white pictures. The height and width of these surfaces 
should be a multiple of 8. The <code>x</code> and <code>y</code> are the coordinates of the cursor 'hot spot'.</p>

</div>
<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="AUTHOR_CONTENT">
<p>David J. Goehrig, Tobias Leich</p>

</div>
<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="SEE_ALSO_CONTENT">
<p><cite>perl</cite> <cite>SDL::Mouse</cite></p>

</div>
</div>