- document Imager::Filter::Mandelbrot
authorTony Cook <tony@develop=help.com>
Wed, 11 Jan 2006 08:24:42 +0000 (08:24 +0000)
committerTony Cook <tony@develop=help.com>
Wed, 11 Jan 2006 08:24:42 +0000 (08:24 +0000)
Changes
Mandelbrot/Mandelbrot.pm

diff --git a/Changes b/Changes
index da459ba..e95eb32 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1294,6 +1294,7 @@ Revision history for Perl extension Imager.
 - added t/t92samples.t to check samples/README against MANIFEST
 - added inline_replace_color.pl to samples
 - constify the Imager API
+- document Imager::Filter::Mandelbrot
 
 =================================================================
 
index 1a4c29f..f762fa1 100644 (file)
@@ -40,3 +40,52 @@ Imager->register_filter(type=>'mandelbrot',
                         callseq => \@callseq);
 
 1;
+
+__END__
+
+=head1 NAME
+
+Imager::Filter::Mandelbrot - filter that renders the Mandelbrot set.
+
+=head1 SYNOPSIS
+
+  use Imager;
+  use Imager::Filter::Mandelbrot;
+
+  $img->filter(type=>'mandelbrot', ...);
+
+=head1 DESCRIPTION
+
+This is a expansion of the mandelbrot dynamically loadable filter
+provided in dynfilt in previous releases of Imager.
+
+Valid filter parameters are:
+
+=over
+
+=item *
+
+minx, maxx - the range of x values to render.  Defaults: -2.5, 1.5.
+
+=item *
+
+miny, maxy - the range of y values to render.  Defaults: -1.5, 1.5
+
+=item *
+
+maxiter - the maximum number of iterations to perform when checking if
+the sequence tend towards infinity.
+
+=back
+
+=head1 AUTHOR
+
+Original by Arnar M. Hrafnkelsson.
+
+Adapted and expanded by Tony Cook <tony@imager.perl.org>
+
+=head1 SEE ALSO
+
+Imager, Imager::Filters.
+
+=cut