Commit | Line | Data |
7b6a53a1 |
1 | #!/usr/bin/env perl |
2 | # |
8fde61e3 |
3 | # Cursor.pm |
4 | # |
7b6a53a1 |
5 | # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org> |
6 | # |
7 | # ------------------------------------------------------------------------------ |
8 | # |
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. |
13 | # |
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. |
18 | # |
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 |
22 | # |
23 | # ------------------------------------------------------------------------------ |
24 | # |
25 | # Please feel free to send questions, suggestions or improvements to: |
26 | # |
27 | # David J. Goehrig |
28 | # dgoehrig@cpan.org |
8fde61e3 |
29 | # |
30 | |
31 | package SDL::Cursor; |
32 | use strict; |
084b921f |
33 | use warnings; |
34 | use Carp; |
8fde61e3 |
35 | |
36 | sub new { |
37 | my $proto = shift; |
38 | my $class = ref($proto) || $proto; |
39 | my %options = @_; |
40 | |
41 | verify (%options, qw/ -data -mask -x -y /) if $SDL::DEBUG; |
42 | |
7b6a53a1 |
43 | die SDL::GetError() unless $$self; |
8fde61e3 |
44 | my $self = \SDL::NewCursor($options{-data},$options{-mask}, |
45 | $options{-x},$options{-y}); |
46 | bless $self, $class; |
47 | $self; |
48 | } |
49 | |
50 | sub DESTROY ($) { |
51 | my $self = shift; |
52 | SDL::FreeCursor($$self); |
53 | } |
54 | |
55 | sub warp ($$$) { |
56 | my ($self,$x,$y) = @_; |
57 | SDL::WarpMouse($x,$y); |
58 | } |
59 | |
60 | sub use ($) { |
61 | my $self = shift; |
62 | SDL::SetCursor($$self); |
63 | } |
64 | |
65 | sub get () { |
66 | SDL::GetCursor(); |
67 | } |
68 | |
69 | sub show ($;$) { |
70 | my ($self,$toggle) = @_; |
71 | SDL::ShowCursor($toggle); |
72 | } |
73 | |
74 | 1; |
75 | |
76 | __END__; |
77 | |
78 | =pod |
79 | |
80 | |
81 | |
82 | =head1 NAME |
83 | |
84 | SDL::Cursor - a SDL perl extension |
85 | |
86 | =head1 SYNOPSIS |
87 | |
88 | $cursor = SDL::Cursor->new( |
89 | -data => new SDL::Surface "cursor.png", |
90 | -mask => new SDL::Surface "mask.png", |
91 | -x => 0, -y => 0 ); |
92 | $cusor->use; |
93 | |
94 | =head1 DESCRIPTION |
95 | |
96 | the SDL::Cursor module handles mouse cursors, and provide the developer to |
97 | use custom made cursors. Note that the cursors can only be in black and |
98 | white. |
99 | |
100 | =head1 METHODS |
101 | |
102 | =head2 new( -data => $surface_data, -mask => $surface_mask, x => $x, y => $y) |
103 | |
104 | 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'. |
105 | |
106 | =head2 warp($x, $y) |
107 | |
108 | Set the position of the cursor at the <C>$x</C>, <C>$y</C> coordinates in the application window. |
109 | |
110 | =head2 use() |
111 | |
112 | Set the cursor as the active cursor. |
113 | |
114 | =head2 get() |
115 | |
116 | 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. |
117 | |
118 | This method can be useful if you are dealing with several cursors. |
119 | |
120 | =head2 show($toggle) |
121 | |
122 | Set the visibility of the cursor. A false value will make the cursor |
123 | invisible in the Application window. A true value will show it back. |
124 | |
125 | =head1 AUTHOR |
126 | |
127 | David J. Goehrig |
128 | |
129 | =head1 SEE ALSO |
130 | |
131 | L<perl> L<SDL::Surface> |
132 | |
133 | =cut |