[sdlgit/SDL-Site.git] / pages / SDLx-Surface.html-inc

<div class="pod">
<!-- INDEX START -->
<h3 id="TOP">Index</h3>

<ul><li><a href="#NAME">NAME</a></li>
<li><a href="#CATEGORY">CATEGORY</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#CONSTRUCTOR">CONSTRUCTOR </a>
<ul><li><a href="#new">new</a></li>
<li><a href="#display">display</a></li>
<li><a href="#duplicate">duplicate</a></li>
</ul>
</li>
<li><a href="#ATTRIBUTES">ATTRIBUTES</a>
<ul><li><a href="#surface">surface</a></li>
<li><a href="#w_h_format_pitch_flags">w, h, format, pitch, flags</a></li>
<li><a href="#clip_rect">clip_rect</a></li>
</ul>
</li>
<li><a href="#EXTENSIONS">EXTENSIONS</a>
<ul><li><a href="#load">load</a></li>
<li><a href="#blit">blit </a></li>
<li><a href="#blit_by">blit_by</a></li>
<li><a href="#flip">flip</a></li>
<li><a href="#update">update</a></li>
<li><a href="#draw_rect">draw_rect</a></li>
<li><a href="#draw_line">draw_line</a></li>
</ul>
</li>
<li><a href="#AUTHOR">AUTHOR</a>
</li>
</ul><hr />
<!-- INDEX END -->

<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="NAME_CONTENT">
<p>SDLx::Surface - Graphic surface matrix extension</p>

</div>
<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="CATEGORY_CONTENT">
<p>Extension</p>

</div>
<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="SYNOPSIS_CONTENT">
<pre> use SDL;
 use SDL::Video;
 use SDLx::Surface;

 # Create the main surface (display)
 SDL::init(SDL_INIT_VIDEO);
 my $display = SDL::Video::set_video_mode(640, 480, 16, SDL_SWSURFACE);

 my $surf_matrix = SDLx::Surface-&gt;new( surface =&gt; $display);

 $surf_matrix-&gt;[10][10] = 0xFFFF; #for 16bpp write white at x = 10 and y=10

 $surf_matrix-&gt;surface( $new_surface );

 my $orig_surface = $surf_matrix-&gt;surface();

</pre>

</div>
<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="DESCRIPTION_CONTENT">
<p>An <code>SDLx::Surface</code> allows matrix read and write to a surface, safely. </p>

</div>
<h1 id="CONSTRUCTOR">CONSTRUCTOR </h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="CONSTRUCTOR_CONTENT">

</div>
<h2 id="new">new</h2>
<div id="new_CONTENT">
<p>Takes a SDL::Surface in hash format.</p>
<p>If a surface is passed to 'surface =&gt;' that is loaded. Otherwise you can define at least a width and a height. </p>
<pre>	SDLx::Surface-&gt;new(  surface =&gt; $surface) # The $surface is loaded

	SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200) 
		# A SDL::Surface-&gt;new( SDL_ANYFORMAT, 400, 200, 32) is loaded

	SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200, flags=&gt; SDL_SWSURFACE, depth=&gt;24 ) 
	  	# A SDL::Surface-&gt;new( SDL_SWSURFACE, 400, 200, 24) is loaded 

	SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200, flags=&gt; SDL_SWSURFACE, depth=&gt;32, greenmask=&gt;0xFF000000 )
		# A SDL::Surface-&gt;new( SDL_ANYFORMAT, 400, 200, 32, 0, 0xFF000000,0, 0, 0 ) is loaded
	SDLx::Surface-&gt;new( w =&gt; 1, h =&gt; 1, color =&gt; 0xFF0000FF )
		# A SDL::Surface-&gt;new( SDL_ANYFORMAT, 1, 1, 32, 0, 0, 0, 0 ) is loaded
		all pixels are colored with color (red)

</pre>

</div>
<h2 id="display">display</h2>
<div id="display_CONTENT">
<p>If <a href="http://search.cpan.org/perldoc?SDLx::App::new">SDLx::App::new</a> or <a href="/SDL-Video.html#get_video_mode">SDL::Video::get_video_mode</a> called before then:</p>
<pre> my $appx = SDLx::Surface::display(); 

</pre>
<p>gets the display if it is already made. Passed options are ignored. Otherwise you can quickly make the display with :</p>
<pre> SDLx::Surface::display( width =&gt; 20, height =&gt; 20) #depth =&gt; 32 and SDL_ANYFORMAT used

