.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::Cursor 3pm"
.TH pods::SDL::Cursor 3pm 2024-03-28 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::Cursor \- Mouse cursor structure
.SH CATEGORY
.IX Header "CATEGORY"
Core, Mouse, Structure
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 8
\& my $cursor = SDL::Cursor\->new(
\&     \e@data,
\&     \e@mask,
\&     $width,
\&     $height,
\&     $hotspot_left,
\&     $hotspot_top
\& );
\&
\& SDL::Mouse::set_cursor($cursor);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`SDL::Cursor\*(C'\fR module handles mouse cursors, and allows the developer to use custom-made cursors.
Note that cursors can only be in black and white.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 3
\& my $cursor = SDL::Cursor\->new(
\&     \e@data, \e@mask, $width, $height, $hotspot_left, $hotspot_top
\& );
.Ve
.PP
Create a cursor using the specified data and mask (in MSB format).
The cursor is created in black and white according to the following:
.PP
.Vb 5
\& Data / Mask   Resulting pixel on screen
\&    0 / 1      White
\&    1 / 1      Black
\&    0 / 0      Transparent
\&    1 / 0      Inverted color if possible, black if not.
.Ve
.PP
If you want to have color cursor, then this function is not for you.
Instead, you should hide the cursor with \f(CWSDL::Mouse::show_cursor(SDL_DISABLE)\fR.
Then in your main loop, when you draw graphics, draw a \f(CW\*(C`SDL::Surface\*(C'\fR at the location of the mouse cursor.
.PP
Example:
.PP
.Vb 4
\& use SDL;
\& use SDL::Video;
\& use SDL::Mouse;
\& use SDL::Cursor;
\&
\& SDL::init(SDL_INIT_VIDEO);
\& SDL::Video::set_video_mode(640, 480, 16, SDL_SWSURFACE);
\&
\& my @data = (
\&     0b00000000,
\&     0b00111100,
\&     0b01111110,
\&     0b01111110,
\&     0b01111110,
\&     0b01111110,
\&     0b00111100,
\&     0b00000000
\& );
\& my @mask = (
\&     0b00111100,
\&     0b01111110,
\&     0b11100111,
\&     0b11000011,
\&     0b11000011,
\&     0b11100111,
\&     0b01111110,
\&     0b00111100
\& );
\& my $cursor = SDL::Cursor\->new(\e@data, \e@mask, 8, 8, 0, 0);
\& sleep(1);
\&
\& SDL::Mouse::set_cursor($cursor);
\& sleep(5);
.Ve
.PP
The width of cursors work in groups of 8.
If the width is above 8, twice the amount of elements in \f(CW@data\fR and \f(CW@mask\fR are required.
If the width is above 16, three times are required, and so on.
For example, if you wanted a 9 pixel crosshair you might do the following:
.PP
.Vb 12
\& my @data = (
\&     0b00001000,0b00000000,
\&     0b00001000,0b00000000,
\&     0b00001000,0b00000000,
\&     0b00001000,0b00000000,
\&     0b11111111,0b10000000,
\&     0b00001000,0b00000000,
\&     0b00001000,0b00000000,
\&     0b00001000,0b00000000,
\&     0b00001000,0b00000000,
\& );
\& my @mask = @data;
\&
\& my $cursor = SDL::Cursor\->new(\e@data, \e@mask, 9, 9, 4, 4);
.Ve
.PP
The hotspot is offset by 4 pixels because a crosshair clicks from the center instead of the top left.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl SDL::Mouse