=head1 NAME
SDLx::Sprite - interact
with
images quick and easily in SDL
=head1 CATEGORY
Extension
=head1 SYNOPSIS
my
$sprite
= SDLx::Sprite->new;
$sprite
->load(
'hero.png'
);
$sprite
->alpha_key(
$color
);
$sprite
->alpha(0.5);
say
$sprite
->x;
$sprite
->y(30);
$sprite
->w;
$sprite
->h;
my
$rect
=
$sprite
->rect;
my
$surface
=
$sprite
->surface;
$sprite
->rotation(
$degrees
);
$sprite
->rotation(
$degrees
,
$smooth
);
$sprite
->add(
armor
=>
$other_sprite
);
$sprite
->remove(
'armor'
);
$sprite
->draw(
$screen
);
$sprite
->clip->x(10);
$sprite
->clip->y(3);
$sprite
->clip->w(5);
$sprite
->clip->h(5);
$sprite
->clip(
$x
,
$y
,
$w
,
$h
);
my
$sprite
= SDLx::Sprite->new(
image
=>
'hero.png'
,
rect
=> SDL::Rect,
clip
=> SDL::Rect,
alpha_key
=> SDL::Color,
alpha
=> 1,
rotation
=> 45,
);
=head1 DESCRIPTION
SDLx::Sprite is a SDL::Surface on steroids! It let's you quickly
load, setup and interact
with
images in your SDL application, abstracting
all the drudge code and letting you concentrate on your app's logic instead.
This module automatically creates and holds SDL::Rect objects
for
the source
and destination surfaces, and provides several surface manipulation options
like alpha blending and rotation.
=head1 WARNING! VOLATILE CODE AHEAD
This is a new module and the API is subject to change without notice.
If you care, please
join
the discussion on the
I<irc.perl.org>. All thoughts on further improving the API are welcome.
You have been warned :)
=head1 METHODS
=head2 new
=head2 new(
%options
)
Creates a new SDLx::Sprite object. No option is mandatory.
Available options are:
=over 4
=item *
image
=>
$filename
Uses
$filename
as source image
for
the Sprite's surface. See suported
formats in L<< SDL::Image >>. This option B<cannot> be used together
with
the
'surface'
option (see below).
=item *
surface
=> SDL::Surface
Uses the provided L<< SDL::Surface >> object as source surface
for
this
sprite, instead of creating one automatically. This option B<cannot> be
used together
with
the
'image'
option (see above).
=item *
clip
=> SDL::Rect
Uses the provided L<< SDL::Rect >> object as clipping rect
for
the source
surface. This means the object will only blit that particular area from
the surface.
=item *
rect
=> SDL::Rect
Uses the provided L<< SDL::Rect >> object as destination coordinates to
whatever surface you call draw() on. You B<cannot>
use
this option together
with
'x'
and
'y'
(see below)
=item *
x
=>
$x
Uses
$x
as the x-axis (left-to-right, 0 being leftmost) positioning of
the Sprite into the destination you call draw() upon. This option B<cannot>
be used together
with
'rect'
(see above).
=item *
y
=>
$y
Uses
$y
as the y-axis (top-to-bottom, 0 being topmost) positioning of
the Sprite into the destination you call draw() upon. This option B<cannot>
be used together
with
'rect'
(see above).
=item *
draw_xy
=>
$surface
,
$x
,
$y
A shortcut to draw at coordinates quickly. Calls x() , y() and draw()
=item *
rotation
=>
$degrees
, [
$smooth
]
Uses
$degrees
as the angle to rotate the surface to, in degrees
(0..360, remember? :). This option is only available
if
your compiled SDL
library
has
support
for
GFX (see L<< Alien::SDL >>
for
details).
if
$smooth
is set the sprite is antialiased. This may mess
with
your alpha_key.
=item *
alpha_key
=> SDL::Color
MUST CALL L<SDL::Video::get_video_mode|SDL::Video/
"get_video_mode"
> prior to this.
Uses the provided L<< SDL::Color >> object (or an array reference
with
red,
green and blue
values
) as the color to be turned into transparent
(see
'alpha'
below).
=item *
alpha
=>
$percentage
or
$integer
Uses
$percentage
(0 <-> 1 ) or
$integer
( 0x01 - 0xff) as how much transparency to add to the surface. If you
use
this, it is mandatory that you also provide the alpha_key (see above).
=back
=head2 load(
$filename
)
Loads the
given
image file into the object's internal surface. A new surface
is B<always> created, so whatever you had on the previous surface will be
lost. Croaks on errors such as
no
support built
for
the image or a file
reading error (the error message is SDL::get_error and should give more
details).
Returns the own Sprite object, to allow method chaining.
=head2 surface()
=head2 surface( SDL::Surface )
Returns the object's internal surface, or
undef
if
there is none.
If you pass a SDL::Surface to it, it will overwrite the original surface
with
it,
while
returning the B<old> (previous) surface. Note that, as such,
it will
return
C<
undef
>
if
you
use
it without having previously loaded
either an image or a previous surface. It will Carp::confess
if
you pass anything
that's not an SDL::Surface object (or SDL::Surface subclassed objects).
=head2 rect()
=head2 rect( SDL::Rect )
Returns the destination L<< SDL::Rect >> object used
when
you call draw().
If you haven't explicitly set it, it will be a SDL::Rect
with
the same
dimensions as the object's internal surface. If
no
surface was set yet,
it will be an empty SDL::Rect (dimensions 0,0,0,0).
If you pass it a L<< SDL::Rect >> object, it will set rect() to that object
before
returning, but it will B<overwrite> any width and height
values
, as
those are
read
only and set to the size of the underlying surface.
If you want to clip the source surface, set clip() instead.
=head2 clip()
=head2 clip( SDL::Rect )
Returns the source L<< SDL::Rect >> object used
when
you call draw().
You can
use
this method to choose only a small subset of the object's
internal surface to be used on calls to draw().
If you haven't explicitly set it, it will be a SDL::Rect
with
the same
dimensions as the object's internal surface. If
no
surface was set yet,
it will be an empty SDL::Rect (dimensions 0,0,0,0).
If you pass it a L<< SDL::Rect >> object, it will set clip() to that object
before
returning.
=head2 x()
=head2 x(
$int
)
Gets/sets the x-axis (left-to-right, 0 being leftmost) positioning of
the Sprite into the destination you call draw() upon.
It is a shortcut to C<<
$sprite
->rect->x >>.
=head2 y()
=head2 y(
$int
)
Gets/sets the y-axis (top-to-bottom, 0 being topmost) positioning of
the Sprite into the destination you call draw() upon.
It is a shortcut to C<<
$sprite
->rect->y >>.
=head2 w()
Returns the Sprite surface's width. This method is
read
-only.
It is a shortcut to C<<
$sprite
->surface->w >>.
=head2 h()
Returns the Sprite surface's height. This method is
read
-only.
It is a shortcut to C<<
$sprite
->surface->h >>.
=head2 draw( SDL::Surface )
Draws the Sprite on the provided SDL::Surface object - usually the screen -
using the blit_surface SDL function, using the source rect from clip() and the
destination rect (position) from rect().
Returns the own Sprite object, to allow method chaining.
=head1 AUTHORS
See L<SDL/AUTHORS>.
=head1 SEE ALSO
L<< SDL::Surface >>, L<< SDL >>