</pre>
<p>or you can also pass flags and depth. </p>
<pre> SDLx::Surface::display( width =&gt; 20, height =&gt; 20, flags=&gt; SDL_HWSURFACE, depth=&gt;24) 

</pre>
<p>You can also use the keys <code>w</code> and <code>h</code> in place of <code>width</code> and <code>height</code>, as with <code>new</code>.</p>
<p>Get or create the main display surface and attach to a SDLx::Surface.</p>

</div>
<h2 id="duplicate">duplicate</h2>
<div id="duplicate_CONTENT">
<p>Does a attributes only, no pixel, copy of another SDLx::Surface. </p>

</div>
<h1 id="ATTRIBUTES">ATTRIBUTES</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="ATTRIBUTES_CONTENT">

</div>
<h2 id="surface">surface</h2>
<div id="surface_CONTENT">
<p>If a SDL::Surface is passed it is attached to the matrix. Returns the SDL::Surface that is currently attached to this SDLx::Surface</p>

</div>
<h2 id="w_h_format_pitch_flags">w, h, format, pitch, flags</h2>
<div id="w_h_format_pitch_flags_CONTENT">
<p>Returns the inner SDL::Surface's respective attribute. See <code>SDL::Surface</code>.</p>

</div>
<h2 id="clip_rect">clip_rect</h2>
<div id="clip_rect_CONTENT">
<p>Sets the passed <code>SDL::Rect</code> as the new clip_rect for the surface. Returns the SDL::Surface's clip_rect. See <code>SDL::Video::get_clip_rect</code> and <code>SDL::Video::set_clip_rect</code>.</p>

</div>
<h1 id="EXTENSIONS">EXTENSIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="EXTENSIONS_CONTENT">

</div>
<h2 id="load">load</h2>
<div id="load_CONTENT">
<pre> my $surface = SDLx::Surface-&gt;load( 'hero.png' );
 my $surface = SDLx::Surface-&gt;load( 'hero.dat', 'bmp' );

</pre>
<p>Loads the given image file into a <i>new</i> SDLx::Surface surface. A new
surface is <strong>always</strong> created, even if you call it from an already crafted
object. Croaks on errors such as no support built for that image extension
or a file reading error (the error message is SDL::get_error and should
give more details).</p>
<p>Note that load() will automatically figure out the extension based on the
filename you provide. If you wish to force an extension for whatever reason
(like having a filename with a different extension or none at all), you can
optionally pass the file type as a second parameter. Case is not relevant.</p>
<p>If you don't have SDL_image in your build, only bitmap images will be
supported.</p>
<p>Returns the new Surface.</p>


</div>
<h2 id="blit">blit </h2>
<div id="blit_CONTENT">
<pre> $sdlx_surface-&gt;blit( $dest, $src_rect, $dest_rect );

</pre>
<p>Blits SDLx::Surface onto $dest surface. 
$src_rect or $dest_rect are optional. If $src_rect is ommited, it will be the size of the entire surface. If $dest_rect is ommited, it will be blitted at <code>(0, 0)</code>. $src_rect or $dest_rect can be array refs or SDL::Rect. $dest can be SDLx::Surface or SDL::Surface.</p>
<p>Returns $self</p>

</div>
<h2 id="blit_by">blit_by</h2>
<div id="blit_by_CONTENT">
<pre> $sdlx_surface-&gt;blit_by( $src, $src_rect, $dest_rect );

</pre>
<p>Does the same as <code>blit</code> but the <code>SDLx::Surface</code> is the one being blitted to.
This is useful when the surface you have isn't an <code>SDLx::Surface</code>, but the surface it is being blitted to is.</p>

</div>
<h2 id="flip">flip</h2>
<div id="flip_CONTENT">
<p>Applies <a href="/SDL-Video.html#flip">SDL::Video::flip</a> to the Surface, with error checking.</p>
<p>Returns $self</p>

</div>
<h2 id="update">update</h2>
<div id="update_CONTENT">
<pre> $sdlx_surface-&gt;update(); # whole surface is updated
 $sdlx_surface-&gt;update([0,0,1,1]); # only that area (0,0,1,1) is updated

 $sdlx_surface-&gt;update( [ SDL::Rect-&gt;new(0,0,1,2) ... ]); # defined rects are updated

</pre>
<p>Applies <a href="/SDL-Video.html#update_rect">SDL::Video::update_rect</a> for no rect or 1 array ref. Applies <a href="/SDL-Video.html#update_rects">SDL::Video::update_rects</a> for array of <a href="SDL-Rect.html">SDL::Rect</a>s. </p>
<p>Returns $self</p>


