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