SDL::Surface - Graphic surface structure
Core, Video, Structure
use SDL; use SDL::Video; use SDL::Surface; # Create the main surface (display) SDL::init(SDL_INIT_VIDEO); my $display = SDL::Video::set_video_mode(640, 480, 16, SDL_SWSURFACE); # Create other surfaces attached to the $display. my $surface = SDL::Surface->new(SDL_ASYNCBLIT | SDL_HWSURFACE, 640, 480, 16, 0, 0, 0, 0); my $surface2 = SDL::Surface->new_from($surface, 100, 100, 8, 0, 0, 0, 0);
An SDL_Surface defines a surfaceangular area of pixels.
SDL_Surface
The constants for SDL::Surface belong to SDL::Video, under the export tag of ':surface'.
':surface'
Use asynchronous blit if possible
Store in system memory
Store in video memory
my $surface = SDL::Surface->new( $flags, $width, $height, $depth, $Rmask, $Gmask, $Bmask, $Amask );
The constructor creates a new surface with the specified parameter values.
The four mask values are the bits that the channel will ignore. For example, an Rmask of 0xFF will ignore that channel completely, making everything on the surface more green/blue.
0xFF
my $surface = SDL::Surface->new_from( $surface, $width, $height, $depth, $Rmask, $Gmask, $Bmask, $Amask );
The constructor creates a new surface with the specified parameter values. The flags are taken from the specified $surface.
$surface
my $w = $surface->w;
Returns the width of the surface. SDL::Surface width is defined at construction so this is read-only.
my $h = $surface->h;
Returns the height of the surface. SDL::Surface height is defined at construction so this is read-only.
my $format = $surface->format;
The format of the pixels stored in the surface. See SDL::PixelFormat
my $pitch = $surface->pitch;
The scanline length in bytes.
Disclaimer: The following methods can be very slow, making them suitable for creating surfaces, but not for animations
my $pixel = $surface->get_pixel( $offset )
Returns the pixel value for the given $offset. The pixel value depends on current pixel format.
$offset
Note: For surfaces with a palette (1 byte per pixel) the palette index is returned instead of color values.
$surface->set_pixels( $offset, $value );
Sets the pixel $value to the given $offset. The pixel value must fit the pixel format of the surface.
$value
Note: For surfaces with a palette (1 byte per pixel) the palette index must be passed instead of color values.
Example:
sub putpixel { my ($x, $y, $color) = @_; $display->set_pixels( $x + $y * $display->w, $color); }
See also examples/pixel_operations/sols/ch02.pl!
my $ptr = $surface->get_pixels_ptr;
Returns a reference to the surface's pixels.
SDL, SDL::PixelFormat, SDL::Video, SDL::Rect
See "AUTHORS" in SDL.
To install SDL, copy and paste the appropriate command in to your terminal.
cpanm
cpanm SDL
CPAN shell
perl -MCPAN -e shell install SDL
For more information on module installation, please visit the detailed CPAN module installation guide.