5 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
7 # ------------------------------------------------------------------------------
9 # This library is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public
11 # License as published by the Free Software Foundation; either
12 # version 2.1 of the License, or (at your option) any later version.
14 # This library is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with this library; if not, write to the Free Software
21 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 # ------------------------------------------------------------------------------
25 # Please feel free to send questions, suggestions or improvements to:
36 my $class = ref($proto) || $proto;
39 verify (%options, qw/ -data -mask -x -y /) if $SDL::DEBUG;
41 my $self = \SDL::NewCursor($options{-data},$options{-mask},
42 $options{-x},$options{-y});
43 die SDL::GetError() unless $$self;
50 SDL::FreeCursor($$self);
54 my ($self,$x,$y) = @_;
55 SDL::WarpMouse($x,$y);
60 SDL::SetCursor($$self);
68 my ($self,$toggle) = @_;
69 SDL::ShowCursor($toggle);
82 SDL::Cursor - a SDL perl extension
86 $cursor = SDL::Cursor->new(
87 -data => new SDL::Surface "cursor.png",
88 -mask => new SDL::Surface "mask.png",
94 the SDL::Cursor module handles mouse cursors, and provide the developer to
95 use custom made cursors. Note that the cursors can only be in black and
100 =head2 new( -data => $surface_data, -mask => $surface_mask, x => $x, y => $y)
102 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'.
106 Set the position of the cursor at the <C>$x</C>, <C>$y</C> coordinates in the application window.
110 Set the cursor as the active cursor.
114 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.
116 This method can be useful if you are dealing with several cursors.
120 Set the visibility of the cursor. A false value will make the cursor
121 invisible in the Application window. A true value will show it back.
129 L<perl> L<SDL::Surface>