5 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
7 # ------------------------------------------------------------------------------
9 # This library is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public
11 # License as published by the Free Software Foundation; either
12 # version 2.1 of the License, or (at your option) any later version.
14 # This library is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with this library; if not, write to the Free Software
21 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 # ------------------------------------------------------------------------------
25 # Please feel free to send questions, suggestions or improvements to:
40 my $class = ref($proto) || $proto;
43 verify (%options, qw/ -x -y -top -left -width -height -w -h / ) if $SDL::DEBUG;
45 my $x = $options{-x} || $options{-left} || 0;
46 my $y = $options{-y} || $options{-top} || 0;
47 my $w = $options{-width} || $options{-w} || 0;
48 my $h = $options{-height} || $options{-h} || 0;
50 my $self = \SDL::NewRect($x,$y,$w,$h);
51 croak SDL::GetError() unless $$self;
57 SDL::FreeRect(${$_[0]});
60 # TODO: mangle with the symbol table to create an alias
61 # to sub x. We could call x from inside the sub but that
62 # would be another call and rects are a time-critical object.
65 SDL::RectX($$self,@_);
70 SDL::RectX($$self,@_);
73 ### TODO: see 'left' above
76 SDL::RectY($$self,@_);
81 SDL::RectY($$self,@_);
84 ### TODO: see 'left' above
87 SDL::RectW($$self,@_);
92 SDL::RectW($$self,@_);
95 ### TODO: see 'left' above
98 SDL::RectH($$self,@_);
103 SDL::RectH($$self,@_);
112 SDL::Rect - raw object for storing rectangular coordinates
116 my $rect = SDL::Rect->new( -height => 4, -width => 40 );
118 $rect->x(12); # same as $rect->left(12)
119 $rect->y(9); # same as $rect->top(9)
123 C<SDL::Rect::new> creates a SDL_Rect structure which is
124 used for specifying regions of pixels for filling, blitting, and updating.
125 These objects make it easy to cut and backfill.
127 By default, x, y, height and width are all set to 0.
131 The four fields of a rectangle can be set simply
132 by passing a value to the applicable method. These are:
138 sets and fetches the x (lefmost) position of the rectangle.
144 sets and fetches the y (topmost) position.
150 sets and fetched the width of the rectangle (in pixels).
156 sets and fetched the height of the rectangle (in pixels).
166 perl(1) SDL::Surface(3)