.\" -*- 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 "Template::Plugin::GD::Image 3"
.TH Template::Plugin::GD::Image 3 2024-07-13 "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
Template::Plugin::GD::Image \- Interface to GD Graphics Library
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    [% USE im = GD.Image(width, height) %]
.Ve
.SH EXAMPLES
.IX Header "EXAMPLES"
.Vb 9
\&    [% FILTER null;
\&        USE gdc = GD.Constants;
\&        USE im  = GD.Image(200,100);
\&        black = im.colorAllocate(0  ,0,  0);
\&        red   = im.colorAllocate(255,0,  0);
\&        r = im.string(gdc.gdLargeFont, 10, 10, "Large Red Text", red);
\&        im.png | stdout(1);
\&       END;
\&    \-%]
\&
\&    [% FILTER null;
\&        USE im = GD.Image(100,100);
\&        # allocate some colors
\&        black = im.colorAllocate(0,   0, 0);
\&        red   = im.colorAllocate(255,0,  0);
\&        blue  = im.colorAllocate(0,  0,  255);
\&        # Draw a blue oval
\&        im.arc(50,50,95,75,0,360,blue);
\&        # And fill it with red
\&        im.fill(50,50,red);
\&        # Output binary image in PNG format
\&        im.png | stdout(1);
\&       END;
\&    \-%]
\&
\&    [% FILTER null;
\&        USE im   = GD.Image(100,100);
\&        USE c    = GD.Constants;
\&        USE poly = GD.Polygon;
\&
\&        # allocate some colors
\&        white = im.colorAllocate(255,255,255);
\&        black = im.colorAllocate(0,  0,  0);
\&        red   = im.colorAllocate(255,0,  0);
\&        blue  = im.colorAllocate(0,  0,255);
\&        green = im.colorAllocate(0,  255,0);
\&
\&        # make the background transparent and interlaced
\&        im.transparent(white);
\&        im.interlaced(\*(Aqtrue\*(Aq);
\&
\&        # Put a black frame around the picture
\&        im.rectangle(0,0,99,99,black);
\&
\&        # Draw a blue oval
\&        im.arc(50,50,95,75,0,360,blue);
\&
\&        # And fill it with red
\&        im.fill(50,50,red);
\&
\&        # Draw a blue triangle
\&        poly.addPt(50,0);
\&        poly.addPt(99,99);
\&        poly.addPt(0,99);
\&        im.filledPolygon(poly, blue);
\&
\&        # Output binary image in PNG format
\&        im.png | stdout(1);
\&       END;
\&    \-%]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The GD.Image plugin provides an interface to GD.pm's GD::Image class.
The GD::Image class is the main interface to GD.pm.
.PP
It is very important that no extraneous template output appear before
or after the image.  Since some methods return values that would
otherwise appear in the output, it is recommended that GD.Image code
be wrapped in a null filter.  The methods that produce the final
output (eg, png, jpeg, gd etc) can then explicitly make their output
appear by using the stdout filter, with a non-zero argument to force
binary mode (required for non-modern operating systems).
.PP
See GD for a complete description of the GD library and all the
methods that can be called via the GD.Image plugin.  See
Template::Plugin::GD::Constants for a plugin that allows you access
to GD.pm's constants.
.SH AUTHOR
.IX Header "AUTHOR"
Thomas Boutell wrote the GD graphics library.
.PP
Lincoln D. Stein wrote the Perl GD modules that interface to it.
.PP
Craig Barratt <craig@arraycomm.com> wrote the original GD
plugins for the Template Toolkit (2001).
.PP
Andy Wardley <abw@cpan.org> extracted them from the TT core
into a separate distribution for TT version 2.15.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001 Craig Barratt <craig@arraycomm.com>, 
2006 Andy Wardley <abw@cpan.org>.
.PP
The GD.pm interface is copyright 1995\-2000, Lincoln D. Stein.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template::Plugin::GD, GD