[rt #68815] document i_psamp_bits() and i_gsamp_bits()
authorTony Cook <tony@develop-help.com>
Sat, 12 Nov 2011 03:42:32 +0000 (14:42 +1100)
committerTony Cook <tony@develop-help.com>
Sat, 12 Nov 2011 03:42:32 +0000 (14:42 +1100)
Changes
apidocs.perl
imext.c
lib/Imager/APIRef.pod

diff --git a/Changes b/Changes
index 8ff4573..038f793 100644 (file)
--- a/Changes
+++ b/Changes
@@ -3,6 +3,9 @@ Imager release history.  Older releases can be found in Changes.old
  - document the return value of the filter() method.
    https://rt.cpan.org/Ticket/Display.html?id=72369
 
+ - document i_gsamp_bits() and i_psamp_bits().
+   https://rt.cpan.org/Ticket/Display.html?id=68815
+
  - properly increment the Imager::Matrix2d $VERSION.
 
  - actually include the Imager::Test tests in the dist
index b516472..68bac80 100644 (file)
@@ -187,7 +187,7 @@ close OUT;
 
 
 sub make_func_list {
-  my @funcs = qw(i_img i_color i_fcolor i_fill_t mm_log i_img_color_channels i_img_has_alpha i_img_dim i_DF i_DFc i_DFp i_DFcp);
+  my @funcs = qw(i_img i_color i_fcolor i_fill_t mm_log i_img_color_channels i_img_has_alpha i_img_dim i_DF i_DFc i_DFp i_DFcp i_psamp_bits i_gsamp_bits);
   open FUNCS, "< imexttypes.h"
     or die "Cannot open imexttypes.h: $!\n";
   my $in_struct;
diff --git a/imext.c b/imext.c
index e6f0eee..6afaadd 100644 (file)
--- a/imext.c
+++ b/imext.c
@@ -352,6 +352,42 @@ i_img_dim
   return i_gsampf(im, l, r, y, samp, chans, chan_count);
 }
 
+/*
+=item i_gsamp_bits(im, left, right, y, samples, channels, channel_count, bits)
+=category Drawing
+
+Reads integer samples scaled to C<bits> bits of precision into the
+C<unsigned int> array C<samples>.
+
+Expect this to be slow unless C<< bits == im->bits >>.
+
+Returns the number of samples copied, or -1 on error.
+
+Not all image types implement this method.
+
+Pushes errors, but does not call C<i_clear_error()>.
+
+=cut
+*/
+
+/*
+=item i_psamp_bits(im, left, right, y, samples, channels, channel_count, bits)
+=category Drawing
+
+Writes integer samples scaled to C<bits> bits of precision from the
+C<unsigned int> array C<samples>.
+
+Expect this to be slow unless C<< bits == im->bits >>.
+
+Returns the number of samples copied, or -1 on error.
+
+Not all image types implement this method.
+
+Pushes errors, but does not call C<i_clear_error()>.
+
+=cut
+*/
+
 /*
 =item i_gpal(im, left, right, y, indexes)
 
index afd956d..22c45a3 100644 (file)
@@ -630,6 +630,23 @@ channels.
 =for comment
 From: File paste.im
 
+=item i_gsamp_bits(im, left, right, y, samples, channels, channel_count, bits)
+
+Reads integer samples scaled to C<bits> bits of precision into the
+C<unsigned int> array C<samples>.
+
+Expect this to be slow unless C<< bits == im->bits >>.
+
+Returns the number of samples copied, or -1 on error.
+
+Not all image types implement this method.
+
+Pushes errors, but does not call C<i_clear_error()>.
+
+
+=for comment
+From: File imext.c
+
 =item i_gsampf(im, left, right, y, samples, channels, channel_count)
 
 
@@ -753,6 +770,23 @@ Does no alpha blending, just copies the channels from the supplied
 color to the image.
 
 
+=for comment
+From: File imext.c
+
+=item i_psamp_bits(im, left, right, y, samples, channels, channel_count, bits)
+
+Writes integer samples scaled to C<bits> bits of precision from the
+C<unsigned int> array C<samples>.
+
+Expect this to be slow unless C<< bits == im->bits >>.
+
+Returns the number of samples copied, or -1 on error.
+
+Not all image types implement this method.
+
+Pushes errors, but does not call C<i_clear_error()>.
+
+
 =for comment
 From: File imext.c