/usr/lib/perl5/pods/SDLx/LayerManager.pod is in libsdl-perl 2.540-1.
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 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | =head1 NAME
SDLx::LayerManager - Extension for managing layers in a 2D world
=head1 CATEGORY
Extension
=head1 SYNOPSIS
use SDLx::Layer;
use SDLx::LayerManager;
use SDL::Image;
use SDL::Surface;
use SDL::Video;
# creating layers
my $layer1 = SDLx::Layer->new( SDL::Image::load('image1.png'), {userdata => '7'} );
my $layer2 = SDLx::Layer->new( SDL::Image::load('image2.png'), 100, 200, {userdata => '42'} );
# creating the manager that holds the layers
my $layermanager = SDLx::LayerManager->new();
$layermanager->add( $layer1 );
$layermanager->add( $layer2 );
my $display = # create your video surface here
$layermanager->blit( $display );
# accessing the layer at point(x,y)
print( $layermanager->by_position( 150, 200 )->data->{userdata} ); # should print '42'
=head1 DESCRIPTION
SDLx::LayerManager is a package to handle a bunch of layers. A layer (see SDLx::Layer) is an SDL::Surface, the position of the surface on screen and some additional information.
The layermanager gives you the opportunity to obtain the layer at a given point on screen and get the layers that are ahead or behind a layer.
You will even be able to attach one or more layers to the mouse, e.g. for simulation some drag&drop functionality.
=head1 METHODS
=head2 new
my $layermanager = SDLx::LayerManager->new();
This creates your layermanager object. It doesn't take any parameters.
=head2 add
$layermanager->add( $layer );
$layermanager->add( SDLx::Layer->new( $surface, $x, $y, $options ) );
Call C<add> to push an SDLx::Layer object to the layermanager.
=head2 layers
my @layers = @{ $layermanager->layers };
my $first_layer = $layermanager->layers->[0];
The method C<layers> returns all layers that were added before.
=head2 layer
my $layer = $layermanager->layer( $index );
To obtain only one layer at index C<$index> use this function. C<$index> ranges from C<0> to C<length - 1>.
=head2 length
my $length = $layermanager->length();
This method returns the count of the added layers.
=head2 blit
$layermanager->blit( $surface );
This method blits all layers to the surface (e.g. your video surface).
=head2 by_position
my $layer = $layermanager->by_position( $x, $y );
C<by_position> returns the C<SDLx::Layer> object at point C<$x $y>, which is not fully transparent at this pixel.
=head2 ahead
my @layers = @{ $layermanager->ahead( $index ) };
This method returns all layers that are ahead of the given layer indicated by C<$index>.
Ahead means that a layer has a higher z-index and is blitted over the given layer.
B<Note>: This method doesn't check for transparency. This will change in future versions.
=head2 behind
my @layers = @{ $layermanager->behind( $index ) };
This method returns all layers that are behind of the given layer indicated by C<$index>.
Behind means that a layer has a lower z-index and is blitted before the given layer.
B<Note>: This method doesn't check for transparency. This will change in future versions.
=head2 attach
$layermanager->attach( $layer, $x, $y );
$layermanager->attach( @layers, $x, $y );
This function makes the given layer(s) sticky to the mouse. If you move the mouse the layer(s) will follow.
The layermanager blits these layers at last, so they will appear on top of all layers.
C<$x> and C<$y> should be set to the coords of the mouse, e.g. the coords of the mouse click.
If you omit C<$x> and C<$y> the layermanager obtains them via SDL::Events::get_mouse_state.
B<Note>: The z-index is not changed for the given layers.
=head2 detach_xy
$layermanager->detach_xy( $x, $y );
C<detach_xy> detaches the previously attached layers to the given coords. The upper left corner of the backmost layer will be at C<$x> and C<$y>.
The other layers are positioned relative to the backmost layer just like before.
=head2 detach_back
$layermanager->detach_back( );
C<detach_back> detaches the previously attached layers back to the position where they were attached.
=head2 foreground
$layermanager->foreground( $layer );
$layermanager->foreground( @layers );
This method moves the given layer(s) to the foreground so that they are blitted on top of the other layers.
=head1 BUGS
Report at sdlperl.ath.cx
=head1 SUPPORT
#sdl irc.perl.org
=head1 AUTHORS
See L<SDL/AUTHORS>.
=head1 COPYRIGHT
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the
LICENSE file included with this module.
=head1 SEE ALSO
perl(1), SDL(2).
=cut
|