</div>
<h2 id="draw_rect">draw_rect</h2>
<div id="draw_rect_CONTENT">
<pre> $sdlx_surface-&gt;draw_rect( [$x,$y,$w,$h], 0xFFFF00FF );
 $sdlx_surface-&gt;draw_rect( SDL::Rect-&gt;new($x,$y,$w,$h), 0xFFFF00FF );

</pre>
<p>Draws a rect on the surface with the given color. If the rect is ommited, the colored rect will be drawn to the entire surface.</p>
<p>Returns $self</p>

</div>
<h2 id="draw_line">draw_line</h2>
<div id="draw_line_CONTENT">
<pre> $sdlx_surface-&gt;draw_line( [$x1, $y1], [$x2, $y2], $color, $antialias); # $color is a number
 $sdlx_surface-&gt;draw_line( [$x1, $y1], [$x2, $y2], \@color, $antialias); # 

</pre>
<p>Draws a line on the surface. Antialias is turned on if $antialias is true. </p>
<p>Returns $self</p>

</div>
<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="AUTHOR_CONTENT">
<pre> kthakore 

</pre>

</div>
</div>
Commit	Line	Data
30fd24c2	1	<div class="pod">
	2	<!-- INDEX START -->
	3	<h3 id="TOP">Index</h3>
	4
	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>
807ae0cd	9	<li><a href="#CONSTRUCTOR">CONSTRUCTOR </a>
30fd24c2	10	<ul><li><a href="#new">new</a></li>
807ae0cd	11	<li><a href="#display">display</a></li>
	12	<li><a href="#duplicate">duplicate</a></li>
	13	</ul>
	14	</li>
	15	<li><a href="#ATTRIBUTES">ATTRIBUTES</a>
	16	<ul><li><a href="#surface">surface</a></li>
	17	<li><a href="#w_h_format_pitch_flags">w, h, format, pitch, flags</a></li>
	18	<li><a href="#clip_rect">clip_rect</a></li>
30fd24c2	19	</ul>
	20	</li>
	21	<li><a href="#EXTENSIONS">EXTENSIONS</a>
33a8f248	22	<ul><li><a href="#load">load</a></li>
33a8f248	23	<li><a href="#blit">blit </a></li>
505f308d	24	<li><a href="#blit_by">blit_by</a></li>
30fd24c2	25	<li><a href="#flip">flip</a></li>
30fd24c2	26	<li><a href="#update">update</a></li>
807ae0cd	27	<li><a href="#draw_rect">draw_rect</a></li>
807ae0cd	28	<li><a href="#draw_line">draw_line</a></li>
30fd24c2	29	</ul>
	30	</li>
	31	<li><a href="#AUTHOR">AUTHOR</a>
	32	</li>
	33	</ul><hr />
	34	<!-- INDEX END -->
	35
	36	<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
	37	<div id="NAME_CONTENT">
	38	<p>SDLx::Surface - Graphic surface matrix extension</p>
	39
	40	</div>
	41	<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
	42	<div id="CATEGORY_CONTENT">
	43	<p>Extension</p>
	44
	45	</div>
	46	<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
	47	<div id="SYNOPSIS_CONTENT">
	48	<pre> use SDL;
	49	use SDL::Video;
	50	use SDLx::Surface;
	51
	52	# Create the main surface (display)
	53	SDL::init(SDL_INIT_VIDEO);
	54	my $display = SDL::Video::set_video_mode(640, 480, 16, SDL_SWSURFACE);
	55
	56	my $surf_matrix = SDLx::Surface->new( surface => $display);
	57
807ae0cd	58	$surf_matrix->[10][10] = 0xFFFF; #for 16bpp write white at x = 10 and y=10
30fd24c2	59
	60	$surf_matrix->surface( $new_surface );
	61
	62	my $orig_surface = $surf_matrix->surface();
	63
	64	</pre>
	65
	66	</div>
	67	<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
	68	<div id="DESCRIPTION_CONTENT">
	69	<p>An <code>SDLx::Surface</code> allows matrix read and write to a surface, safely. </p>
	70
	71	</div>
