SDL::Surface - Graphic surface structure.
Core, Video, Structure
The main surface (display) is provided by SDL::Video::set_video_mode. use SDL; #provides flags & constants use SDL::Video; #provides access to set_video_mode use SDL::Surface; #provides access to SDL_Surface struct internals
SDL::init(SDL_INIT_VIDEO); my $display = SDL::Video::set_video_mode();
All surfaces constructed from now on are attached to the $display. There are two constructors available to do this.
my $surface = SDL::Surface->new ( ... ); my $surface2 = SDL::Surface->new_from ( surface, ... );
An SDL_Surface
defines a surfaceangular area of pixels.
The constants are exported by default. You can avoid this by doing:
use SDL::Video ();
and access them directly:
SDL::Video::SDL_SWSURFACE;
Available constants: see flags
The constructor creates a new surface with the specified parameter values.
my $surface = SDL::Surface->new( ... );
The constructor creates a new surface with the specified parameter values.
my $surface = SDL::Surface->new_from( $old_surface, ... );
Available flags for new() are exported by SDL::Video
Use asynchronous blit if possible
Stored in the system memory.
Stored in video memory
SDL::Surface width are defined at construction. Thus the following is read only.
my $w = $surface->w;
SDL::Surface height are defined at construction. Thus the following is read only.
my $h = $surface->h;
The format of the pixels stored in the surface. See SDL::PixelFormat
my $format = $surface->format;
my $pitch = $surface->pitch;
SDL::Surface's scanline length in bytes
To get the surface's clip_rect we the following
my $clip_rect = SDL::Rect->new(0,0,0,0); SDL::Video::get_clip_rect($surface, $clip_rect);
To set the surface's clip_rect use the following
my $clip_rect = SDL::Rect->new(2,23,23,542); SDL::Video::set_clip_rect($surface, $clip_rect);
Disclaimer: This can be very slow, it is suitable for creating surfaces one time and 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.
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 current pixel $value
to the given $offset
. The pixel value must fit the pixel format of the surface.
Note: For surfaces with a palette (1 byte per pixel) the palette index must be passed instead of color values.
sub putpixel { my($x, $y, $color) = @_; $screen->set_pixels( $x + $y * $screen->w, $color); }
See also examples/sols/ch02.pl
$surface->get_pixels_ptr();
Returns the C ptr to this surfaces's pixels