lib/SDL/Cursor.pm

   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 use warnings;
  34 use Carp;
  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
  43
  44         my $self = \SDL::NewCursor($options{-data},$options{-mask},
  45                                 $options{-x},$options{-y});
  46         croak SDL::GetError() unless $$self;
  47         bless $self, $class;
  48         $self;
  49 }
  50
  51 sub DESTROY ($) {
  52         my $self = shift;
  53         SDL::FreeCursor($$self);
  54 }
  55
  56 sub warp ($$$) {
  57         my ($self,$x,$y) = @_;
  58         SDL::WarpMouse($x,$y);
  59 }
  60
  61 sub use ($) {
  62         my $self = shift;
  63         SDL::SetCursor($$self);
  64 }
  65
  66 sub get () {
  67         SDL::GetCursor();
  68 }
  69
  70 sub show ($;$) {
  71         my ($self,$toggle) = @_;
  72         $toggle = 0 unless defined $toggle;
  73         SDL::ShowCursor($toggle);
  74 }
  75
  76 1;
  77
  78 __END__;
  79
  80 =pod
  81
  82
  83
  84 =head1 NAME
  85
  86 SDL::Cursor - a SDL perl extension
  87
  88 =head1 SYNOPSIS
  89
  90   $cursor = SDL::Cursor->new(
  91         -data => new SDL::Surface "cursor.png",
  92         -mask => new SDL::Surface "mask.png",
  93         -x    => 0, -y => 0 );
  94   $cusor->use;
  95
  96 =head1 DESCRIPTION
  97
  98 the SDL::Cursor module handles mouse cursors, and provide the developer to
  99 use custom made cursors. Note that the cursors can only be in black and
 100 white.
 101
 102 =head1 METHODS
 103
 104 =head2 new( -data => $surface_data, -mask => $surface_mask, x => $x, y => $y)
 105
 106 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'.
 107
 108 =head2 warp($x, $y)
 109
 110 Set the position of the cursor at the <C>$x</C>, <C>$y</C> coordinates in the application window.
 111
 112 =head2 use()
 113
 114 Set the cursor as the active cursor.
 115
 116 =head2 get()
 117
 118 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.
 119
 120 This method can be useful if you are dealing with several cursors.
 121
 122 =head2 show($toggle)
 123
 124 Set the visibility of the cursor. A false value will make the cursor
 125 invisible in the Application window. A true value will show it back.
 126
 127 =head1 AUTHOR
 128
 129 David J. Goehrig
 130
 131 =head1 SEE ALSO
 132
 133 L<perl> L<SDL::Surface>
 134
 135 =cut