]> git.imager.perl.org - imager.git/commitdiff
C<> filter keywords to avoid trying to spellcheck them
authorTony Cook <tony@develop-help.com>
Sat, 21 Mar 2020 01:04:57 +0000 (12:04 +1100)
committerTony Cook <tony@develop-help.com>
Sat, 21 Mar 2020 01:07:25 +0000 (12:07 +1100)
Pod::Spell (or something in the pipeline) appeared to be passing the
"guassian2" through with the "2" stripped despite the stopword.

Imager.pm
lib/Imager/Filters.pod

index e5edb9160ed02d2a4e454b0c2474a8ee0953ab71..84e0ab3362c488127ecdc9508539c9abd81de91d 100644 (file)
--- a/Imager.pm
+++ b/Imager.pm
@@ -5033,7 +5033,7 @@ L<Imager::ImageTypes/"Common Tags">.
 blend - alpha blending one image onto another
 L<Imager::Transformations/rubthrough()>
 
 blend - alpha blending one image onto another
 L<Imager::Transformations/rubthrough()>
 
-blur - L<Imager::Filters/gaussian>, L<Imager::Filters/conv>
+blur - L<< Imager::Filters/C<gaussian> >>, L<< Imager::Filters/C<conv> >>
 
 boxes, drawing - L<Imager::Draw/box()>
 
 
 boxes, drawing - L<Imager::Draw/box()>
 
@@ -5049,9 +5049,9 @@ combine modes - L<Imager::Draw/"Combine Types">
 
 compare images - L<Imager::Filters/"Image Difference">
 
 
 compare images - L<Imager::Filters/"Image Difference">
 
-contrast - L<Imager::Filters/contrast>, L<Imager::Filters/autolevels>
+contrast - L<< Imager::Filters/C<contrast> >>, L<< Imager::Filters/C<autolevels> >>
 
 
-convolution - L<Imager::Filters/conv>
+convolution - L<< Imager::Filters/C<conv> >>
 
 cropping - L<Imager::Transformations/crop()>
 
 
 cropping - L<Imager::Transformations/crop()>
 
@@ -5092,27 +5092,27 @@ fonts, metrics - L<Imager::Font/bounding_box()>, L<Imager::Font::BBox>
 fonts, multiple master - L<Imager::Font/"MULTIPLE MASTER FONTS">
 
 fountain fill - L<Imager::Fill/"Fountain fills">,
 fonts, multiple master - L<Imager::Font/"MULTIPLE MASTER FONTS">
 
 fountain fill - L<Imager::Fill/"Fountain fills">,
-L<Imager::Filters/fountain>, L<Imager::Fountain>,
-L<Imager::Filters/gradgen>
+L<< Imager::Filters/C<fountain> >>, L<Imager::Fountain>,
+L<< Imager::Filters/C<gradgen> >>
 
 GIF files - L<Imager::Files/"GIF">
 
 GIF files, animated - L<Imager::Files/"Writing an animated GIF">
 
 gradient fill - L<Imager::Fill/"Fountain fills">,
 
 GIF files - L<Imager::Files/"GIF">
 
 GIF files, animated - L<Imager::Files/"Writing an animated GIF">
 
 gradient fill - L<Imager::Fill/"Fountain fills">,
-L<Imager::Filters/fountain>, L<Imager::Fountain>,
-L<Imager::Filters/gradgen>
+L<< Imager::Filters/C<fountain> >>, L<Imager::Fountain>,
+L<< Imager::Filters/C<gradgen> >>
 
 gray scale, convert image to - L<Imager::Transformations/convert()>
 
 
 gray scale, convert image to - L<Imager::Transformations/convert()>
 
-gaussian blur - L<Imager::Filters/gaussian>
+gaussian blur - L<< Imager::Filters/C<gaussian> >>, L<< Imager::Filters/C<gaussian2> >>
 
 hatch fills - L<Imager::Fill/"Hatched fills">
 
 ICO files - L<Imager::Files/"ICO (Microsoft Windows Icon) and CUR (Microsoft Windows Cursor)">
 
 
 hatch fills - L<Imager::Fill/"Hatched fills">
 
 ICO files - L<Imager::Files/"ICO (Microsoft Windows Icon) and CUR (Microsoft Windows Cursor)">
 
