document polygon() change

[imager.git] / lib / Imager / Files.pod

diff --git a/lib/Imager/Files.pod b/lib/Imager/Files.pod
index 5dc8aa10a152425721347726fed01941f2542184..1b893a1d92a2d4b30d44f1a668e3ac9c87857037 100644 (file)
--- a/lib/Imager/Files.pod
+++ b/lib/Imager/Files.pod
@@ -237,10 +237,8 @@ the image.
 =item *
 
 C<data> - When reading data, C<data> is a scalar containing the image
-file data, when writing, C<data> is a reference to the scalar to save
-the image file data too.  For GIF images you will need C<giflib> 4 or
-higher, and you may need to patch C<giflib> to use this option for
-writing.
+file data, or a reference to such a scalar.  When writing, C<data> is
+a reference to the scalar to save the image file data to.
 
   my $data;
   $image->write(data => \$data, type => 'tiff')
@@ -250,6 +248,10 @@ writing.
   my @images = Imager->read_multi(data => $data)
     or die Imager->errstr;
 
+  # from Imager 0.99
+  my @images = Imager->read_multi(data => \$data)
+    or die Imager->errstr;
+
 =item *
 
 C<callback>, C<readcb>, C<writecb>, C<seekcb>, C<closecb> - Imager
@@ -596,15 +598,16 @@ image when this tag is non-zero.
 
 =head2 JPEG
 
-=for stopwords composited
-
-You can supply a C<jpegquality> parameter (0-100) when writing a JPEG
-file, which defaults to 75%.  If you write an image with an alpha
-channel to a JPEG file then it will be composited against the
-background set by the C<i_background> parameter (or tag).
+You can supply a C<jpegquality> parameter ranging from 0 (worst
+quality) to 100 (best quality) when writing a JPEG file, which
+defaults to 75.
 
   $img->write(file=>'foo.jpg', jpegquality=>90) or die $img->errstr;
 
+If you write an image with an alpha channel to a JPEG file then it
+will be composed against the background set by the C<i_background>
+parameter (or tag), or black if not supplied.
+
 Imager will read a gray scale JPEG as a 1 channel image and a color
 JPEG as a 3 channel image.
 
@@ -1446,7 +1449,7 @@ C<adam7>.
 X<tags, png_srgb_intent>C<png_srgb_intent> - the sRGB rendering intent
 for the image. an integer from 0 to 3, per the PNG specification.  If
 this chunk is found in the PNG file the C<gAMA> and C<cHRM> are
-ignored and the C<png_gamme> and C<png_chroma_...> tags are not set.
+ignored and the C<png_gamma> and C<png_chroma_...> tags are not set.
 Similarly when writing if C<png_srgb_intent> is set the C<gAMA> and
 C<cHRM> chunks are not written.
 
@@ -1489,6 +1492,11 @@ C<i_background> - set from the C<sBKG> when reading an image file.
 
 =back
 
+X<compression>X<png_compression_level>You can control the level of
+F<zlib> compression used when writing with the
+C<png_compression_level> parameter.  This can be an integer between 0
+(uncompressed) and 9 (best compression).
+
 =for stopwords
 CRC
 
@@ -1611,9 +1619,10 @@ control reading of ICO/CUR files:
 
 =item *
 
-ico_masked - if true, the default, then the icon/cursors mask is
-applied as an alpha channel to the image.  This may result in a
-paletted image being returned as a direct color image.  Default: 1
+C<ico_masked> - if true, the default, then the icon/cursors mask is
+applied as an alpha channel to the image, unless that image already
+has an alpha channel.  This may result in a paletted image being
+returned as a direct color image.  Default: 1
 
   # retrieve the image as stored, without using the mask as an alpha
   # channel
@@ -1623,6 +1632,15 @@ paletted image being returned as a direct color image.  Default: 1
 This was introduced in Imager 0.60.  Previously reading ICO images
 acted as if C<ico_masked =E<gt> 0>.
 
+=item *
+
+C<ico_alpha_masked> - if true, then the icon/cursor mask is applied as
+an alpha channel to images that already have an alpha mask.  Note that
+this will only make pixels transparent, not opaque.  Default: 0.
+
+Note: If you get different results between C<ico_alpha_masked> being
+set to 0 and 1, your mask may break when used with the Win32 API.
+
 =back
 
 C<cur_bits> is set when reading a cursor.