Commit | Line | Data |
bfd90409 |
1 | #!/usr/bin/env perl |
2 | # |
3 | # Cursor.pm |
4 | # |
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 |
29 | # |
30 | |
31 | package SDL::Cursor; |
32 | use strict; |
33 | |
34 | sub new { |
35 | my $proto = shift; |
36 | my $class = ref($proto) || $proto; |
37 | my %options = @_; |
38 | |
39 | verify (%options, qw/ -data -mask -x -y /) if $SDL::DEBUG; |
40 | |
41 | my $self = \SDL::NewCursor($options{-data},$options{-mask}, |
42 | $options{-x},$options{-y}); |
43 | die SDL::GetError() unless $$self; |
44 | bless $self, $class; |
45 | $self; |
46 | } |
47 | |
48 | sub DESTROY ($) { |
49 | my $self = shift; |
50 | SDL::FreeCursor($$self); |
51 | } |
52 | |
53 | sub warp ($$$) { |
54 | my ($self,$x,$y) = @_; |
55 | SDL::WarpMouse($x,$y); |
56 | } |
57 | |
58 | sub use ($) { |
59 | my $self = shift; |
60 | SDL::SetCursor($$self); |
61 | } |
62 | |
63 | sub get () { |
64 | SDL::GetCursor(); |
65 | } |
66 | |
67 | sub show ($;$) { |
68 | my ($self,$toggle) = @_; |
69 | SDL::ShowCursor($toggle); |
70 | } |
71 | |
72 | 1; |
73 | |
74 | __END__; |
75 | |
76 | =pod |
77 | |
78 | |
79 | |
80 | =head1 NAME |
81 | |
82 | SDL::Cursor - a SDL perl extension |
83 | |
84 | =head1 SYNOPSIS |
85 | |
86 | $cursor = SDL::Cursor->new( |
87 | -data => new SDL::Surface "cursor.png", |
88 | -mask => new SDL::Surface "mask.png", |
89 | -x => 0, -y => 0 ); |
90 | $cusor->use; |
91 | |
92 | =head1 DESCRIPTION |
93 | |
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 |
96 | white. |
97 | |
98 | =head1 METHODS |
99 | |
100 | =head2 new( -data => $surface_data, -mask => $surface_mask, x => $x, y => $y) |
101 | |
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'. |
103 | |
104 | =head2 warp($x, $y) |
105 | |
106 | Set the position of the cursor at the <C>$x</C>, <C>$y</C> coordinates in the application window. |
107 | |
108 | =head2 use() |
109 | |
110 | Set the cursor as the active cursor. |
111 | |
112 | =head2 get() |
113 | |
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. |
115 | |
116 | This method can be useful if you are dealing with several cursors. |
117 | |
118 | =head2 show($toggle) |
119 | |
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. |
122 | |
123 | =head1 AUTHOR |
124 | |
125 | David J. Goehrig |
126 | |
127 | =head1 SEE ALSO |
128 | |
129 | L<perl> L<SDL::Surface> |
130 | |
131 | =cut |