807ae0cd	72	<h1 id="CONSTRUCTOR">CONSTRUCTOR </h1><p><a href="#TOP" class="toplink">Top</a></p>
807ae0cd	73	<div id="CONSTRUCTOR_CONTENT">
30fd24c2	74
	75	</div>
	76	<h2 id="new">new</h2>
	77	<div id="new_CONTENT">
	78	<p>Takes a SDL::Surface in hash format.</p>
	79	<p>If a surface is passed to 'surface =>' that is loaded. Otherwise you can define at least a width and a height. </p>
	80	<pre> SDLx::Surface->new( surface => $surface) # The $surface is loaded
	81
	82	SDLx::Surface->new( width=> 400, height=>200)
	83	# A SDL::Surface->new( SDL_ANYFORMAT, 400, 200, 32) is loaded
	84
	85	SDLx::Surface->new( width=> 400, height=>200, flags=> SDL_SWSURFACE, depth=>24 )
	86	# A SDL::Surface->new( SDL_SWSURFACE, 400, 200, 24) is loaded
	87
	88	SDLx::Surface->new( width=> 400, height=>200, flags=> SDL_SWSURFACE, depth=>32, greenmask=>0xFF000000 )
	89	# A SDL::Surface->new( SDL_ANYFORMAT, 400, 200, 32, 0, 0xFF000000,0, 0, 0 ) is loaded
505f308d	90	SDLx::Surface->new( w => 1, h => 1, color => 0xFF0000FF )
	91	# A SDL::Surface->new( SDL_ANYFORMAT, 1, 1, 32, 0, 0, 0, 0 ) is loaded
	92	all pixels are colored with color (red)
807ae0cd	93
807ae0cd	94	</pre>
30fd24c2	95
30fd24c2	96	</div>
807ae0cd	97	<h2 id="display">display</h2>
807ae0cd	98	<div id="display_CONTENT">
30fd24c2	99	<p>If <a href="http://search.cpan.org/perldoc?SDLx::App::new">SDLx::App::new</a> or <a href="/SDL-Video.html#get_video_mode">SDL::Video::get_video_mode</a> called before then:</p>
807ae0cd	100	<pre> my $appx = SDLx::Surface::display();
30fd24c2	101
	102	</pre>
	103	<p>gets the display if it is already made. Passed options are ignored. Otherwise you can quickly make the display with :</p>
807ae0cd	104	<pre> SDLx::Surface::display( width => 20, height => 20) #depth => 32 and SDL_ANYFORMAT used
30fd24c2	105
	106	</pre>
	107	<p>or you can also pass flags and depth. </p>
807ae0cd	108	<pre> SDLx::Surface::display( width => 20, height => 20, flags=> SDL_HWSURFACE, depth=>24)
30fd24c2	109
30fd24c2	110	</pre>
505f308d	111	<p>You can also use the keys <code>w</code> and <code>h</code> in place of <code>width</code> and <code>height</code>, as with <code>new</code>.</p>
30fd24c2	112	<p>Get or create the main display surface and attach to a SDLx::Surface.</p>
	113
	114	</div>
807ae0cd	115	<h2 id="duplicate">duplicate</h2>
	116	<div id="duplicate_CONTENT">
	117	<p>Does a attributes only, no pixel, copy of another SDLx::Surface. </p>
	118
	119	</div>
	120	<h1 id="ATTRIBUTES">ATTRIBUTES</h1><p><a href="#TOP" class="toplink">Top</a></p>
	121	<div id="ATTRIBUTES_CONTENT">
	122
	123	</div>
	124	<h2 id="surface">surface</h2>
	125	<div id="surface_CONTENT">
	126	<p>If a SDL::Surface is passed it is attached to the matrix. Returns the SDL::Surface that is currently attached to this SDLx::Surface</p>
	127
	128	</div>
	129	<h2 id="w_h_format_pitch_flags">w, h, format, pitch, flags</h2>
	130	<div id="w_h_format_pitch_flags_CONTENT">
	131	<p>Returns the inner SDL::Surface's respective attribute. See <code>SDL::Surface</code>.</p>
	132
	133	</div>
	134	<h2 id="clip_rect">clip_rect</h2>
	135	<div id="clip_rect_CONTENT">
	136	<p>Sets the passed <code>SDL::Rect</code> as the new clip_rect for the surface. Returns the SDL::Surface's clip_rect. See <code>SDL::Video::get_clip_rect</code> and <code>SDL::Video::set_clip_rect</code>.</p>
	137
	138	</div>
30fd24c2	139	<h1 id="EXTENSIONS">EXTENSIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
	140	<div id="EXTENSIONS_CONTENT">
	141
	142	</div>
