docs
[sdlgit/SDL-Site.git] / 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 </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>  $cursor = SDL::Cursor-&gt;new(
26         -data =&gt; new SDL::Surface &quot;cursor.png&quot;,
27         -mask =&gt; new SDL::Surface &quot;mask.png&quot;,
28         -x    =&gt; 0, -y =&gt; 0 );
29   $cusor-&gt;use;
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 SDL::Cursor 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_data_gt_surface_data_mask_gt_sur">new( -data =&gt; $surface_data, -mask =&gt; $surface_mask, x =&gt; $x, y =&gt; $y)</h2>
46 <div id="new_data_gt_surface_data_mask_gt_sur-2">
47 <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>
48
49 </div>
50 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
51 <div id="AUTHOR_CONTENT">
52 <p>David J. Goehrig, Tobias Leich</p>
53
54 </div>
55 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
56 <div id="SEE_ALSO_CONTENT">
57 <p><cite>perl</cite> <cite>SDL::Mouse</cite></p>
58
59 </div>
60 </div>