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_data_gt_surface_data_mask_gt_sur">new( -data =&gt; $surface_data, -mask =&gt; $surface_mask, x =&gt; $x, y =&gt; $y)</a></li>
  10 <li><a href="#warp_cursor_x_y">warp(cursor,x, y)</a></li>
  11 <li><a href="#use_cursor">use(cursor)</a></li>
  12 <li><a href="#get">get()</a></li>
  13 <li><a href="#show_toggle">show($toggle)</a></li>
  14 </ul>
  15 </li>
  16 <li><a href="#AUTHOR">AUTHOR</a></li>
  17 <li><a href="#SEE_ALSO">SEE ALSO</a>
  18 </li>
  19 </ul><hr />
  20 <!-- INDEX END -->
  21
  22 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
  23 <div id="NAME_CONTENT">
  24 <p>SDL::Cursor - a SDL perl extension</p>
  25
  26 </div>
  27 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  28 <div id="SYNOPSIS_CONTENT">
  29 <pre>  $cursor = SDL::Cursor-&gt;new(
  30         -data =&gt; new SDL::Surface &quot;cursor.png&quot;,
  31         -mask =&gt; new SDL::Surface &quot;mask.png&quot;,
  32         -x    =&gt; 0, -y =&gt; 0 );
  33   $cusor-&gt;use;
  34
  35 </pre>
  36
  37 </div>
  38 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
  39 <div id="DESCRIPTION_CONTENT">
  40 <p>the SDL::Cursor module handles mouse cursors, and provide the developer to
  41 use custom made cursors. Note that the cursors can only be in black and
  42 white.</p>
  43
  44 </div>
  45 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  46 <div id="METHODS_CONTENT">
  47
  48 </div>
  49 <h2 id="new_data_gt_surface_data_mask_gt_sur">new( -data =&gt; $surface_data, -mask =&gt; $surface_mask, x =&gt; $x, y =&gt; $y)</h2>
  50 <div id="new_data_gt_surface_data_mask_gt_sur-2">
  51 <p>Creates a new cursor. The &lt;C&gt;-data&lt;/C&gt; and &lt;C&gt;-mask&lt;/C&gt; parameters should be both black and white pictures. The height and width of these surfaces should be a multiple of 8. The &lt;C&gt;-x&lt;/C&gt; and &lt;C&gt;-y&lt;/C&gt; are the coordinates of the cursor 'hot spot'.</p>
  52
  53 </div>
  54 <h2 id="warp_cursor_x_y">warp(cursor,x, y)</h2>
  55 <div id="warp_cursor_x_y_CONTENT">
  56 <p>Set the position of the SDL::Cursor given as first parameter .
  57 the new postion is set to &lt;C&gt;x&lt;/C&gt;, &lt;C&gt;y&lt;/C&gt; coordinates in the application window.
  58 SDL::warp trigger a new mouse motion event.
  59 It doesn't returns anything.</p>
  60
  61 </div>
  62 <h2 id="use_cursor">use(cursor)</h2>
  63 <div id="use_cursor_CONTENT">
  64 <p>Set the SDL::Cursor given as first parameter to the active cursor.</p>
  65
  66 </div>
  67 <h2 id="get">get()</h2>
  68 <div id="get_CONTENT">
  69 <p>When used statically &lt;C&gt;SDL::Cursor::get()&lt;/C&gt;, it will return the instance of the current cursor in use. Called as a method, it will return itself.</p>
  70 <p>This method can be useful if you are dealing with several cursors.</p>
  71
  72 </div>
  73 <h2 id="show_toggle">show($toggle)</h2>
  74 <div id="show_toggle_CONTENT">
  75 <p>Set the visibility of the cursor. A false value will make the cursor
  76 invisible in the Application window. A true value will show it back.</p>
  77
  78 </div>
  79 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
  80 <div id="AUTHOR_CONTENT">
  81 <p>David J. Goehrig</p>
  82
  83 </div>
  84 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
  85 <div id="SEE_ALSO_CONTENT">
  86 <p><cite>perl</cite> <cite>SDL::Surface</cite></p>
  87
  88 </div>
  89 </div>