SDL::Cursor(3)						User Contributed Perl Documentation					    SDL::Cursor(3)

NAME

       SDL::Cursor - a SDL perl extension

SYNOPSIS

	 $cursor = SDL::Cursor->new(
	       -data => new SDL::Surface "cursor.png",
	       -mask => new SDL::Surface "mask.png",
	       -x    => 0, -y => 0 );
	 $cusor->use;

DESCRIPTION

       the SDL::Cursor module handles mouse cursors, and provide the developer to use custom made cursors. Note that the cursors can only be in
       black and white.

METHODS

   new( -data => $surface_data, -mask => $surface_mask, x => $x, y => $y)
       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'.

   warp($x, $y)
       Set the position of the cursor at the <C>$x</C>, <C>$y</C> coordinates in the application window.

   use()
       Set the cursor as the active cursor.

   get()
       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.

       This method can be useful if you are dealing with several cursors.

   show($toggle)
       Set the visibility of the cursor. A false value will make the cursor invisible in the Application window. A true value will show it back.

AUTHOR

       David J. Goehrig

SEE ALSO

       perl SDL::Surface

perl v5.12.1							    2010-07-05							    SDL::Cursor(3)