This file is indexed.

/usr/lib/x86_64-linux-gnu/perl5/5.26/pods/SDL/Mouse.pod is in libsdl-perl 2.546-3build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
=pod

=head1 NAME

SDL::Mouse - SDL Bindings for the Mouse device

=head1 CATEGORY

Core, Mouse

=head1 CONSTANTS

The constants for SDL::Mouse belong to SDL::Events/SDL::Event, under the export tag of C<':state'>.

=head1 METHODS

=head2 warp_mouse

 SDL::Mouse::warp_mouse( $x, $y );

Set the position of the mouse cursor (generates a mouse motion event).
Even if the mouse is warped to where it currently is, a mouse motion event is generated.

=head2 set_cursor

 SDL::Mouse::set_cursor( $cursor_object );

Sets the currently active cursor to the specified one.
See L<SDL::Cursor> for details on cursor objects.
If the cursor is currently visible, the change will be immediately represented on the display.
C<set_cursor()> can be used to force cursor redraw, if this is desired for any reason.

=head2 get_cursor

 my $cursor_object = SDL::Mouse::get_cursor;

Gets the currently active mouse cursor.

=head2 show_cursor

 my $return = SDL::Mouse::show_cursor( $state );

Toggle whether or not the cursor is shown on the screen.
Passing C<SDL_ENABLE> displays the cursor and passing C<SDL_DISABLE> hides it.
The current state of the mouse cursor can be queried by passing C<SDL_QUERY>, either C<SDL_DISABLE> or C<SDL_ENABLE> will be returned.

 use SDL;
 use SDL::Mouse;
 use SDL::Video;
 use SDL::Events ':state'; #For the constants

 SDL::init(SDL_INIT_VIDEO);
 SDL::Video::set_video_mode(640, 480, 16, SDL_SWSURFACE);

 printf("Cursor is %s\n", SDL::Mouse::show_cursor(SDL_QUERY) ? 'visible' : 'not visible');

 sleep(3);

 SDL::Mouse::show_cursor(SDL_DISABLE);
 printf("Cursor is %s\n", SDL::Mouse::show_cursor(SDL_QUERY) ? 'visible' : 'not visible');

 sleep(3);

 SDL::Mouse::show_cursor(SDL_ENABLE);
 printf("Cursor is %s\n", SDL::Mouse::show_cursor(SDL_QUERY) ? 'visible' : 'not visible');

 sleep(3);

=head1 SEE ALSO

L<SDL::Cursor>

=head1 AUTHORS

See L<SDL/AUTHORS>.

=cut