-invert image - L<Imager::Filters/hardinvert>,
-L<Imager::Filters/hardinvertall>
+invert image - L<< Imager::Filters/C<hardinvert> >>,
+L<< Imager::Filters/C<hardinvertall> >>
 
 JPEG - L<Imager::Files/"JPEG">
 
 
 JPEG - L<Imager::Files/"JPEG">
 
@@ -5126,12 +5126,12 @@ L<Imager::Font/transform()>
 
 metadata, image - L<Imager::ImageTypes/"Tags">, L<Image::ExifTool>
 
 
 metadata, image - L<Imager::ImageTypes/"Tags">, L<Image::ExifTool>
 
-mosaic - L<Imager::Filters/mosaic>
+mosaic - L<< Imager::Filters/C<mosaic> >>
 
 
-noise, filter - L<Imager::Filters/noise>
+noise, filter - L<< Imager::Filters/C<noise> >>
 
 
-noise, rendered - L<Imager::Filters/turbnoise>,
-L<Imager::Filters/radnoise>
+noise, rendered - L<< Imager::Filters/C<turbnoise> >>,
+L<< Imager::Filters/C<radnoise> >>
 
 paste - L<Imager::Transformations/paste()>,
 L<Imager::Transformations/rubthrough()>
 
 paste - L<Imager::Transformations/paste()>,
 L<Imager::Transformations/rubthrough()>
@@ -5141,7 +5141,7 @@ L<Imager::ImageTypes/new()>
 
 =for stopwords posterize
 
 
 =for stopwords posterize
 
-posterize - L<Imager::Filters/postlevels>
+posterize - L<< Imager::Filters/C<postlevels> >>
 
 PNG files - L<Imager::Files>, L<Imager::Files/"PNG">
 
 
 PNG files - L<Imager::Files>, L<Imager::Files/"PNG">
 
@@ -5162,7 +5162,7 @@ security - L<Imager::Security>
 
 SGI files - L<Imager::Files/"SGI (RGB, BW)">
 
 
 SGI files - L<Imager::Files/"SGI (RGB, BW)">
 
-sharpen - L<Imager::Filters/unsharpmask>, L<Imager::Filters/conv>
+sharpen - L<< Imager::Filters/C<unsharpmask> >>, L<< Imager::Filters/C<conv> >>
 
 size, image - L<Imager::ImageTypes/getwidth()>,
 L<Imager::ImageTypes/getheight()>
 
 size, image - L<Imager::ImageTypes/getwidth()>,
 L<Imager::ImageTypes/getheight()>
@@ -5180,16 +5180,16 @@ text, measuring - L<Imager::Font/bounding_box()>, L<Imager::Font::BBox>
 
 threads - L<Imager::Threads>
 
 
 threads - L<Imager::Threads>
 
-tiles, color - L<Imager::Filters/mosaic>
+tiles, color - L<< Imager::Filters/C<mosaic> >>
 
 transparent images - L<Imager::ImageTypes>,
 L<Imager::Cookbook/"Transparent PNG">
 
 =for stopwords unsharp
 
 
 transparent images - L<Imager::ImageTypes>,
 L<Imager::Cookbook/"Transparent PNG">
 
 =for stopwords unsharp
 
-unsharp mask - L<Imager::Filters/unsharpmask>
+unsharp mask - L<< Imager::Filters/C<unsharpmask> >>
 
 
-watermark - L<Imager::Filters/watermark>
+watermark - L<< Imager::Filters/C<watermark> >>
 
 writing an image to a file - L<Imager::Files>
 
 
 writing an image to a file - L<Imager::Files>
 
index d308e482d5ae21e620572c031df841fef01bc527..f80d79b152cca98a3d31351bd40e96a001b18396 100644 (file)
@@ -152,7 +152,7 @@ A reference of the filters follows:
 
 =over
 
 
 =over
 
