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:
43 my $class = ref($proto) || $proto;
47 verify (%options, qw/ -name -n -flags -fl -width -w -height -h -depth -d
48 -pitch -p -Rmask -r -Gmask -g -Bmask -b -Amask -a
49 -from -f /) if $SDL::DEBUG;
51 if ( defined($options{-name}) && $options{-name} ne "" && exists $SDL::{IMGLoad} ) {
52 $self = \SDL::IMGLoad($options{-name});
54 my $f = $options{-flags} || $options{-fl} || SDL::SDL_ANYFORMAT();
55 my $w = $options{-width} || $options{-w} || 1;
56 my $h = $options{-height} || $options{-h} || 1;
57 my $d = $options{-depth} || $options{-d} || 8;
58 my $p = $options{-pitch} || $options{-p} || $w*$d;
59 my $r = $options{-Rmask} || $options{-r}
60 || ( SDL::BigEndian() ? 0xff000000 : 0x000000ff );
61 my $g = $options{-Gmask} || $options{-g}
62 || ( SDL::BigEndian() ? 0x00ff0000 : 0x0000ff00 );
63 my $b = $options{-Bmask} || $options{-b}
64 || ( SDL::BigEndian() ? 0x0000ff00 : 0x00ff0000 );
65 my $a = $options{-Amask} || $options{-a}
66 || ( SDL::BigEndian() ? 0x000000ff : 0xff000000 );
68 if ( $options{-from}|| $options{-f} ) {
69 my $src = $options{-from}|| $options{-f};
70 $self = \SDL::CreateRGBSurfaceFrom($src,$w,$h,$d,$p,$r,$g,$b,$a);
72 $self = \SDL::CreateRGBSurface($f,$w,$h,$d,$r,$g,$b,$a);
75 croak "SDL::Surface::new failed. ", SDL::GetError()
82 SDL::FreeSurface(${$_[0]});
86 SDL::SurfaceFlags(${$_[0]});
90 SDL::SurfacePalette(${$_[0]});
94 SDL::SurfaceBitsPerPixel(${$_[0]});
98 SDL::SurfaceBytesPerPixel(${$_[0]});
102 SDL::SurfaceRshift(${$_[0]});
106 SDL::SurfaceGshift(${$_[0]});
110 SDL::SurfaceBshift(${$_[0]});
114 SDL::SurfaceAshift(${$_[0]});
118 SDL::SurfaceRmask(${$_[0]});
122 SDL::SurfaceGmask(${$_[0]});
126 SDL::SurfaceBmask(${$_[0]});
130 SDL::SurfaceAmask(${$_[0]});
134 SDL::SurfaceColorKey(${$_[0]});
138 SDL::SurfaceAlpha(${$_[0]});
142 SDL::SurfaceW(${$_[0]});
146 SDL::SurfaceH(${$_[0]});
150 SDL::SurfacePitch(${$_[0]});
154 SDL::SurfacePixels(${$_[0]});
158 croak "SDL::Surface::pixel requires a SDL::Color"
159 if $_[3] && $SDL::DEBUG && !$_[3]->isa("SDL::Color");
161 new SDL::Color -color => SDL::SurfacePixel(${$_[0]},$_[1],$_[2],${$_[3]}) :
162 new SDL::Color -color => SDL::SurfacePixel(${$_[0]},$_[1],$_[2]);
167 SDL::FillRect(${$_[0]},0,${$_[2]});
169 SDL::FillRect(${$_[0]},$_[1],${$_[2]});
174 SDL::MUSTLOCK(${$_[0]});
178 SDL::SurfaceLock(${$_[0]});
182 SDL::SurfaceUnlock(${$_[0]});
189 croak "SDL::Surface::update requires SDL::Rect objects"
190 unless $_->isa('SDL::Rect');
193 SDL::UpdateRects($$self, map { ${$_} } @_ );
201 $_[1] = 0 unless defined $_[1];
202 $_[3] = 0 unless defined $_[3];
205 croak "SDL::Surface::blit requires SDL::Rect objects"
206 unless ($_[1] == 0 || $_[1]->isa('SDL::Rect'))
207 && ($_[3] == 0 || $_[3]->isa('SDL::Rect'));
208 croak "SDL::Surface::blit requires SDL::Surface objects"
209 unless $_[2]->isa('SDL::Surface');
211 #BlitSurface ( src, src_rect, dest, dest_rect )
213 SDL::BlitSurface( ${$_[0]}, $_[1], ${$_[2]}, $_[3]);
220 croak "SDL::Surface::set_colors requires SDL::Color objects"
221 unless !$SDL::DEBUG || $_->isa('SDL::Color');
223 return SDL::SetColors($$self, $start, map { ${$_} } @_);
227 croak "SDL::Surface::set_color_key requires a SDL::Color object"
228 unless !$SDL::DEBUG || (ref($_[2]) && $_[2]->isa('SDL::Color'));
229 SDL::SetColorKey(${$_[0]},$_[1],${$_[2]});
233 SDL::SetAlpha(${$_[0]},$_[1],$_[2]);
238 my $tmp = SDL::DisplayFormat($$self);
239 SDL::FreeSurface ($$self);
246 my $tmp = SDL::ConvertRGB($$self);
247 SDL::FreeSurface($$self);
254 my $tmp = SDL::ConvertRGBA($$self);
255 SDL::FreeSurface($$self);
262 new SDL::Rect -width => $self->width(), -height => $self->height(),
263 -x => $_[0] || 0, -y => $_[1] || 0;
267 my ($self,$x,$y,@text) = @_;
268 SDL::SFont::PutString( $$self, $x, $y, join('',@text));
272 SDL::SaveBMP( ${$_[0]},$_[1]);
288 SDL::Surface - a SDL perl extension
293 $image = new SDL::Surface(-name=>"yomama.jpg");
297 The C<SDL::Surface> module encapsulates the SDL_Surface* structure, and
298 many of its ancillatory functions. Not only is it a workhorse of the
299 OO Layer, it is the base class for the C<SDL::App> class.
303 SDL_SWSURFACE SDL_HWSURFACE
304 SDL_ASYNCBLIT SDL_ANYFORMAT
305 SDL_HWPALETTE SDL_DOUBLEBUF
306 SDL_FULLSCREEN SDL_OPENGL
307 SDL_OPENGLBLIT SDL_RESIZEABLE
308 SDL_NOFRAME SDL_SRCCOLORKEY
309 SDL_RLEACCEL SDL_SRCALPHA
314 =head2 new (-name => 'foo.png')
316 The C<SDL::Surface> class can be instantiated in a number of different ways.
317 If support for the SDL_image library was included when SDL_perl was compiled,
318 the easiest way to create a new surface is to use the C<SDL::Surface::new>
319 method with the C<-name> option. This will load the image from the file
320 and return an object encapsulating the SDL_Surface*.
322 =head2 new (-from => $buffer, ... )
324 If the contents of the new Surface is already in memory, C<SDL::Surface::new>
325 may be called with the C<-from> option to create an image from that section
326 of memory. This method takes the following additional parameters:
332 -width the width of the image in pixels
336 -height the height of the image in pixels
340 -depth the number of bits per pixel
344 -pitch the number of bytes per line
348 -Rmask an optional bitmask for red
352 -Gmask an optional bitmask for green
356 -Bmask an optional bitmask for green
360 -Amask an optional bitmask for alpha
364 =head2 new ( -flags => SDL_SWSURFACE, ... )
366 Finally, C<SDL::Suface::new> may be invoked with the C<-flags> option, in a
367 similar fashion to the C<-from> directive. This invocation takes the same
368 additional options as C<-from> with the exception of C<-pitch> which is ignored.
369 This method returns a new, blank, SDL::Surface option with any of the following
376 SWSURFACE() a non-accelerated surface
380 HWSURFACE() a hardware accelerated surface
384 SRCCOLORKEY() a surface with a transperant color
388 SRCALPHA() an alpha blended, translucent surface
394 C<SDL::Surface::flags> returns the flags with which the surface was initialized.
398 C<SDL::Surface::palette> currently returns a SDL_Palette*, this may change in
403 C<SDL::Surface::bpp> returns the bits per pixel of the surface
405 =head2 bytes_per_pixel ()
407 C<SDL::Surface::bytes_per_pixel> returns the bytes per pixel of the surface
411 C<SDL::Surface::Rshift> returns the bit index of the red field for the surface's pixel format
415 C<SDL::Surface::Gshift> returns the bit index of the green field for the surface's pixel format
419 C<SDL::Surface::Bshift> returns the bit index of the blue field for the surface's pixel format
423 C<SDL::Surface::Ashift> returns the bit index of the alpha field for the surface's pixel format
427 C<SDL::Surface::Rmask> returns the bit mask for the red field for teh surface's pixel format
431 C<SDL::Surface::Gmask> returns the bit mask for the green field for teh surface's pixel format
435 C<SDL::Surface::Bmask> returns the bit mask for the blue field for teh surface's pixel format
439 C<SDL::Surface::Amask> returns the bit mask for the alpha field for teh surface's pixel format
443 C<SDL::Surface::color_key> returns the current color key for the image, which can be set with
444 the C<SDL::Surface::set_color_key> method. Before calling C<SDL::Surface::color_key> on
445 a image, you should fist call C<SDL::Surface::display_format> to convert it to the same
446 format as the display. Failure to do so will result in failure to apply the correct color_key.
450 C<SDL::Surface::alpha> returns the current alpha value for the image, which can be set with
451 the C<SDL::Surface::set_alpha> method.
455 C<SDL::Surface::width> returns the width in pixels of the surface
459 C<SDL::Surface::height> returns the height in pixels of the surface
463 C<SDL::Surface::pitch> returns the width of a surface's scanline in bytes
467 C<SDL::Surface::pixels> returns a Uint8* to the image's pixel data. This is not
468 inherently useful within perl, though may be used to pass image data to user provided
471 =head2 pixel (x,y,[color])
473 C<SDL::Surface::pixel> will set the color value of the pixel at (x,y) to the given
474 color if provided. C<SDL::Surface::pixel> returns a SDL::Color object for the
475 color value of the pixel at (x,y) after any possible modifications.
477 =head2 fill (rect,color)
479 C<SDL::Surface::fill> will fill the given SDL::Rect rectangle with the specified SDL::Color
480 This function optionally takes a SDL_Rect* and a SDL_Color*
484 C<SDL::Surface::lockp> returns true if the surface must be locked
488 C<SDL::Surface::lock> places a hardware lock if necessary, preventing access to
493 C<SDL::Surface::unlock> removes any hardware locks, enabling blits
495 =head2 update ( rects...)
497 C<SDL::Surface::update> takes one or more SDL::Rect's which determine which sections
498 of the image are to be updated. This option is only useful on the appliaction surface.
502 C<SDL::Surface::flip> updates the full surface, using a double buffer if available
504 =head2 blit (srect,dest,drect)
506 C<SDL::Surface::blit> blits the current surface onto the destination surface,
507 according to the provided rectangles. If a rectangle is 0, then the full surface is used.
509 =head2 set_colors (start,colors...)
511 C<SDL::Surface::set_colors> updates the palette starting at index C<start> with the
512 supplied colors. The colors may either be SDL::Color objects or SDL_Color* from the
513 low level C-style API.
515 =head2 set_color_key (flag,pixel) or (flag,x,y)
517 C<SDL::Surface::set_color_key> sets the blit flag, usually SDL_SRCCOLORKEY,
518 to the specified L<SDL::Color> object. Optional a SDL_Color* may be passed.
520 =head2 set_alpha (flag,alpha)
522 C<SDL::Surface::set_alpha> sets the opacity of the image for alpha blits.
523 C<alpha> takes a value from 0x00 to 0xff.
525 =head2 display_format ()
527 C<SDL::Surface::display_format> converts the surface to the same format as the
532 C<SDL::Surface::rgb> converts the surface to a 24 bit rgb format regardless of the initial format.
536 C<SDL::Surface::rgba> converts the surface to a 32 bit rgba format regarless of the initial format.
538 =head2 print (x,y,text...)
540 C<SDL::Surface::print> renders the text using the current font onto the image.
541 This option is only supported for with SDL_image and SFont.
543 =head2 save_bmp (filename)
545 C<SDL::Surface::save_bmp> saves the surface to filename in Windows BMP format.
549 C<SDL::Surface::video_info> returns a hash describing the current state of the
558 L<perl> L<SDL::App> L<SDL::Color> L<SDL::Palette> L<SDL::Rect>