pages/SDL-Cursor.html-inc

   1 <div class="pod">
   2 <!-- INDEX START -->
   3 <h3 id="TOP">Index</h3>
   4
   5 <ul><li><a href="#NAME">NAME</a></li>
   6 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
   7 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
   8 <li><a href="#METHODS">METHODS</a>
   9 <ul><li><a href="#new">new</a></li>
  10 </ul>
  11 </li>
  12 <li><a href="#AUTHOR">AUTHOR</a></li>
  13 <li><a href="#SEE_ALSO">SEE ALSO</a>
  14 </li>
  15 </ul><hr />
  16 <!-- INDEX END -->
  17
  18 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
  19 <div id="NAME_CONTENT">
  20 <p>SDL::Cursor - a SDL perl extension</p>
  21
  22 </div>
  23 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  24 <div id="SYNOPSIS_CONTENT">
  25 <pre> my $cursor = SDL::Cursor-&gt;new(
  26      SDL::Video::load_BMP(&quot;cursor.png&quot;),
  27      SDL::Video::load_BMP(&quot;mask.png&quot;),
  28          0, 0 );
  29  SDL::Mouse::set_cursor($cursor);
  30
  31 </pre>
  32
  33 </div>
  34 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
  35 <div id="DESCRIPTION_CONTENT">
  36 <p>the <code>SDL::Cursor</code> module handles mouse cursors, and provide the developer to
  37 use custom made cursors. Note that the cursors can only be in black and
  38 white.</p>
  39
  40 </div>
  41 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  42 <div id="METHODS_CONTENT">
  43
  44 </div>
  45 <h2 id="new">new</h2>
  46 <div id="new_CONTENT">
  47 <pre> object new( object $data, object $mask, int $x, int $y )
  48
  49 </pre>
  50 <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
  51 should be a multiple of 8. The <code>x</code> and <code>y</code> are the coordinates of the cursor 'hot spot'.</p>
  52
  53 </div>
  54 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
  55 <div id="AUTHOR_CONTENT">
  56 <p>David J. Goehrig, Tobias Leich</p>
  57
  58 </div>
  59 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
  60 <div id="SEE_ALSO_CONTENT">
  61 <p><cite>perl</cite> <cite>SDL::Mouse</cite></p>
  62
  63 </div>
  64 </div>