[%#
  # IMPORTANT NOTE
  #   This documentation is generated automatically from source
  #   templates.  Any changes you make here may be lost.
  # 
  #   The 'docsrc' documentation source bundle is available for download
  #   from http://www.template-toolkit.org/docs.html and contains all
  #   the source templates, XML files, scripts, etc., from which the
  #   documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
        page = 'Plugin_GD_Image'
%]
[%  WRAPPER toc;
	PROCESS tocitem 
	        title ="SYNOPSIS"
                subs  = [];
	PROCESS tocitem 
	        title ="EXAMPLES"
                subs  = [];
	PROCESS tocitem 
	        title ="DESCRIPTION"
                subs  = [];
	PROCESS tocitem 
	        title ="AUTHOR"
                subs  = [];
	PROCESS tocitem 
	        title ="VERSION"
                subs  = [];
	PROCESS tocitem 
	        title ="COPYRIGHT"
                subs  = [];
	PROCESS tocitem 
	        title ="SEE ALSO"
                subs  = [];
    END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
    title="SYNOPSIS"
-%]<pre>    [% tt_start_tag %] USE im = GD.Image(x_size, y_size) [% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
    title="EXAMPLES"
-%]<pre>    [% tt_start_tag %] 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, &quot;Large Red Text&quot;, red);
        im.png | stdout(1);
       END;
    -[% tt_end_tag %]</pre>
<pre>    [% tt_start_tag %] 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;
    -[% tt_end_tag %]</pre>
<pre>    [% tt_start_tag %] FILTER null;
        USE im   = GD.Image(100,100);
        USE c    = GD.Constants;
        USE poly = GD.Polygon;</pre>
<pre>        # 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);</pre>
<pre>        # make the background transparent and interlaced
        im.transparent(white);
        im.interlaced('true');</pre>
<pre>        # Put a black frame around the picture
        im.rectangle(0,0,99,99,black);</pre>
<pre>        # Draw a blue oval
        im.arc(50,50,95,75,0,360,blue);</pre>
<pre>        # And fill it with red
        im.fill(50,50,red);</pre>
<pre>        # Draw a blue triangle
        poly.addPt(50,0);
        poly.addPt(99,99);
        poly.addPt(0,99);
        im.filledPolygon(poly, blue);</pre>
<pre>        # Output binary image in PNG format
        im.png | stdout(1);
       END;
    -[% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
    title="DESCRIPTION"
-%]<p>
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.
</p>
<p>
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).
</p>
<p>
See [% ttlink('GD') -%] for a complete description of the GD library and all the
methods that can be called via the GD.Image plugin.
See [% ttlink('Template::Plugin::GD::Constants') -%] for a plugin that allows you
access to GD.pm's constants.
</p>
[%- END %]
[% WRAPPER section
    title="AUTHOR"
-%]<p>
Craig Barratt &lt;craig@arraycomm.com&gt;
</p>
<p>
Lincoln D. Stein wrote the GD.pm interface to the GD library.
</p>
[%- END %]
[% WRAPPER section
    title="VERSION"
-%]<p>
1.43, distributed as part of the
Template Toolkit version 2.08, released on 30 July 2002.
</p>
[%- END %]
[% WRAPPER section
    title="COPYRIGHT"
-%]<p>
Copyright (C) 2001 Craig Barratt &lt;craig@arraycomm.com&gt;
</p>
<p>
The GD.pm interface is copyright 1995-2000, Lincoln D. Stein.
</p>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
    title="SEE ALSO"
-%]<p>
[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('Template::Plugin::GD', 'Template::Plugin::GD') -%], [% ttlink('Template::Plugin::GD::Polygon', 'Template::Plugin::GD::Polygon') -%], [% ttlink('Template::Plugin::GD::Constants', 'Template::Plugin::GD::Constants') -%], [% ttlink('GD', 'GD') -%]
</p>
[%- END %]