First commit of SDL_Perl-2.1.3

[sdlgit/SDL_perl.git] / lib / SDL / Rect.pm

#
#	Rect.pm
#
#	A package for manipulating SDL_Rect *
#
#	Copyright (C) 2003 David J. Goehrig

package SDL::Rect;
use strict;
use SDL;

sub new {
	my $proto = shift;
	my $class = ref($proto) || $proto;
	my %options = @_;

	verify (%options, qw/ -x -y -width -height -w -h / ) if $SDL::DEBUG;

	my $x = $options{-x} 		|| 0;
	my $y = $options{-y} 		|| 0;
	my $w = $options{-width}	|| $options{-w}		|| 0;
	my $h = $options{-height}	|| $options{-h}		|| 0;
	
	my $self = \SDL::NewRect($x,$y,$w,$h);
	bless $self,$class;
	return $self;
}

sub DESTROY {
	SDL::FreeRect(${$_[0]});
}

sub x {
	my $self = shift;
	SDL::RectX($$self,@_);
}

sub y {
	my $self = shift;
	SDL::RectY($$self,@_);
}

sub width {
	my $self = shift;
	SDL::RectW($$self,@_);
}

sub height {
	my $self = shift;
	SDL::RectH($$self,@_);
}

1;

__END__;

=pod


=head1 NAME

SDL::Rect - a SDL perl extension

=head1 SYNOPSIS

  $rect = new SDL::Rect ( -height => 4, -width => 40 );

=head1 DESCRIPTION

C<SDL::Rect::new> creates a SDL_Rect structure which is
used for specifying regions for filling, blitting, and updating.
These objects make it easy to cut and backfill.
By default, x, y, h, w are 0.

=head2 METHODS 

The four fields of a rectangle can be set simply
by passing a value to the applicable method.  These are:

=over 4

=item *

C<SDL::Rect::x>	sets and fetches the x position.

=item *

C<SDL::Rect::y>	sets and fetches the y position.

=item *

C<SDL::Rect::width> sets and fetched the width.

=item *

C<SDL::Rect::height> sets and fetched the height.

=back

=head1 AUTHOR

David J. Goehrig

=head1 SEE ALSO

perl(1) SDL::Surface(3)


=cut