-=item autolevels
+=item C<autolevels>
 
 Scales the luminosity of the image so that the luminosity will cover
 the possible range for the image.  C<lsat> and C<usat> truncate the
 
 Scales the luminosity of the image so that the luminosity will cover
 the possible range for the image.  C<lsat> and C<usat> truncate the
@@ -166,7 +166,7 @@ respectively.
 The method used here is typically called L<Histogram
 Equalization|http://en.wikipedia.org/wiki/Histogram_equalization>.
 
 The method used here is typically called L<Histogram
 Equalization|http://en.wikipedia.org/wiki/Histogram_equalization>.
 
-=item autolevels_skew
+=item C<autolevels_skew>
 
 Scales the value of each channel so that the values in the image will
 cover the whole possible range for the channel.  C<lsat> and C<usat>
 
 Scales the value of each channel so that the values in the image will
 cover the whole possible range for the channel.  C<lsat> and C<usat>
@@ -184,7 +184,7 @@ the range respectively.
 This filter was the original C<autolevels> filter, but it's typically
 useless due to the significant color skew it can produce.
 
 This filter was the original C<autolevels> filter, but it's typically
 useless due to the significant color skew it can produce.
 
-=item bumpmap
+=item C<bumpmap>
 
 uses the channel C<elevation> image C<bump> as a bump map on your
 image, with the light at (C<lightx>, C<lightty>), with a shadow length
 
 uses the channel C<elevation> image C<bump> as a bump map on your
 image, with the light at (C<lightx>, C<lightty>), with a shadow length
@@ -194,7 +194,7 @@ of C<st>.
                lightx=>10, lighty=>10, st=>5)
     or die $img->errstr;
 
                lightx=>10, lighty=>10, st=>5)
     or die $img->errstr;
 
-=item bumpmap_complex
+=item C<bumpmap_complex>
 
 uses the channel C<channel> image C<bump> as a bump map on your image.
 If C<< Lz < 0 >> the three L parameters are considered to be the
 
 uses the channel C<channel> image C<bump> as a bump map on your image.
 If C<< Lz < 0 >> the three L parameters are considered to be the
@@ -207,7 +207,7 @@ coefficient.  C<n> is the shininess of the surface.
   $img->filter(type=>"bumpmap_complex", bump=>$bumpmap_img)
     or die $img->errstr;
 
   $img->filter(type=>"bumpmap_complex", bump=>$bumpmap_img)
     or die $img->errstr;
 
-=item contrast
+=item C<contrast>
 
 scales each channel by C<intensity>.  Values of C<intensity> < 1.0
 will reduce the contrast.
 
 scales each channel by C<intensity>.  Values of C<intensity> < 1.0
 will reduce the contrast.
@@ -220,7 +220,7 @@ will reduce the contrast.
   $img->filter(type=>"contrast", intensity=>0.8)
     or die $img->errstr;
 
   $img->filter(type=>"contrast", intensity=>0.8)
     or die $img->errstr;
 
-=item conv
+=item C<conv>
 
 performs 2 1-dimensional convolutions on the image using the values
 from C<coef>.  C<coef> should be have an odd length and the sum of the
 
 performs 2 1-dimensional convolutions on the image using the values
 from C<coef>.  C<coef> should be have an odd length and the sum of the
@@ -238,7 +238,7 @@ coefficients must be non-zero.
   $img->filter(type=>"conv", coef=>[ -0.5, 1, -0.5 ])
     or die $img->errstr;
 
   $img->filter(type=>"conv", coef=>[ -0.5, 1, -0.5 ])
     or die $img->errstr;
 
-=item fountain
+=item C<fountain>
 
 renders a fountain fill, similar to the gradient tool in most paint
 software.  The default fill is a linear fill from opaque black to
 
 renders a fountain fill, similar to the gradient tool in most paint
 software.  The default fill is a linear fill from opaque black to
@@ -329,21 +329,21 @@ The possible values for the super_sample option are:
 
 =over
 
 
 =over
 
-=item none
+=item C<none>
 
 no super-sampling is done
 
 
 no super-sampling is done
 