33a8f248	143	<h2 id="load">load</h2>
	144	<div id="load_CONTENT">
	145	<pre> my $surface = SDLx::Surface->load( 'hero.png' );
	146	my $surface = SDLx::Surface->load( 'hero.dat', 'bmp' );
	147
	148	</pre>
	149	<p>Loads the given image file into a <i>new</i> SDLx::Surface surface. A new
	150	surface is <strong>always</strong> created, even if you call it from an already crafted
	151	object. Croaks on errors such as no support built for that image extension
	152	or a file reading error (the error message is SDL::get_error and should
	153	give more details).</p>
	154	<p>Note that load() will automatically figure out the extension based on the
	155	filename you provide. If you wish to force an extension for whatever reason
	156	(like having a filename with a different extension or none at all), you can
	157	optionally pass the file type as a second parameter. Case is not relevant.</p>
	158	<p>If you don't have SDL_image in your build, only bitmap images will be
	159	supported.</p>
	160	<p>Returns the new Surface.</p>
	161
	162
	163
	164
	165
	166	</div>
30fd24c2	167	<h2 id="blit">blit </h2>
	168	<div id="blit_CONTENT">
	169	<pre> $sdlx_surface->blit( $dest, $src_rect, $dest_rect );
	170
	171	</pre>
	172	<p>Blits SDLx::Surface onto $dest surface.
505f308d	173	$src_rect or $dest_rect are optional. If $src_rect is ommited, it will be the size of the entire surface. If $dest_rect is ommited, it will be blitted at <code>(0, 0)</code>. $src_rect or $dest_rect can be array refs or SDL::Rect. $dest can be SDLx::Surface or SDL::Surface.</p>
30fd24c2	174	<p>Returns $self</p>
	175
	176	</div>
505f308d	177	<h2 id="blit_by">blit_by</h2>
	178	<div id="blit_by_CONTENT">
	179	<pre> $sdlx_surface->blit_by( $src, $src_rect, $dest_rect );
	180
	181	</pre>
	182	<p>Does the same as <code>blit</code> but the <code>SDLx::Surface</code> is the one being blitted to.
	183	This is useful when the surface you have isn't an <code>SDLx::Surface</code>, but the surface it is being blitted to is.</p>
	184
	185	</div>
30fd24c2	186	<h2 id="flip">flip</h2>
	187	<div id="flip_CONTENT">
	188	<p>Applies <a href="/SDL-Video.html#flip">SDL::Video::flip</a> to the Surface, with error checking.</p>
	189	<p>Returns $self</p>
	190
	191	</div>
	192	<h2 id="update">update</h2>
	193	<div id="update_CONTENT">
	194	<pre> $sdlx_surface->update(); # whole surface is updated
	195	$sdlx_surface->update([0,0,1,1]); # only that area (0,0,1,1) is updated
	196
	197	$sdlx_surface->update( [ SDL::Rect->new(0,0,1,2) ... ]); # defined rects are updated
	198
	199	</pre>
	200	<p>Applies <a href="/SDL-Video.html#update_rect">SDL::Video::update_rect</a> for no rect or 1 array ref. Applies <a href="/SDL-Video.html#update_rects">SDL::Video::update_rects</a> for array of <a href="SDL-Rect.html">SDL::Rect</a>s. </p>
	201	<p>Returns $self</p>
	202
807ae0cd	203
	204
	205
	206
30fd24c2	207	</div>
807ae0cd	208	<h2 id="draw_rect">draw_rect</h2>
	209	<div id="draw_rect_CONTENT">
	210	<pre> $sdlx_surface->draw_rect( [$x,$y,$w,$h], 0xFFFF00FF );
	211	$sdlx_surface->draw_rect( SDL::Rect->new($x,$y,$w,$h), 0xFFFF00FF );
30fd24c2	212
807ae0cd	213	</pre>
505f308d	214	<p>Draws a rect on the surface with the given color. If the rect is ommited, the colored rect will be drawn to the entire surface.</p>
807ae0cd	215	<p>Returns $self</p>
30fd24c2	216
807ae0cd	217	</div>
	218	<h2 id="draw_line">draw_line</h2>
	219	<div id="draw_line_CONTENT">
	220	<pre> $sdlx_surface->draw_line( [$x1, $y1], [$x2, $y2], $color, $antialias); # $color is a number
	221	$sdlx_surface->draw_line( [$x1, $y1], [$x2, $y2], \@color, $antialias); #
	222
	223	</pre>
505f308d	224	<p>Draws a line on the surface. Antialias is turned on if $antialias is true. </p>
807ae0cd	225	<p>Returns $self</p>
30fd24c2	226
807ae0cd	227	</div>
	228	<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
	229	<div id="AUTHOR_CONTENT">
	230	<pre> kthakore
30fd24c2	231
	232	</pre>
	233
	234	</div>
	235	</div>