.\" -*- 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::Overlay 3pm"
.TH pods::SDL::Overlay 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::Overlay \- YUV Video overlay
.SS CATEGORY
.IX Subsection "CATEGORY"
Core, Video, Structure
.SH SYNOPSIS
.IX Header "SYNOPSIS"
First import the following modules to get access to constants and functions needed for overlay.
.PP
.Vb 3
\&   use SDL;
\&   use SDL::Video;
\&   use SDL::Overlay;
.Ve
.PP
Init the video subsystem.
.PP
.Vb 1
\&   SDL::Init(SDL_INIT_VIDEO);
.Ve
.PP
Create a display to use.
.PP
.Vb 1
\&   my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
.Ve
.PP
Create and attach the display to a new overlay
.PP
.Vb 1
\&   my $overlay = SDL::Overlay\->new( 100, 100, SDL_YV12_OVERLAY, $display);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A \f(CW\*(C`SDL_Overlay\*(C'\fR allows for video rendering on an \f(CW\*(C`SDL_Surface\*(C'\fR which is a display.
.PP
The term 'overlay' is a misnomer since, unless the overlay is created in hardware, the contents for the display surface underneath the area where the overlay is shown will be overwritten when the overlay is displayed.
.SH METHODS
.IX Header "METHODS"
.ie n .SS "new ( $width, $height, $YUV_flag, $display)"
.el .SS "new ( \f(CW$width\fP, \f(CW$height\fP, \f(CW$YUV_flag\fP, \f(CW$display\fP)"
.IX Subsection "new ( $width, $height, $YUV_flag, $display)"
The constructor creates a SDL::Overlay of the specified width, height and format (see \f(CW\*(C`YUV_Flags\*(C'\fR list below of available formats), for the provided display.
.PP
Note the 'display' argument needs to actually be the surface created by \f(CW\*(C`SDL::Video::SetVideoMode\*(C'\fR otherwise this function will segfault.
.PP
.Vb 1
\&   my $overlay = SDL::Overlay\->new( $width, $height, $YUV_flag, $display );
.Ve
.PP
\fIYUV_Flags\fR
.IX Subsection "YUV_Flags"
.PP
More information on YUV formats can be found at <http://www.fourcc.org/indexyuv.htm> .
.IP \(bu 4
SDL_YV12_OVERLAY  0x32315659  /* Planar mode: Y + V + U */
.IP \(bu 4
SDL_IYUV_OVERLAY  0x56555949  /* Planar mode: Y + U + V */
.IP \(bu 4
SDL_YUY2_OVERLAY  0x32595559  /* Packed mode: Y0+U0+Y1+V0 */
.IP \(bu 4
SDL_UYVY_OVERLAY  0x59565955  /* Packed mode: U0+Y0+V0+Y1 */
.IP \(bu 4
SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */
.SS format
.IX Subsection "format"
Overlay format (see YUV_Flags)
.SS "w, h"
.IX Subsection "w, h"
Width and height of overlay
.SS planes
.IX Subsection "planes"
Number of planes in the overlay. Usually either 1 or 3
.SS pitches
.IX Subsection "pitches"
An array of pitches, one for each plane. Pitch is the length of a row in bytes.
.SS pixels
.IX Subsection "pixels"
As of release 2.3 direct right to overlay is disable.
.PP
An array of pointers to the data of each plane. The overlay should be locked before these pointers are used.
.PP
see SDL::Video::lock_YUV_overlay, SDL::Video::unload_YUV_overlay
.SS hw_overlay
.IX Subsection "hw_overlay"
This will be set to 1 if the overlay is hardware accelerated.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.