-=item grid
+=item C<grid>
 
 a square grid of points are sampled.  The number of points sampled is
 the square of ceil(0.5 + sqrt(ssample_param)).
 
 
 a square grid of points are sampled.  The number of points sampled is
 the square of ceil(0.5 + sqrt(ssample_param)).
 
-=item random
+=item C<random>
 
 a random set of points within the pixel are sampled.  This looks
 pretty bad for low ssample_param values.
 
 
 a random set of points within the pixel are sampled.  This looks
 pretty bad for low ssample_param values.
 
-=item circle
+=item C<circle>
 
 the points on the radius of a circle within the pixel are sampled.
 This seems to produce the best results, but is fairly slow (for now).
 
 the points on the radius of a circle within the pixel are sampled.
 This seems to produce the best results, but is fairly slow (for now).
@@ -360,25 +360,25 @@ segment is an array ref containing:
 
 =over
 
 
 =over
 
-=item start
+=item C<start>
 
 a floating point number between 0 and 1, the start of the range of
 fill parameters covered by this segment.
 
 
 a floating point number between 0 and 1, the start of the range of
 fill parameters covered by this segment.
 
-=item middle
+=item C<middle>
 
 a floating point number between start and end which can be used to
 push the color range towards one end of the segment.
 
 
 a floating point number between start and end which can be used to
 push the color range towards one end of the segment.
 
-=item end
+=item C<end>
 
 a floating point number between 0 and 1, the end of the range of fill
 parameters covered by this segment.  This should be greater than
 start.
 
 
 a floating point number between 0 and 1, the end of the range of fill
 parameters covered by this segment.  This should be greater than
 start.
 
-=item c0
+=item C<c0>
 
 
-=item c1
+=item C<c1>
 
 The colors at each end of the segment.  These can be either
 Imager::Color or Imager::Color::Float objects.
 
 The colors at each end of the segment.  These can be either
 Imager::Color or Imager::Color::Float objects.
@@ -440,7 +440,7 @@ Really.  It even loads GIMP gradient files.
 
 =for stopwords Gaussian
 
 
 =for stopwords Gaussian
 
-=item gaussian
+=item C<gaussian>
 
 performs a Gaussian blur of the image, using C<stddev> as the standard
 deviation of the curve used to combine pixels, larger values give
 
 performs a Gaussian blur of the image, using C<stddev> as the standard
 deviation of the curve used to combine pixels, larger values give
@@ -459,7 +459,7 @@ values around 5 provide a very strong blur.
   $img->filter(type=>"gaussian", stddev=>5)
     or die $img->errstr;
 
   $img->filter(type=>"gaussian", stddev=>5)
     or die $img->errstr;
 
-=item gaussian2
+=item C<gaussian2>
 
 performs a Gaussian blur of the image, using C<stddevX>, C<stddevY> as the
 standard deviation of the curve used to combine pixels on the X and Y axis,
 
 performs a Gaussian blur of the image, using C<stddevX>, C<stddevY> as the
 standard deviation of the curve used to combine pixels on the X and Y axis,
@@ -479,7 +479,7 @@ values around 5 provide a very strong blur.
   $img->filter(type=>"gaussian", stddevX=>0, stddevY=>5 )
     or die $img->errstr;
 
   $img->filter(type=>"gaussian", stddevX=>0, stddevY=>5 )
     or die $img->errstr;
 
-=item gradgen
+=item C<gradgen>
 
 renders a gradient, with the given I<colors> at the corresponding
 points (x,y) in C<xo> and C<yo>.  You can specify the way distance is
 
 renders a gradient, with the given I<colors> at the corresponding
 points (x,y) in C<xo> and C<yo>.  You can specify the way distance is
@@ -491,7 +491,7 @@ for Euclidean squared, and 2 for Manhattan distance.
                yo=>[ 10, 50, 50 ],
                colors=>[ qw(red blue green) ]);
 
                yo=>[ 10, 50, 50 ],
                colors=>[ qw(red blue green) ]);
 
