pages/SDLx-Surface.html-inc

   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>
   9 <li><a href="#CONSTRUCTOR">CONSTRUCTOR </a>
  10 <ul><li><a href="#new">new</a></li>
  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>
  19 <li><a href="#load">load</a></li>
  20 <li><a href="#blit">blit </a></li>
  21 <li><a href="#blit_by">blit_by</a></li>
  22 <li><a href="#flip">flip</a></li>
  23 <li><a href="#update">update</a></li>
  24 <li><a href="#draw_rect">draw_rect</a></li>
  25 <li><a href="#draw_line">draw_line</a></li>
  26 <li><a href="#draw_circle">draw_circle</a></li>
  27 <li><a href="#draw_circle_filled">draw_circle_filled</a></li>
  28 <li><a href="#draw_gfx_text">draw_gfx_text</a></li>
  29 </ul>
  30 </li>
  31 <li><a href="#AUTHORS">AUTHORS</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-&gt;new( surface =&gt; $display);
  57
  58  $surf_matrix-&gt;[10][10] = 0xFFFF; #for 16bpp write white at x = 10 and y=10
  59
  60  $surf_matrix-&gt;surface( $new_surface );
  61
  62  my $orig_surface = $surf_matrix-&gt;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>
  72 <h1 id="CONSTRUCTOR">CONSTRUCTOR </h1><p><a href="#TOP" class="toplink">Top</a></p>
  73 <div id="CONSTRUCTOR_CONTENT">
  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 =&gt;' that is loaded. Otherwise you can define at least a width and a height. </p>
  80 <pre>   SDLx::Surface-&gt;new(  surface =&gt; $surface) # The $surface is loaded
  81
  82         SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200)
  83                 # A SDL::Surface-&gt;new( SDL_ANYFORMAT, 400, 200, 32) is loaded
  84
  85         SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200, flags=&gt; SDL_SWSURFACE, depth=&gt;24 )
  86                 # A SDL::Surface-&gt;new( SDL_SWSURFACE, 400, 200, 24) is loaded
  87
  88         SDLx::Surface-&gt;new( width=&gt; 400, height=&gt;200, flags=&gt; SDL_SWSURFACE, depth=&gt;32, greenmask=&gt;0xFF000000 )
  89                 # A SDL::Surface-&gt;new( SDL_ANYFORMAT, 400, 200, 32, 0, 0xFF000000,0, 0, 0 ) is loaded
  90         SDLx::Surface-&gt;new( w =&gt; 1, h =&gt; 1, color =&gt; 0xFF0000FF )
  91                 # A SDL::Surface-&gt;new( SDL_ANYFORMAT, 1, 1, 32, 0, 0, 0, 0 ) is loaded
  92                 all pixels are colored with color (red)
  93
  94 </pre>
  95
  96 </div>
  97 <h2 id="display">display</h2>
  98 <div id="display_CONTENT">
  99 <p>If <a href="/SDLx-App.html#new">SDLx::App::new</a> or <a href="/SDL-Video.html#get_video_mode">SDL::Video::get_video_mode</a> called before then:</p>
 100 <pre> my $appx = SDLx::Surface::display();
 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>
 104 <pre> SDLx::Surface::display( width =&gt; 20, height =&gt; 20) #depth =&gt; 32 and SDL_ANYFORMAT used
 105
 106 </pre>
 107 <p>or you can also pass flags and depth. </p>
 108 <pre> SDLx::Surface::display( width =&gt; 20, height =&gt; 20, flags=&gt; SDL_HWSURFACE, depth=&gt;24)
 109
 110 </pre>
 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>
 112 <p>Get or create the main display surface and attach to a <code>SDLx::Surface</code>.</p>
 113
 114 </div>
 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
 137 <a href="/SDL-Video.html#get_clip_rect">SDL::Video::get_clip_rect</a> and <a href="/SDL-Video.html#set_clip_rect">SDL::Video::set_clip_rect</a>.
 138 =head1 EXTENSIONS</p>
 139
 140 </div>
 141 <h2 id="load">load</h2>
 142 <div id="load_CONTENT">
 143 <pre> my $surface = SDLx::Surface-&gt;load( 'hero.png' );
 144  my $surface = SDLx::Surface-&gt;load( 'hero.dat', 'bmp' );
 145
 146 </pre>
 147 <p>Loads the given image file into a <i>new</i> SDLx::Surface surface. A new
 148 surface is <strong>always</strong> created, even if you call it from an already crafted
 149 object. Croaks on errors such as no support built for that image extension
 150 or a file reading error (the error message is SDL::get_error and should
 151 give more details).</p>
 152 <p>Note that load() will automatically figure out the extension based on the
 153 filename you provide. If you wish to force an extension for whatever reason
 154 (like having a filename with a different extension or none at all), you can
 155 optionally pass the file type as a second parameter. Case is not relevant.</p>
 156 <p>If you don't have SDL_image in your build, only bitmap images will be
 157 supported.</p>
 158 <p>Returns the new Surface.</p>
 159
 160
 161
 162
 163
 164 </div>
 165 <h2 id="blit">blit </h2>
 166 <div id="blit_CONTENT">
 167 <pre> $sdlx_surface-&gt;blit( $dest, $src_rect, $dest_rect );
 168
 169 </pre>
 170 <p>Blits <code>SDLx::Surface</code> onto $dest surface.
 171 $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,
 172 it will be blitted at <code>(0, 0)</code>. $src_rect or $dest_rect can be array refs or <code>SDL::Rect</code>. $dest can be <code>SDLx::Surface</code> or <code>SDL::Surface</code>.</p>
 173 <p>Returns $self</p>
 174
 175 </div>
 176 <h2 id="blit_by">blit_by</h2>
 177 <div id="blit_by_CONTENT">
 178 <pre> $sdlx_surface-&gt;blit_by( $src, $src_rect, $dest_rect );
 179
 180 </pre>
 181 <p>Does the same as <code>blit</code> but the <code>SDLx::Surface</code> is the one being blitted to.
 182 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>
 183
 184 </div>
 185 <h2 id="flip">flip</h2>
 186 <div id="flip_CONTENT">
 187 <p>Applies <a href="/SDL-Video.html#flip">SDL::Video::flip</a> to the Surface, with error checking.</p>
 188 <p>Returns $self</p>
 189
 190 </div>
 191 <h2 id="update">update</h2>
 192 <div id="update_CONTENT">
 193 <pre> $sdlx_surface-&gt;update(); # whole surface is updated
 194  $sdlx_surface-&gt;update([0,0,1,1]); # only that area (0,0,1,1) is updated
 195
 196  $sdlx_surface-&gt;update( [ SDL::Rect-&gt;new(0,0,1,2) ... ]); # defined rects are updated
 197
 198 </pre>
 199 <p>Applies <a href="/SDL-Video.html#update_rect">SDL::Video::update_rect</a> for no rect or 1 array ref. Applies
 200 <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
 203
 204
 205
 206
 207 </div>
 208 <h2 id="draw_rect">draw_rect</h2>
 209 <div id="draw_rect_CONTENT">
 210 <pre> $sdlx_surface-&gt;draw_rect( [$x,$y,$w,$h], 0xFFFF00FF );
 211  $sdlx_surface-&gt;draw_rect( SDL::Rect-&gt;new($x,$y,$w,$h), 0xFFFF00FF );
 212
 213 </pre>
 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>
 215 <p>Returns $self</p>
 216
 217 </div>
 218 <h2 id="draw_line">draw_line</h2>
 219 <div id="draw_line_CONTENT">
 220 <pre> $sdlx_surface-&gt;draw_line( [$x1, $y1], [$x2, $y2], $color, $antialias); # $color is a number
 221  $sdlx_surface-&gt;draw_line( [$x1, $y1], [$x2, $y2], \@color, $antialias); #
 222
 223 </pre>
 224 <p>Draws a line on the surface. Antialias is turned on if $antialias is true. </p>
 225 <p>Returns $self</p>
 226
 227 </div>
 228 <h2 id="draw_circle">draw_circle</h2>
 229 <div id="draw_circle_CONTENT">
 230 <pre> $sdlx_surface-&gt;draw_circle( [$x1, $y1], $radius, \@color );
 231
 232 </pre>
 233 <p>Draws an unfilled circle at <code>($x1,$y1)</code> of size $radius and $color.</p>
 234 <p>Returns $self</p>
 235
 236 </div>
 237 <h2 id="draw_circle_filled">draw_circle_filled</h2>
 238 <div id="draw_circle_filled_CONTENT">
 239 <pre> $sdlx_surface-&gt;draw_filled_circle( [$x1, $y1], $radius, \@color );
 240
 241 </pre>
 242 <p>Draws an <strong>filled</strong> circle at <code>($x1,$y1)</code> of size $radius and $color.</p>
 243 <p>Returns $self</p>
 244
 245
 246
 247
 248
 249
 250
 251
 252 </div>
 253 <h2 id="draw_gfx_text">draw_gfx_text</h2>
 254 <div id="draw_gfx_text_CONTENT">
 255 <p>Draw text using gfx (not pretty but fast) at give vector, color.</p>
 256 <pre> $surf-&gt;draw_gfx_text( [0,0], 0xffffffff, &quot;fooo&quot;);
 257  $surf-&gt;draw_gfx_text( [10,10], [20,20,20,20], &quot;fooo&quot;);
 258
 259 </pre>
 260 <p>You can also set the gfx font but passing a hash reference as shown below.</p>
 261 <pre> my $f = '';
 262  open( my $FH, '&lt;', 'test/data/5x7.fnt');
 263  binmode ($FH);
 264  read($FH, $f, 4096);
 265  close ($FH);
 266
 267  my $font =  {data=&gt;$f, cw =&gt; 5, ch =&gt; 7};
 268  $surf-&gt;draw_gfx_text( [0,0], 0xffffffff, &quot;fooo&quot;, $font );
 269
 270 </pre>
 271 <p>Returns $self</p>
 272
 273 </div>
 274 <h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
 275 <div id="AUTHORS_CONTENT">
 276 <p>See <a href="/SDL.html#AUTHORS">/SDL.html#AUTHORS</a>.</p>
 277
 278 </div>
 279 </div>