4 # A package for manipulating SDL_Surface *
6 # Copyright (C) 2003 David J. Goehrig
18 my $class = ref($proto) || $proto;
22 verify (%options, qw/ -name -n -flags -fl -width -w -height -h -depth -d
23 -pitch -p -Rmask -r -Gmask -g -Bmask -b -Amask -a
24 -from -f /) if $SDL::DEBUG;
26 if ( defined($options{-name}) && $options{-name} ne "" && exists $SDL::{IMGLoad} ) {
27 $self = \SDL::IMGLoad($options{-name});
29 my $f = $options{-flags} || $options{-fl} || SDL::SDL_ANYFORMAT();
30 my $w = $options{-width} || $options{-w} || 1;
31 my $h = $options{-height} || $options{-h} || 1;
32 my $d = $options{-depth} || $options{-d} || 8;
33 my $p = $options{-pitch} || $options{-p} || $w*$d;
34 my $r = $options{-Rmask} || $options{-r}
35 || ( SDL::BigEndian() ? 0xff000000 : 0x000000ff );
36 my $g = $options{-Gmask} || $options{-g}
37 || ( SDL::BigEndian() ? 0x00ff0000 : 0x0000ff00 );
38 my $b = $options{-Bmask} || $options{-b}
39 || ( SDL::BigEndian() ? 0x0000ff00 : 0x00ff0000 );
40 my $a = $options{-Amask} || $options{-a}
41 || ( SDL::BigEndian() ? 0x000000ff : 0xff000000 );
43 if ( $options{-from}|| $options{-f} ) {
44 my $src = $options{-from}|| $options{-f};
45 $self = \SDL::CreateRGBSurfaceFrom($src,$w,$h,$d,$p,$r,$g,$b,$a);
47 $self = \SDL::CreateRGBSurface($f,$w,$h,$d,$r,$g,$b,$a);
50 die "SDL::Surface::new failed. ", SDL::GetError()
57 SDL::FreeSurface(${$_[0]});
61 SDL::SurfaceFlags(${$_[0]});
65 SDL::SurfacePalette(${$_[0]});
69 SDL::SurfaceBitsPerPixel(${$_[0]});
73 SDL::SurfaceBytesPerPixel(${$_[0]});
77 SDL::SurfaceRshift(${$_[0]});
81 SDL::SurfaceGshift(${$_[0]});
85 SDL::SurfaceBshift(${$_[0]});
89 SDL::SurfaceAshift(${$_[0]});
93 SDL::SurfaceRmask(${$_[0]});
97 SDL::SurfaceGmask(${$_[0]});
101 SDL::SurfaceBmask(${$_[0]});
105 SDL::SurfaceAmask(${$_[0]});
109 SDL::SurfaceColorKey(${$_[0]});
113 SDL::SurfaceAlpha(${$_[0]});
117 SDL::SurfaceW(${$_[0]});
121 SDL::SurfaceH(${$_[0]});
125 SDL::SurfacePitch(${$_[0]});
129 SDL::SurfacePixels(${$_[0]});
133 die "SDL::Surface::pixel requires a SDL::Color"
134 if $_[3] && $SDL::DEBUG && !$_[3]->isa("SDL::Color");
136 new SDL::Color -color => SDL::SurfacePixel(${$_[0]},$_[1],$_[2],${$_[3]}) :
137 new SDL::Color -color => SDL::SurfacePixel(${$_[0]},$_[1],$_[2]);
141 die "SDL::Surface::fill requires a SDL::Rect object"
142 unless !$SDL::DEBUG || $_[1] == 0 || $_[1]->isa('SDL::Rect');
143 die "SDL::Surface::fill requires a SDL::Color object"
144 unless !$SDL::DEBUG || $_[2]->isa('SDL::Color');
146 SDL::FillRect(${$_[0]},0,${$_[2]});
148 SDL::FillRect(${$_[0]},${$_[1]},${$_[2]});
153 SDL::MUSTLOCK(${$_[0]});
157 SDL::SurfaceLock(${$_[0]});
161 SDL::SurfaceUnlock(${$_[0]});
168 die "SDL::Surface::update requires SDL::Rect objects"
169 unless $_->isa('SDL::Rect');
172 SDL::UpdateRects($$self, map { ${$_} } @_ );
181 die "SDL::Surface::blit requires SDL::Rect objects"
182 unless ($_[1] == 0 || $_[1]->isa('SDL::Rect'))
183 && ($_[3] == 0 || $_[3]->isa('SDL::Rect'));
184 die "SDL::Surface::blit requires SDL::Surface objects"
185 unless $_[2]->isa('SDL::Surface');
187 SDL::BlitSurface(map { $_ != 0 ? ${$_} : $_ } @_);
194 die "SDL::Surface::set_colors requires SDL::Color objects"
195 unless !$SDL::DEBUG || $_->isa('SDL::Color');
197 return SDL::SetColors($$self, $start, map { ${$_} } @_);
201 die "SDL::Surface::set_color_key requires a SDL::Color object"
202 unless !$SDL::DEBUG || (ref($_[2]) && $_[2]->isa('SDL::Color'));
203 SDL::SetColorKey(${$_[0]},$_[1],${$_[2]});
207 SDL::SetAlpha(${$_[0]},$_[1],$_[2]);
212 my $tmp = SDL::DisplayFormat($$self);
213 SDL::FreeSurface ($$self);
220 my $tmp = SDL::ConvertRGB($$self);
221 SDL::FreeSurface($$self);
228 my $tmp = SDL::ConvertRGBA($$self);
229 SDL::FreeSurface($$self);
236 new SDL::Rect -width => $self->width(), -height => $self->height(),
237 -x => $_[0] || 0, -y => $_[1] || 0;
241 my ($self,$x,$y,@text) = @_;
242 SDL::SFont::PutString( $$self, $x, $y, join('',@text));
246 SDL::SaveBMP( ${$_[0]},$_[1]);
262 SDL::Surface - a SDL perl extension
267 $image = new SDL::Surface(-name=>"yomama.jpg");
271 The C<SDL::Surface> module encapsulates the SDL_Surface* structure, and
272 many of its ancillatory functions. Not only is it a workhorse of the
273 OO Layer, it is the base class for the C<SDL::App> class.
277 SDL_SWSURFACE SDL_HWSURFACE
278 SDL_ASYNCBLIT SDL_ANYFORMAT
279 SDL_HWPALETTE SDL_DOUBLEBUF
280 SDL_FULLSCREEN SDL_OPENGL
281 SDL_OPENGLBLIT SDL_RESIZEABLE
282 SDL_NOFRAME SDL_SRCCOLORKEY
283 SDL_RLEACCEL SDL_SRCALPHA
288 =head2 new (-name => 'foo.png')
290 The C<SDL::Surface> class can be instantiated in a number of different ways.
291 If support for the SDL_image library was included when SDL_perl was compiled,
292 the easiest way to create a new surface is to use the C<SDL::Surface::new>
293 method with the C<-name> option. This will load the image from the file
294 and return an object encapsulating the SDL_Surface*.
296 =head2 new (-from => $buffer, ... )
298 If the contents of the new Surface is already in memory, C<SDL::Surface::new>
299 may be called with the C<-from> option to create an image from that section
300 of memory. This method takes the following additional parameters:
306 -width the width of the image in pixels
310 -height the height of the image in pixels
314 -depth the number of bits per pixel
318 -pitch the number of bytes per line
322 -Rmask an optional bitmask for red
326 -Gmask an optional bitmask for green
330 -Bmask an optional bitmask for green
334 -Amask an optional bitmask for alpha
338 =head2 new ( -flags => SDL_SWSURFACE, ... )
340 Finally, C<SDL::Suface::new> may be invoked with the C<-flags> option, in a
341 similar fashion to the C<-from> directive. This invocation takes the same
342 additional options as C<-from> with the exception of C<-pitch> which is ignored.
343 This method returns a new, blank, SDL::Surface option with any of the following
350 SWSURFACE() a non-accelerated surface
354 HWSURFACE() a hardware accelerated surface
358 SRCCOLORKEY() a surface with a transperant color
362 SRCALPHA() an alpha blended, translucent surface
368 C<SDL::Surface::flags> returns the flags with which the surface was initialized.
372 C<SDL::Surface::palette> currently returns a SDL_Palette*, this may change in
377 C<SDL::Surface::bpp> returns the bits per pixel of the surface
379 =head2 bytes_per_pixel ()
381 C<SDL::Surface::bytes_per_pixel> returns the bytes per pixel of the surface
385 C<SDL::Surface::Rshift> returns the bit index of the red field for the surface's pixel format
389 C<SDL::Surface::Gshift> returns the bit index of the green field for the surface's pixel format
393 C<SDL::Surface::Bshift> returns the bit index of the blue field for the surface's pixel format
397 C<SDL::Surface::Ashift> returns the bit index of the alpha field for the surface's pixel format
401 C<SDL::Surface::Rmask> returns the bit mask for the red field for teh surface's pixel format
405 C<SDL::Surface::Gmask> returns the bit mask for the green field for teh surface's pixel format
409 C<SDL::Surface::Bmask> returns the bit mask for the blue field for teh surface's pixel format
413 C<SDL::Surface::Amask> returns the bit mask for the alpha field for teh surface's pixel format
417 C<SDL::Surface::color_key> returns the current color key for the image, which can be set with
418 the C<SDL::Surface::set_color_key> method. Before calling C<SDL::Surface::color_key> on
419 a image, you should fist call C<SDL::Surface::display_format> to convert it to the same
420 format as the display. Failure to do so will result in failure to apply the correct color_key.
424 C<SDL::Surface::alpha> returns the current alpha value for the image, which can be set with
425 the C<SDL::Surface::set_alpha> method.
429 C<SDL::Surface::width> returns the width in pixels of the surface
433 C<SDL::Surface::height> returns the height in pixels of the surface
437 C<SDL::Surface::pitch> returns the width of a surface's scanline in bytes
441 C<SDL::Surface::pixels> returns a Uint8* to the image's pixel data. This is not
442 inherently useful within perl, though may be used to pass image data to user provided
445 =head2 pixel (x,y,[color])
447 C<SDL::Surface::pixel> will set the color value of the pixel at (x,y) to the given
448 color if provided. C<SDL::Surface::pixel> returns a SDL::Color object for the
449 color value of the pixel at (x,y) after any possible modifications.
451 =head2 fill (rect,color)
453 C<SDL::Surface::fill> will fill the given SDL::Rect rectangle with the specified SDL::Color
454 This function optionally takes a SDL_Rect* and a SDL_Color*
458 C<SDL::Surface::lockp> returns true if the surface must be locked
462 C<SDL::Surface::lock> places a hardware lock if necessary, preventing access to
467 C<SDL::Surface::unlock> removes any hardware locks, enabling blits
469 =head2 update ( rects...)
471 C<SDL::Surface::update> takes one or more SDL::Rect's which determine which sections
472 of the image are to be updated. This option is only useful on the appliaction surface.
476 C<SDL::Surface::flip> updates the full surface, using a double buffer if available
478 =head2 blit (srect,dest,drect)
480 C<SDL::Surface::blit> blits the current surface onto the destination surface,
481 according to the provided rectangles. If a rectangle is 0, then the full surface is used.
483 =head2 set_colors (start,colors...)
485 C<SDL::Surface::set_colors> updates the palette starting at index C<start> with the
486 supplied colors. The colors may either be SDL::Color objects or SDL_Color* from the
487 low level C-style API.
489 =head2 set_color_key (flag,pixel) or (flag,x,y)
491 C<SDL::Surface::set_color_key> sets the blit flag, usually SDL_SRCCOLORKEY,
492 to the specified L<SDL::Color> object. Optional a SDL_Color* may be passed.
494 =head2 set_alpha (flag,alpha)
496 C<SDL::Surface::set_alpha> sets the opacity of the image for alpha blits.
497 C<alpha> takes a value from 0x00 to 0xff.
499 =head2 display_format ()
501 C<SDL::Surface::display_format> converts the surface to the same format as the
505 C<SDL::Surface::rgb> converts the surface to a 24 bit rgb format regardless of the
509 C<SDL::Surface::rgba> converts the surface to a 32 bit rgba format regarless of the
512 =head2 print (x,y,text...)
514 C<SDL::Surface::print> renders the text using the current font onto the image.
515 This option is only supported for with SDL_image and SFont.
517 =head2 save_bmp (filename)
519 C<SDL::Surface::save_bmp> saves the surface to filename in Windows BMP format.
523 C<SDL::Surface::video_info> returns a hash describing the current state of the
532 L<perl> L<SDL::App> L<SDL::Color> L<SDL::Palette> L<SDL::Rect>