lib/SDL/Surface.pm

   1 #!/usr/bin/env perl
   2 #
   3 # Surface.pm
   4 #
   5 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
   6 #
   7 # ------------------------------------------------------------------------------
   8 #
   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.
  13 #
  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.
  18 #
  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
  22 #
  23 # ------------------------------------------------------------------------------
  24 #
  25 # Please feel free to send questions, suggestions or improvements to:
  26 #
  27 #       David J. Goehrig
  28 #       dgoehrig@cpan.org
  29 #
  30
  31 package SDL::Surface;
  32
  33 use strict;
  34 use warnings;
  35 use Carp;
  36 use SDL;
  37 use SDL::SFont;
  38 use SDL::Color;
  39 use SDL::Rect;
  40
  41 sub new {
  42         my $proto = shift;
  43         my $class = ref($proto) || $proto;
  44         my %options = @_;
  45         my $self;
  46
  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;
  50
  51         if ( defined($options{-name}) && $options{-name} ne "" && exists $SDL::{IMGLoad} ) {
  52            $self = \SDL::IMGLoad($options{-name});
  53         } else {
  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 );
  67
  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);
  71                 } else {
  72                         $self = \SDL::CreateRGBSurface($f,$w,$h,$d,$r,$g,$b,$a);
  73                 }
  74         }
  75         croak "SDL::Surface::new failed. ", SDL::GetError()
  76                 unless ( $$self);
  77         bless $self,$class;
  78         return $self;
  79 }
  80
  81 sub DESTROY {
  82         SDL::FreeSurface(${$_[0]});
  83 }
  84
  85 sub flags {
  86         SDL::SurfaceFlags(${$_[0]});
  87 }
  88
  89 sub palette {
  90         SDL::SurfacePalette(${$_[0]});
  91 }
  92
  93 sub bpp {
  94         SDL::SurfaceBitsPerPixel(${$_[0]});
  95 }
  96
  97 sub bytes_per_pixel {
  98         SDL::SurfaceBytesPerPixel(${$_[0]});
  99 }
 100
 101 sub Rshift {
 102         SDL::SurfaceRshift(${$_[0]});
 103 }
 104
 105 sub Gshift {
 106         SDL::SurfaceGshift(${$_[0]});
 107 }
 108
 109 sub Bshift {
 110         SDL::SurfaceBshift(${$_[0]});
 111 }
 112
 113 sub Ashift {
 114         SDL::SurfaceAshift(${$_[0]});
 115 }
 116
 117 sub Rmask {
 118         SDL::SurfaceRmask(${$_[0]});
 119 }
 120
 121 sub Gmask {
 122         SDL::SurfaceGmask(${$_[0]});
 123 }
 124
 125 sub Bmask {
 126         SDL::SurfaceBmask(${$_[0]});
 127 }
 128
 129 sub Amask {
 130         SDL::SurfaceAmask(${$_[0]});
 131 }
 132
 133 sub color_key {
 134         SDL::SurfaceColorKey(${$_[0]});
 135 }
 136
 137 sub alpha {
 138         SDL::SurfaceAlpha(${$_[0]});
 139 }
 140
 141 sub width {
 142         SDL::SurfaceW(${$_[0]});
 143 }
 144
 145 sub height {
 146         SDL::SurfaceH(${$_[0]});
 147 }
 148
 149 sub pitch {
 150         SDL::SurfacePitch(${$_[0]});
 151 }
 152
 153 sub pixels {
 154         SDL::SurfacePixels(${$_[0]});
 155 }
 156
 157 sub pixel {
 158         croak "SDL::Surface::pixel requires a SDL::Color"
 159                 if $_[3] && $SDL::DEBUG && !$_[3]->isa("SDL::Color");
 160         $_[3] ?
 161                 new SDL::Color -color => SDL::SurfacePixel(${$_[0]},$_[1],$_[2],${$_[3]}) :
 162                 new SDL::Color -color => SDL::SurfacePixel(${$_[0]},$_[1],$_[2]);
 163 }
 164
 165 sub fill {
 166         croak "SDL::Surface::fill requires a SDL::Rect object"
 167                 unless !$SDL::DEBUG || $_[1] == 0 || $_[1]->isa('SDL::Rect');
 168         croak "SDL::Surface::fill requires a SDL::Color object"
 169                 unless !$SDL::DEBUG || $_[2]->isa('SDL::Color');
 170         if ($_[1] == 0 ) {
 171                 SDL::FillRect(${$_[0]},0,${$_[2]});
 172         } else {
 173                 SDL::FillRect(${$_[0]},${$_[1]},${$_[2]});
 174         }
 175 }
 176
 177 sub lockp {
 178         SDL::MUSTLOCK(${$_[0]});
 179 }
 180
 181 sub lock {
 182         SDL::SurfaceLock(${$_[0]});
 183 }
 184
 185 sub unlock {
 186         SDL::SurfaceUnlock(${$_[0]});
 187 }
 188
 189 sub update {
 190         my $self = shift;;
 191         if ($SDL::DEBUG) {
 192                 for (@_) {
 193                         croak "SDL::Surface::update requires SDL::Rect objects"
 194                                 unless $_->isa('SDL::Rect');
 195                 }
 196         }
 197         SDL::UpdateRects($$self, map { ${$_} } @_ );
 198 }
 199
 200 sub flip {
 201         SDL::Flip(${$_[0]});
 202 }
 203
 204 sub blit {
 205         if ($SDL::DEBUG) {
 206                 croak "SDL::Surface::blit requires SDL::Rect objects"
 207                         unless ($_[1] == 0 || $_[1]->isa('SDL::Rect'))
 208                         && ($_[3] == 0 || $_[3]->isa('SDL::Rect'));
 209                 croak "SDL::Surface::blit requires SDL::Surface objects"
 210                         unless $_[2]->isa('SDL::Surface');
 211         }
 212         SDL::BlitSurface(map { $_ != 0 ? ${$_} : $_ } @_);
 213 }
 214
 215 sub set_colors {
 216         my $self = shift;
 217         my $start = shift;
 218         for (@_) {
 219                 croak "SDL::Surface::set_colors requires SDL::Color objects"
 220                         unless !$SDL::DEBUG || $_->isa('SDL::Color');
 221         }
 222         return SDL::SetColors($$self, $start, map { ${$_} } @_);
 223 }
 224
 225 sub set_color_key {
 226         croak "SDL::Surface::set_color_key requires a SDL::Color object"
 227                 unless !$SDL::DEBUG || (ref($_[2]) && $_[2]->isa('SDL::Color'));
 228         SDL::SetColorKey(${$_[0]},$_[1],${$_[2]});
 229 }
 230
 231 sub set_alpha {
 232         SDL::SetAlpha(${$_[0]},$_[1],$_[2]);
 233 }
 234
 235 sub display_format {
 236         my $self = shift;
 237         my $tmp = SDL::DisplayFormat($$self);
 238         SDL::FreeSurface ($$self);
 239         $$self = $tmp;
 240         $self;
 241 }
 242
 243 sub rgb {
 244         my $self = shift;
 245         my $tmp = SDL::ConvertRGB($$self);
 246         SDL::FreeSurface($$self);
 247         $$self = $tmp;
 248         $self;
 249 }
 250
 251 sub rgba {
 252         my $self = shift;
 253         my $tmp = SDL::ConvertRGBA($$self);
 254         SDL::FreeSurface($$self);
 255         $$self = $tmp;
 256         $self;
 257 }
 258
 259 sub rect {
 260         my $self = shift;
 261         new SDL::Rect -width => $self->width(), -height => $self->height(),
 262                         -x => $_[0] || 0, -y => $_[1] || 0;
 263 }
 264
 265 sub print {
 266         my ($self,$x,$y,@text) = @_;
 267         SDL::SFont::PutString( $$self, $x, $y, join('',@text));
 268 }
 269
 270 sub save_bmp {
 271         SDL::SaveBMP( ${$_[0]},$_[1]);
 272 }
 273
 274 sub video_info {
 275         shift;
 276         SDL::VideoInfo();
 277 }
 278
 279 1;
 280
 281 __END__;
 282
 283 =pod
 284
 285 =head1 NAME
 286
 287 SDL::Surface - a SDL perl extension
 288
 289 =head1 SYNOPSIS
 290
 291   use SDL::Surface;
 292   $image = new SDL::Surface(-name=>"yomama.jpg");
 293
 294 =head1 DESCRIPTION
 295
 296 The C<SDL::Surface> module encapsulates the SDL_Surface* structure, and
 297 many of its ancillatory functions.  Not only is it a workhorse of the
 298 OO Layer, it is the base class for the C<SDL::App> class.
 299
 300 =head1 EXPORTS
 301
 302         SDL_SWSURFACE           SDL_HWSURFACE
 303         SDL_ASYNCBLIT           SDL_ANYFORMAT
 304         SDL_HWPALETTE           SDL_DOUBLEBUF
 305         SDL_FULLSCREEN          SDL_OPENGL
 306         SDL_OPENGLBLIT          SDL_RESIZEABLE
 307         SDL_NOFRAME             SDL_SRCCOLORKEY
 308         SDL_RLEACCEL            SDL_SRCALPHA
 309         SDL_PREALLOC
 310
 311 =head1 METHODS
 312
 313 =head2 new (-name => 'foo.png')
 314
 315 The C<SDL::Surface> class can be instantiated in a number of different ways.
 316 If support for the SDL_image library was included when SDL_perl was compiled,
 317 the easiest way to create a new surface is to use the C<SDL::Surface::new>
 318 method with the C<-name> option.  This will load the image from the file
 319 and return an object encapsulating the SDL_Surface*.
 320
 321 =head2 new (-from => $buffer, ... )
 322
 323 If the contents of the new Surface is already in memory, C<SDL::Surface::new>
 324 may be called with the C<-from> option to create an image from that section
 325 of memory.  This method takes the following additional parameters:
 326
 327 =over 4
 328
 329 =item *
 330
 331 -width          the width of the image in pixels
 332
 333 =item *
 334
 335 -height         the height of the image in pixels
 336
 337 =item *
 338
 339 -depth          the number of bits per pixel
 340
 341 =item *
 342
 343 -pitch          the number of bytes per line
 344
 345 =item *
 346
 347 -Rmask          an optional bitmask for red
 348
 349 =item *
 350
 351 -Gmask          an optional bitmask for green
 352
 353 =item *
 354
 355 -Bmask          an optional bitmask for green
 356
 357 =item *
 358
 359 -Amask          an optional bitmask for alpha
 360
 361 =back
 362
 363 =head2 new ( -flags => SDL_SWSURFACE, ... )
 364
 365 Finally, C<SDL::Suface::new> may be invoked with the C<-flags> option, in a
 366 similar fashion to the C<-from> directive.  This invocation takes the same
 367 additional options as C<-from> with the exception of C<-pitch> which is ignored.
 368 This method returns a new, blank, SDL::Surface option with any of the following
 369 flags turned on:
 370
 371 =over 4
 372
 373 =item *
 374
 375 SWSURFACE()     a non-accelerated surface
 376
 377 =item *
 378
 379 HWSURFACE()     a hardware accelerated surface
 380
 381 =item *
 382
 383 SRCCOLORKEY()   a surface with a transperant color
 384
 385 =item *
 386
 387 SRCALPHA()      an alpha blended, translucent surface
 388
 389 =back
 390
 391 =head2 flags ()
 392
 393 C<SDL::Surface::flags> returns the flags with which the surface was initialized.
 394
 395 =head2 palette ()
 396
 397 C<SDL::Surface::palette> currently returns a SDL_Palette*, this may change in
 398 future revisions.
 399
 400 =head2 bpp ()
 401
 402 C<SDL::Surface::bpp> returns the bits per pixel of the surface
 403
 404 =head2 bytes_per_pixel ()
 405
 406 C<SDL::Surface::bytes_per_pixel> returns the bytes per pixel of the surface
 407
 408 =head2 Rshift ()
 409
 410 C<SDL::Surface::Rshift> returns the bit index of the red field for the surface's pixel format
 411
 412 =head2 Gshift ()
 413
 414 C<SDL::Surface::Gshift> returns the bit index of the green field for the surface's pixel format
 415
 416 =head2 Bshift ()
 417
 418 C<SDL::Surface::Bshift> returns the bit index of the blue field for the surface's pixel format
 419
 420 =head2 Ashift ()
 421
 422 C<SDL::Surface::Ashift> returns the bit index of the alpha field for the surface's pixel format
 423
 424 =head2 Rmask ()
 425
 426 C<SDL::Surface::Rmask> returns the bit mask for the red field for teh surface's pixel format
 427
 428 =head2 Gmask ()
 429
 430 C<SDL::Surface::Gmask> returns the bit mask for the green field for teh surface's pixel format
 431
 432 =head2 Bmask ()
 433
 434 C<SDL::Surface::Bmask> returns the bit mask for the blue field for teh surface's pixel format
 435
 436 =head2 Amask ()
 437
 438 C<SDL::Surface::Amask> returns the bit mask for the alpha field for teh surface's pixel format
 439
 440 =head2 color_key ()
 441
 442 C<SDL::Surface::color_key> returns the current color key for the image, which can be set with
 443 the C<SDL::Surface::set_color_key> method.  Before calling C<SDL::Surface::color_key> on
 444 a image, you should fist call C<SDL::Surface::display_format> to convert it to the same
 445 format as the display.  Failure to do so will result in failure to apply the correct color_key.
 446
 447 =head2 alpha ()
 448
 449 C<SDL::Surface::alpha> returns the current alpha value for the image, which can be set with
 450 the C<SDL::Surface::set_alpha> method.
 451
 452 =head2 width ()
 453
 454 C<SDL::Surface::width> returns the width in pixels of the surface
 455
 456 =head2 height ()
 457
 458 C<SDL::Surface::height> returns the height in pixels of the surface
 459
 460 =head2 pitch ()
 461
 462 C<SDL::Surface::pitch> returns the width of a surface's scanline in bytes
 463
 464 =head2 pixels ()
 465
 466 C<SDL::Surface::pixels> returns a Uint8* to the image's pixel data.  This is not
 467 inherently useful within perl, though may be used to pass image data to user provided
 468 C functions.
 469
 470 =head2 pixel (x,y,[color])
 471
 472 C<SDL::Surface::pixel> will set the color value of the pixel at (x,y) to the given
 473 color if provided.  C<SDL::Surface::pixel> returns a SDL::Color object for the
 474 color value of the pixel at (x,y) after any possible modifications.
 475
 476 =head2 fill (rect,color)
 477
 478 C<SDL::Surface::fill> will fill the given SDL::Rect rectangle with the specified SDL::Color
 479 This function optionally takes a SDL_Rect* and a SDL_Color*
 480
 481 =head2 lockp ()
 482
 483 C<SDL::Surface::lockp> returns true if the surface must be locked
 484
 485 =head2 lock ()
 486
 487 C<SDL::Surface::lock> places a hardware lock if necessary, preventing access to
 488 the surface's memory
 489
 490 =head2 unlock ()
 491
 492 C<SDL::Surface::unlock> removes any hardware locks, enabling blits
 493
 494 =head2 update ( rects...)
 495
 496 C<SDL::Surface::update> takes one or more SDL::Rect's which determine which sections
 497 of the image are to be updated.  This option is only useful on the appliaction surface.
 498
 499 =head2 flip ()
 500
 501 C<SDL::Surface::flip> updates the full surface, using a double buffer if available
 502
 503 =head2 blit (srect,dest,drect)
 504
 505 C<SDL::Surface::blit> blits the current surface onto the destination surface,
 506 according to the provided rectangles.  If a rectangle is 0, then the full surface is used.
 507
 508 =head2 set_colors (start,colors...)
 509
 510 C<SDL::Surface::set_colors> updates the palette starting at index C<start> with the
 511 supplied colors.  The colors may either be SDL::Color objects or SDL_Color* from the
 512 low level C-style API.
 513
 514 =head2 set_color_key (flag,pixel) or (flag,x,y)
 515
 516 C<SDL::Surface::set_color_key> sets the blit flag, usually SDL_SRCCOLORKEY,
 517 to the specified L<SDL::Color> object.  Optional a SDL_Color* may be passed.
 518
 519 =head2 set_alpha (flag,alpha)
 520
 521 C<SDL::Surface::set_alpha> sets the opacity of the image for alpha blits.
 522 C<alpha> takes a value from 0x00 to 0xff.
 523
 524 =head2 display_format ()
 525
 526 C<SDL::Surface::display_format> converts the surface to the same format as the
 527 current screen.
 528
 529 =head2 rgb ()
 530 C<SDL::Surface::rgb> converts the surface to a 24 bit rgb format regardless of the
 531 initial format.
 532
 533 =head2 rgba ()
 534 C<SDL::Surface::rgba> converts the surface to a 32 bit rgba format regarless of the
 535 initial format.
 536
 537 =head2 print (x,y,text...)
 538
 539 C<SDL::Surface::print> renders the text using the current font onto the image.
 540 This option is only supported for with SDL_image and SFont.
 541
 542 =head2 save_bmp (filename)
 543
 544 C<SDL::Surface::save_bmp> saves the surface to filename in Windows BMP format.
 545
 546 =head2 video_info ()
 547
 548 C<SDL::Surface::video_info> returns a hash describing the current state of the
 549 video hardware.
 550
 551 =head1 AUTHOR
 552
 553 David J. Goehrig
 554
 555 =head1 SEE ALSO
 556
 557 L<perl> L<SDL::App> L<SDL::Color> L<SDL::Palette> L<SDL::Rect>
 558
 559 =cut