3 <h3 id="TOP">Index</h3>
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 => $surface_data, -mask => $surface_mask, x => $x, y => $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>
16 <li><a href="#AUTHOR">AUTHOR</a></li>
17 <li><a href="#SEE_ALSO">SEE ALSO</a>
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>
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->new(
30 -data => new SDL::Surface "cursor.png",
31 -mask => new SDL::Surface "mask.png",
32 -x => 0, -y => 0 );
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
45 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
46 <div id="METHODS_CONTENT">
49 <h2 id="new_data_gt_surface_data_mask_gt_sur">new( -data => $surface_data, -mask => $surface_mask, x => $x, y => $y)</h2>
50 <div id="new_data_gt_surface_data_mask_gt_sur-2">
51 <p>Creates a new cursor. The <C>-data</C> and <C>-mask</C> parameters should be both black and white pictures. The height and width of these surfaces should be a multiple of 8. The <C>-x</C> and <C>-y</C> are the coordinates of the cursor 'hot spot'.</p>
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 <C>x</C>, <C>y</C> coordinates in the application window.
58 SDL::warp trigger a new mouse motion event.
59 It doesn't returns anything.</p>
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>
67 <h2 id="get">get()</h2>
68 <div id="get_CONTENT">
69 <p>When used statically <C>SDL::Cursor::get()</C>, 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>
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>
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>
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>