3 <h3 id="TOP">Index</h3>
5 <ul><li><a href="#NAME">NAME</a></li>
6 <li><a href="#CATEGORY">CATEGORY</a></li>
7 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
8 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
9 <li><a href="#METHODS">METHODS</a>
10 <ul><li><a href="#new_flags_width_height_depth_Rmask_G">new ( flags, width, height, depth, Rmask, Gmask, Bmask, Amask )</a></li>
11 <li><a href="#new_from_surface_width_height_depth_">new_from ( surface, width, height, depth, Rmask, Gmask, Bmask, Amask )</a>
12 <ul><li><a href="#Construtor_Parameters">Construtor Parameters</a>
13 <ul><li><a href="#flags">flags</a></li>
18 <li><a href="#w">w</a></li>
19 <li><a href="#h">h</a></li>
20 <li><a href="#format">format</a></li>
21 <li><a href="#pitch">pitch</a></li>
22 <li><a href="#clip_rect">clip_rect</a></li>
25 <li><a href="#Direct_Write_to_Surface_Pixel">Direct Write to Surface Pixel</a>
26 <ul><li><a href="#get_pixels">get_pixels</a></li>
27 <li><a href="#set_pixels">set_pixels</a>
28 <ul><li><a href="#Usage">Usage</a></li>
31 <li><a href="#get_pixels_ptr">get_pixels_ptr</a></li>
34 <li><a href="#SEE_ALSO">SEE ALSO</a>
39 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
40 <div id="NAME_CONTENT">
41 <p>SDL::Surface - Graphic surface structure.</p>
44 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
45 <div id="CATEGORY_CONTENT">
46 <p>Core, Video, Structure</p>
49 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
50 <div id="SYNOPSIS_CONTENT">
51 <p>The main surface (display) is provided by <a href="/SDL-Video.html#set_video_mode">SDL::Video::set_video_mode</a>.
52 use SDL; #provides flags & constants
53 use SDL::Video; #provides access to set_video_mode
54 use SDL::Surface; #provides access to SDL_Surface struct internals</p>
55 <pre> SDL::init(SDL_INIT_VIDEO);
56 my $display = SDL::Video::set_video_mode();
59 <p>All surfaces constructed from now on are attached to the $display. There are two constructors available to do this.</p>
60 <pre> my $surface = SDL::Surface->new ( ... );
61 my $surface2 = SDL::Surface->new_from ( surface, ... );
66 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
67 <div id="DESCRIPTION_CONTENT">
68 <p>An <code>SDL_Surface</code> defines a surfaceangular area of pixels.</p>
71 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
72 <div id="METHODS_CONTENT">
75 <h2 id="new_flags_width_height_depth_Rmask_G">new ( flags, width, height, depth, Rmask, Gmask, Bmask, Amask )</h2>
76 <div id="new_flags_width_height_depth_Rmask_G-2">
77 <p>The constructor creates a new surface with the specified parameter values.</p>
78 <pre> my $surface = SDL::Surface->new( ... );
83 <h2 id="new_from_surface_width_height_depth_">new_from ( surface, width, height, depth, Rmask, Gmask, Bmask, Amask )</h2>
84 <div id="new_from_surface_width_height_depth_-2">
85 <p>The constructor creates a new surface with the specified parameter values. </p>
86 <pre> my $surface = SDL::Surface->new_from( $old_surface, ... );
94 <h3 id="Construtor_Parameters">Construtor Parameters</h3>
95 <div id="Construtor_Parameters_CONTENT">
98 <h4 id="flags">flags</h4>
99 <div id="flags_CONTENT">
101 <dt>SDL_ANYFORMAT</dt>
103 <p>Allow any pixel-format *</p>
105 <dt>SDL_ASYNCBLIT</dt>
107 <p>Use asynchronous blit if possible</p>
109 <dt>SDL_DOUBLEBUF</dt>
111 <p>Double buffered *</p>
115 <p>Use hardware acceleration blit</p>
117 <dt>SDL_HWPALETTE</dt>
119 <p>Have an exclusive palette</p>
121 <dt>SDL_HWSURFACE</dt>
123 <p>Stored in video memory</p>
125 <dt>SDL_FULLSCREEN</dt>
127 <p>Full screen surface *</p>
131 <p>Have an OpenGL context *</p>
133 <dt>SDL_OPENGLBLIT</dt>
135 <p>Support OpenGL blitting *. NOTE: This option is kept for compatibility only, and is not recommended for new code.</p>
137 <dt>SDL_RESIZABLE</dt>
139 <p>Resizable surface *</p>
141 <dt>SDL_RLEACCEL</dt>
143 <p>Accelerated colorkey blitting with RLE</p>
145 <dt>SDL_SRCALPHA</dt>
147 <p>Use alpha blending blit</p>
149 <dt>SDL_SRCCOLORKEY</dt>
151 <p>Use colorkey blitting</p>
153 <dt>SDL_SWSURFACE</dt>
155 <p>Stored in the system memory. SDL_SWSURFACE is not actually a flag (it is defined as 0). A lack of SDL_HWSURFACE implies SDL_SWSURFACE</p>
157 <dt>SDL_PREALLOC</dt>
159 <p>Use preallocated memory</p>
170 <p>SDL::Surface width are defined at construction. Thus the following is read only. </p>
171 <pre> my $w = $surface->w;
178 <p>SDL::Surface height are defined at construction. Thus the following is read only. </p>
179 <pre> my $h = $surface->h;
184 <h2 id="format">format</h2>
185 <div id="format_CONTENT">
186 <p>The format of the pixels stored in the surface. See <a href="SDL-PixelFormat.html">SDL::PixelFormat</a></p>
187 <pre> my $format = $surface->format;
192 <h2 id="pitch">pitch</h2>
193 <div id="pitch_CONTENT">
194 <pre> my $pitch = $surface->pitch;
197 <p>SDL::Surface's scanline length in bytes</p>
200 <h2 id="clip_rect">clip_rect</h2>
201 <div id="clip_rect_CONTENT">
202 <p>To get the surface's clip_rect we the following</p>
203 <pre> my $clip_rect = SDL::Rect->new(0,0,0,0);
204 SDL::Video::get_clip_rect($surface, $clip_rect);
207 <p>To set the surface's clip_rect use the following</p>
208 <pre> my $clip_rect = SDL::Rect->new(2,23,23,542);
209 SDL::Video::set_clip_rect($surface, $clip_rect);
214 <h1 id="Direct_Write_to_Surface_Pixel">Direct Write to Surface Pixel</h1><p><a href="#TOP" class="toplink">Top</a></p>
215 <div id="Direct_Write_to_Surface_Pixel_CONTEN">
216 <p>Disclaimer: This can be very slow, it is suitable for creating surfaces one time and not for animations</p>
219 <h2 id="get_pixels">get_pixels</h2>
220 <div id="get_pixels_CONTENT">
221 <pre> $surface->get_pixels( $offset )
224 <p>Returns the current integer value at (surface->pixels)[offset] </p>
227 <h2 id="set_pixels">set_pixels</h2>
228 <div id="set_pixels_CONTENT">
229 <pre> $surface->set_pixels( $offset, $value );
232 <p>Sets the current integer to $value at (surface->pixels)[offset]</p>
235 <h3 id="Usage">Usage</h3>
236 <div id="Usage_CONTENT">
239 my($x, $y, $color) = @_;
240 my $lineoffset = $y * ($screen->pitch / $depth_in_bytes);
241 $screen->set_pixels( $lineoffset+ $x, $color);
245 <p>Note: $depth_in_bytes for 32 is 4, 16 is 2, 8 is 1;</p>
246 <p>See also examples/sols/ch02.pl</p>
249 <h2 id="get_pixels_ptr">get_pixels_ptr</h2>
250 <div id="get_pixels_ptr_CONTENT">
251 <pre> $surface->get_pixels_ptr();
254 <p>Returns the C ptr to this surfaces's pixels</p>
264 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
265 <div id="SEE_ALSO_CONTENT">
266 <p><a href="SDL.html">SDL</a>, <a href="SDL-PixelFormat.html">SDL::PixelFormat</a>, <a href="SDL-Video.html">SDL::Video</a>, <a href="SDL-Rect.html">SDL::Rect</a></p>