.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "pods::SDL::Cursor 3pm"
.TH pods::SDL::Cursor 3pm "2020-11-09" "perl v5.32.0" "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 \s-1MSB\s0 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(CW\*(C`SDL::Mouse::show_cursor(SDL_DISABLE)\*(C'\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 \*(L"\s-1AUTHORS\*(R"\s0 in \s-1SDL\s0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl SDL::Mouse