-=item hardinvert
+=item C<hardinvert>
 X<filters, hardinvert>X<hardinvert>
 
 inverts the image, black to white, white to black.  All color channels
 X<filters, hardinvert>X<hardinvert>
 
 inverts the image, black to white, white to black.  All color channels
@@ -500,7 +500,7 @@ are inverted, excluding the alpha channel if any.
   $img->filter(type=>"hardinvert")
     or die $img->errstr;
 
   $img->filter(type=>"hardinvert")
     or die $img->errstr;
 
-=item hardinvertall
+=item C<hardinvertall>
 X<filters, hardinvertall>X<hardinvertall>
 
 inverts the image, black to white, white to black.  All channels are
 X<filters, hardinvertall>X<hardinvertall>
 
 inverts the image, black to white, white to black.  All channels are
@@ -509,14 +509,14 @@ inverted, including the alpha channel if any.
   $img->filter(type=>"hardinvertall")
     or die $img->errstr;
 
   $img->filter(type=>"hardinvertall")
     or die $img->errstr;
 
-=item mosaic
+=item C<mosaic>
 
 produces averaged tiles of the given C<size>.
 
   $img->filter(type=>"mosaic", size=>5)
     or die $img->errstr;
 
 
 produces averaged tiles of the given C<size>.
 
   $img->filter(type=>"mosaic", size=>5)
     or die $img->errstr;
 
-=item noise
+=item C<noise>
 
 adds noise of the given C<amount> to the image.  If C<subtype> is
 zero, the noise is even to each channel, otherwise noise is added to
 
 adds noise of the given C<amount> to the image.  If C<subtype> is
 zero, the noise is even to each channel, otherwise noise is added to
@@ -532,7 +532,7 @@ each channel independently.
 
 =for stopwords Perlin
 
 
 =for stopwords Perlin
 
-=item radnoise
+=item C<radnoise>
 
 renders radiant Perlin turbulent noise.  The center of the noise is at
 (C<xo>, C<yo>), C<ascale> controls the angular scale of the noise ,
 
 renders radiant Perlin turbulent noise.  The center of the noise is at
 (C<xo>, C<yo>), C<ascale> controls the angular scale of the noise ,
@@ -542,7 +542,7 @@ and C<rscale> the radial scale, higher numbers give more detail.
                ascale=>1, rscale=>0.02)
     or die $img->errstr;
 
                ascale=>1, rscale=>0.02)
     or die $img->errstr;
 
-=item postlevels
+=item C<postlevels>
 
 alters the image to have only C<levels> distinct level in each
 channel.
 
 alters the image to have only C<levels> distinct level in each
 channel.
@@ -550,7 +550,7 @@ channel.
   $img->filter(type=>"postlevels", levels=>10)
     or die $img->errstr;
 
   $img->filter(type=>"postlevels", levels=>10)
     or die $img->errstr;
 
-=item turbnoise
+=item C<turbnoise>
 
 renders Perlin turbulent noise.  (C<xo>, C<yo>) controls the origin of
 the noise, and C<scale> the scale of the noise, with lower numbers
 
 renders Perlin turbulent noise.  (C<xo>, C<yo>) controls the origin of
 the noise, and C<scale> the scale of the noise, with lower numbers
@@ -561,7 +561,7 @@ giving more detail.
 
 =for stopwords unsharp
 
 
 =for stopwords unsharp
 
-=item unsharpmask
+=item C<unsharpmask>
 
 performs an unsharp mask on the image.  This increases the contrast of
 edges in the image.
 
 performs an unsharp mask on the image.  This increases the contrast of
 edges in the image.
@@ -598,7 +598,7 @@ to I<Amount> in the GIMP's unsharp mask filter.  Default: 1.0.
 
 =back
 
 
 =back
 
-=item watermark
+=item C<watermark>
 
 applies C<wmark> as a watermark on the image with strength C<pixdiff>,
 with an origin at (C<tx>, C<ty>)
 
 applies C<wmark> as a watermark on the image with strength C<pixdiff>,
 with an origin at (C<tx>, C<ty>)