.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "pods::SDL::Tutorial 3pm"
.TH pods::SDL::Tutorial 3pm "2016-09-18" "perl v5.24.1" "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::Tutorial \- introduction to Perl SDL
.SS "\s-1CATEGORY\s0"
.IX Subsection "CATEGORY"
Tutorials
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        # to read this tutorial
\&        $ perldoc SDL::Tutorial
\&
\&        # to run this tutorial 
\&        $ perl \-MSDL::Tutorial \-e 1
.Ve
.SH "SDL Manual"
.IX Header "SDL Manual"
\&\f(CW\*(C`SDL::Tutorial\*(C'\fR are incomplete and old. A new book has been started to provide 
a complete tutorial for \s-1SDL.\s0 See <http://bit.ly/hvxc9V>.
.SH "SDL BASICS"
.IX Header "SDL BASICS"
\&\s-1SDL,\s0 the Simple DirectMedia Layer, is a cross-platform multimedia library.
These are the Perl 5 bindings.  You can find out more about \s-1SDL\s0 at
<http://www.libsdl.org/>. You can find out more about \s-1SDL\s0 perl at <http://sdl.perl.org>.
.PP
Creating an \s-1SDL\s0 application with Perl is easy.  You have to know a few basics,
though.  Here's how to get up and running as quickly as possible.
.SS "Surfaces"
.IX Subsection "Surfaces"
All graphics in \s-1SDL\s0 live on a surface.  You'll need at least one.  That's what
SDLx::App provides.
.PP
Of course, before you can get a surface, you need to initialize your video
mode.  \s-1SDL\s0 gives you several options, including whether to run in a window or
take over the full screen, the size of the window, the bit depth of your
colors, and whether to use hardware acceleration.  For now, we'll build
something really simple.
.SS "Initialization"
.IX Subsection "Initialization"
SDLx::App makes it easy to initialize video and create a surface.  Here's how to
ask for a windowed surface with 640x480x16 resolution:
.PP
.Vb 1
\&        use SDLx::App;
\&
\&        my $app = SDLx::App\->new(
\&                width  => 640,
\&                height => 480,
\&                depth  => 16,
\&        );
.Ve
.PP
You can get more creative, especially if you use the \f(CW\*(C`title\*(C'\fR and \f(CW\*(C`icon\*(C'\fR
attributes in a windowed application.  Here's how to set the window title of
the application to \f(CW\*(C`My SDL Program\*(C'\fR:
.PP
.Vb 1
\&        use SDLx::App;
\&
\&        my $app = SDLx::App\->new(
\&                height => 640,
\&                width  => 480,
\&                depth  => 16,
\&                title  => \*(AqMy SDL Program\*(Aq,
\&        );
.Ve
.PP
Setting an icon is a little more involved \*(-- you have to load an image onto a
surface.  That's a bit more complicated, but see the \f(CW\*(C`name\*(C'\fR parameter to
\&\f(CW\*(C`SDL::Surface\-\*(C'\fR\fInew()\fR> if you want to skip ahead.
.SS "Working With The App"
.IX Subsection "Working With The App"
Since \f(CW$app\fR from the code above is just an \s-1SDL\s0 surface with some extra sugar,
it behaves much like SDL::Surface.  In particular, the all-important \f(CW\*(C`blit\*(C'\fR
and \f(CW\*(C`update\*(C'\fR methods work.  You'll need to create SDL::Rect objects
representing sources of graphics to draw onto the \f(CW$app\fR's surface, \f(CW\*(C`blit\*(C'\fR
them there, then \f(CW\*(C`update\*(C'\fR the \f(CW$app\fR.
.PP
\&\fBNote:\fR  \*(L"blitting\*(R" is copying a chunk of memory from one place to another.
.PP
That, however, is another tutorial.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "SDL::Tutorial::Animation" 4
.IX Item "SDL::Tutorial::Animation"
basic rectangle drawing and animation
.IP "SDL::Tutorial::LunarLander" 4
.IX Item "SDL::Tutorial::LunarLander"
basic image loading and animation
.SH "AUTHORS"
.IX Header "AUTHORS"
chromatic, <chromatic@wgz.org>.
.PP
Written for and maintained by the Perl \s-1SDL\s0 project, <http://sdl.perl.org/>. See \*(L"\s-1AUTHORS\*(R"\s0 in \s-1SDL\s0 for details.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003 \- 2004, chromatic. 2009 \- 2010, kthakore.  All rights reserved.  This module is
distributed under the same terms as Perl itself, in the hope that it is useful
but certainly under no guarantee.