.\" -*- 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::GFX::Rotozoom 3pm"
.TH pods::SDL::GFX::Rotozoom 3pm 2024-03-28 "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::GFX::Rotozoom \- rotation and zooming functions for surfaces
.SH CATEGORY
.IX Header "CATEGORY"
GFX
.SH CONSTANTS
.IX Header "CONSTANTS"
The constants are exported by default. You can avoid this by doing:
.PP
.Vb 1
\& use SDL::GFX::Rotozoom ();
.Ve
.PP
and access them directly:
.PP
.Vb 1
\& SDL::GFX::Rotozoom::SMOOTHING_OFF;
.Ve
.PP
or by choosing the export tags below:
.PP
Export tag: ':smoothing'
.PP
.Vb 2
\& SMOOTHING_OFF
\& SMOOTHING_ON
.Ve
.SH METHODS
.IX Header "METHODS"
.SS surface
.IX Subsection "surface"
.Vb 1
\& my $new_surface = SDL::GFX::Rotozoom::surface( $surface, $angle, $zoom, $smooth );
.Ve
.PP
With \f(CW\*(C`SDL::GFX::Rotozoom::surface\*(C'\fR you have the opportunity to rotate and zoom a given surface.
The surface will be rotated counter clockwise (in degrees).
Pass \f(CW\*(C`SMOOTHING_ON\*(C'\fR or \f(CW\*(C`SMOOTHING_OFF\*(C'\fR in order to turn it on or off.
.PP
\&\fBNote\fR: The new surface (with $\f(CW\*(C`zoom == 1\*(C'\fR) will usually be bigger than the source \f(CW$surface\fR.
.PP
\&\fBNote\fR: Note: new surface should be less than 16384 in width and height.
.PP
Example:
.PP
.Vb 5
\& use SDL;
\& use SDL::Video;
\& use SDL::Rect;
\& use SDL::Surface;
\& use SDL::GFX::Rotozoom;
\& 
\& my $screen_width  = 640;
\& my $screen_height = 480;
\& 
\& SDL::init(SDL_INIT_VIDEO);
\& 
\& my $screen  = SDL::Video::set_video_mode(800, 600, 32, SDL_SWSURFACE);
\& my $picture = SDL::Video::load_BMP(\*(Aqtest.bmp\*(Aq);
\& 
\& my $rotated = SDL::GFX::Rotozoom::surface( $picture, 45, 0.8, SMOOTHING_ON );
\& 
\& SDL::Video::blit_surface( $rotated, SDL::Rect\->new(0, 0, $rotated\->w, $rotated\->h), 
\&                           $screen,  SDL::Rect\->new(0, 0, 0, 0) );
\& 
\& SDL::Video::update_rect( $screen, 0, 0, 0, 0 );
\& 
\& sleep(2);
.Ve
.SS surface_xy
.IX Subsection "surface_xy"
.Vb 1
\& my $new_surface = SDL::GFX::Rotozoom::surface_xy( $surface, $angle, $zoom_x, $zoom_y, $smooth );
.Ve
.PP
Same as SDL::GFX::Rotozoom::surface but you can specify the zoomlevel for x and y separately.
.SS surface_size
.IX Subsection "surface_size"
.Vb 1
\& my ($new_width, $new_height) = @{ SDL::GFX::Rotozoom::surface_size( $width, $height, $angle, $zoom ) };
.Ve
.PP
\&\f(CW\*(C`surface_size\*(C'\fR will give you the width and height of an rotating/zoom operation for the given \f(CW$width\fR and \f(CW$height\fR.
Helpful for knowing the surface size before actually do the rotating/zoom operation.
.SS surface_size_xy
.IX Subsection "surface_size_xy"
.Vb 1
\& my ($new_width, $new_height) = @{ SDL::GFX::Rotozoom::surface_size_xy( $width, $height, $angle, $zoom_x, $zoom_y ) };
.Ve
.PP
Same as SDL::GFX::Rotozoom::surface_size but you can specify the zoomlevel for x and y separately.
.SS zoom_surface
.IX Subsection "zoom_surface"
.Vb 1
\& my $new_surface = SDL::GFX::Rotozoom::zoom_surface( $surface, $zoom_x, $zoom_y, $smooth );
.Ve
.PP
Same as SDL::GFX::Rotozoom::surface_xy except you can zoom only.
.SS zoom_surface_size
.IX Subsection "zoom_surface_size"
.Vb 1
\& my ($new_width, $new_height) = SDL::GFX::Rotozoom::zoom_surface_size( $width, $height, $zoom_x, $zoom_y );
.Ve
.PP
Same as SDL::GFX::Rotozoom::surface_size_xy except you can specify zoom only.
.SS shrink_surface
.IX Subsection "shrink_surface"
.Vb 1
\& my $new_surface = SDL::GFX::Rotozoom::shrink_surface( $surface, $factor_x, $factor_y );
.Ve
.PP
Specialized function for shrinking a surface.
.SS rotate_surface_90_degrees
.IX Subsection "rotate_surface_90_degrees"
.Vb 1
\& my $new_surface = SDL::GFX::Rotozoom::rotate_surface_90_degrees( $surface, $num_clockwise_turns );
.Ve
.PP
Rotating a surface \f(CW$num_clockwise_turns\fR\-times.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.