Permalink
Browse files

Updated Overlay pods

  • Loading branch information...
1 parent 9a778a6 commit 9b1915c0105a33ac0274defc4a0a24f0125ea3c7 @kthakore kthakore committed Nov 27, 2009
Showing with 31 additions and 1 deletion.
  1. +31 −1 lib/pods/SDL/Overlay.pod
@@ -22,9 +22,10 @@ Init the video susbsystem.
Create a display to use.
- my $display = SDL::SetVideoMore(640, 480, 32, SDL_SWSURFACE);
+ my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
Create and attach the display to a new overlay
+
my $overlay = SDL::Overlay->new( 100, 100, SDL_YV12_OVERLAY, $display);
=head1 DESCRIPTION
@@ -64,5 +65,34 @@ SDL_UYVY_OVERLAY 0x59565955 /* Packed mode: U0+Y0+V0+Y1 */
=item *
SDL_YVYU_OVERLAY 0x55595659 /* Packed mode: Y0+V0+Y1+U0 */
+
+=head2 format
+
+Overlay format (see YUV_Flags)
+
+=head2 w, h
+
+Width and height of overlay
+
+=head2 planes
+
+Number of planes in the overlay. Usually either 1 or 3
+
+=head2 pitches
+
+An array of pitches, one for each plane. Pitch is the length of a row in bytes.
+
+=head2 pixels
+
+As of release 2.3 direct right to overlay is disable.
+
+An array of pointers to the data of each plane. The overlay should be locked before these pointers are used.
+
+see L<SDL::Video::lock_YUV_overlay>, L<SDL::Video::unload_YUV_overlay>
+
+=head2 hw_overlay
+
+This will be set to 1 if the overlay is hardware accelerated.
+
=back

0 comments on commit 9b1915c

Please sign in to comment.