.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::Surface 3pm"
.TH pods::SDL::Surface 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::Surface \- Graphic surface structure
.SH CATEGORY
.IX Header "CATEGORY"
Core, Video, Structure
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& 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);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
An \f(CW\*(C`SDL_Surface\*(C'\fR defines a surfaceangular area of pixels.
.SH CONSTANTS
.IX Header "CONSTANTS"
The constants for SDL::Surface belong to SDL::Video, under the export tag of \f(CW\*(Aq:surface\*(Aq\fR.
.IP SDL_ASYNCBLIT 4
.IX Item "SDL_ASYNCBLIT"
Use asynchronous blit if possible
.IP SDL_SWSURFACE 4
.IX Item "SDL_SWSURFACE"
Store in system memory
.IP SDL_HWSURFACE 4
.IX Item "SDL_HWSURFACE"
Store in video memory
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 3
\& my $surface = SDL::Surface\->new(
\&     $flags, $width, $height, $depth, $Rmask, $Gmask, $Bmask, $Amask
\& );
.Ve
.PP
The constructor creates a new surface with the specified parameter values.
.PP
The four mask values are the bits that the channel will ignore.
For example, an Rmask of \f(CW0xFF\fR will ignore that channel completely, making everything on the surface more green/blue.
.SS new_from
.IX Subsection "new_from"
.Vb 3
\& my $surface = SDL::Surface\->new_from(
\&     $surface, $width, $height, $depth, $Rmask, $Gmask, $Bmask, $Amask
\& );
.Ve
.PP
The constructor creates a new surface with the specified parameter values.
The flags are taken from the specified \f(CW$surface\fR.
.SS w
.IX Subsection "w"
.Vb 1
\& my $w = $surface\->w;
.Ve
.PP
Returns the width of the surface.
SDL::Surface width is defined at construction so this is read-only.
.SS h
.IX Subsection "h"
.Vb 1
\& my $h = $surface\->h;
.Ve
.PP
Returns the height of the surface.
SDL::Surface height is defined at construction so this is read-only.
.SS format
.IX Subsection "format"
.Vb 1
\& my $format = $surface\->format;
.Ve
.PP
The format of the pixels stored in the surface.
See SDL::PixelFormat
.SS pitch
.IX Subsection "pitch"
.Vb 1
\& my $pitch = $surface\->pitch;
.Ve
.PP
The scanline length in bytes.
.SH "Direct Write to Surface Pixel"
.IX Header "Direct Write to Surface Pixel"
\&\fBDisclaimer:\fR The following methods can be very slow, making them suitable for creating surfaces, but not for animations
.SS get_pixel
.IX Subsection "get_pixel"
.Vb 1
\& my $pixel = $surface\->get_pixel( $offset )
.Ve
.PP
Returns the numeric pixel value for the given \f(CW$offset\fR.
The pixel value depends on current pixel format.
.PP
\&\fBNote:\fR For surfaces with a palette (1 byte per pixel) the palette index is returned instead of color values.
.SS set_pixels
.IX Subsection "set_pixels"
.Vb 1
\& $surface\->set_pixels( $offset, $value );
.Ve
.PP
Sets the pixel \f(CW$value\fR to the given \f(CW$offset\fR.
The pixel value must fit the pixel format of the surface.
.PP
\&\fBNote\fR: For surfaces with a palette (1 byte per pixel) the palette index must be passed instead of color values.
.PP
Example:
.PP
.Vb 4
\& sub putpixel {
\&     my ($x, $y, $color) = @_;
\&     $display\->set_pixels( $x + $y * $display\->w, $color);
\& }
.Ve
.PP
See also \fIexamples/pixel_operations/sols/ch02.pl\fR!
.SS get_pixels_ptr
.IX Subsection "get_pixels_ptr"
.Vb 1
\& my $ptr = $surface\->get_pixels_ptr;
.Ve
.PP
Returns a reference to the surface's pixels.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SDL, SDL::PixelFormat, SDL::Video, SDL::Rect
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.