define 0.61 release goals

updated APIRef docs

diff --git a/META.yml b/META.yml
index a4a86e55830a9217f11ed5e2099ccbe1ea5d2f31..f5df1e98703edc296a748b2146c4781a6e5cf1d8 100644 (file)
--- a/META.yml
+++ b/META.yml
@@ -1,6 +1,6 @@
 --- #YAML:1.0
 name: Imager
-version: 0.59
+version: 0.60
 version_from: Imager.pm
 author: Tony Cook <tony@imager.perl.org>, Arnar M. Hrafnkelsson
 abstract: Perl extension for Generating 24 bit Images
@@ -15,4 +15,4 @@ distribution_type: module
 meta-spec:
   version: 1.3
   url: http://module-build.sourceforge.net/META-spec-v1.3.html
-generated_by: Imager version 0.59
+generated_by: Imager version 0.60

diff --git a/TODO b/TODO
index 4aa094857f90bfa7c997cc7e3f35cb1d8732c7a3..e855c9e75e64912ab57138aa1e644813811df208 100644 (file)
--- a/TODO
+++ b/TODO
@@ -6,6 +6,22 @@ Release Plans (subject to change)
 brown-bag bugs may add intermediate releases.  The dates are goals,
 not commitments.
 
+For 0.61:
+
+TIFF improvements (to be detailed) (#20329)
+
+regmach.c fixes/tests (#29296)
+
+sample: scaling an animated gif (#27591)
+
+transform2() docs (#29267)
+
+read DIBS (#29055)
+
+library search path on 64-bit centos (#29045)
+
+i_gsamp() chan_count validation (#28985)
+
 For 0.60 (hopefully):
 
 RGB file support (#8666) (done)

diff --git a/apidocs.perl b/apidocs.perl
index 3559870d794c62b2ff7ed4154d0d66ad4fad29e5..2d36e311de9a37c85b0995258e747b362525872e 100644 (file)
--- a/apidocs.perl
+++ b/apidocs.perl
@@ -85,7 +85,6 @@ Imager::APIRef - Imager's C API.
 
   i_color color;
   color.rgba.red = 255; color.rgba.green = 0; color.rgba.blue = 255;
-  i_fill_t *fill = i_new_fill_...(...);
 
 EOS
 
@@ -100,8 +99,6 @@ for my $cat (sort { lc $a cmp lc $b } keys %cats) {
 
 print OUT <<'EOS';
 
-   i_fill_destroy(fill);
-
 =head1 DESCRIPTION
 
 EOS

diff --git a/fills.c b/fills.c
index 6e929199dac9d1247173a6c5dd6d24c13a33aa1c..251d6b739dd69e961973a7ad0f6e0ea0145a2f89 100644 (file)
--- a/fills.c
+++ b/fills.c
@@ -196,6 +196,7 @@ static i_fill_solid_t base_solid_fill_comb =
 =item i_fill_destroy(fill)
 
 =category Fills
+=synopsis i_fill_destroy(fill);
 
 Call to destroy any fill object.
 
@@ -213,6 +214,7 @@ i_fill_destroy(i_fill_t *fill) {
 =item i_new_fill_solidf(color, combine)
 
 =category Fills
+=synopsis i_fill_t *fill = i_new_fill_solidf(&fcolor, combine);
 
 Create a solid fill based on a float color.
 
@@ -244,6 +246,7 @@ i_new_fill_solidf(const i_fcolor *c, int combine) {
 =item i_new_fill_solid(color, combine)
 
 =category Fills
+=synopsis i_fill_t *fill = i_new_fill_solid(&color, combine);
 
 Create a solid fill based on an 8-bit color.
 
@@ -427,6 +430,7 @@ i_new_hatch_low(const i_color *fg, const i_color *bg, const i_fcolor *ffg, const
 =item i_new_fill_hatch(fg, bg, combine, hatch, cust_hatch, dx, dy)
 
 =category Fills
+=synopsis i_fill_t *fill = i_new_fill_hatch(&fg_color, &bg_color, combine, hatch, custom_hatch, dx, dy);
 
 Creates a new hatched fill with the fg color used for the 1 bits in
 the hatch and bg for the 0 bits.  If combine is non-zero alpha values
@@ -452,6 +456,7 @@ i_new_fill_hatch(const i_color *fg, const i_color *bg, int combine, int hatch,
 =item i_new_fill_hatchf(fg, bg, combine, hatch, cust_hatch, dx, dy)
 
 =category Fills
+=synopsis i_fill_t *fill = i_new_fill_hatchf(&fg_fcolor, &bg_fcolor, combine, hatch, custom_hatch, dx, dy);
 
 Creates a new hatched fill with the fg color used for the 1 bits in
 the hatch and bg for the 0 bits.  If combine is non-zero alpha values
@@ -489,6 +494,7 @@ struct i_fill_image_t {
 =item i_new_fill_image(im, matrix, xoff, yoff, combine)
 
 =category Fills
+=synopsis i_fill_t *fill = i_new_fill_image(src_img, matrix, x_offset, y_offset, combine);
 
 Create an image based fill.
 

diff --git a/image.c b/image.c
index 846126c0d6d8187cb10b45c40dfcc8cd83a9071e..76cdaf9b854aa2578c6627bbe9fc26f167e0f489 100644 (file)
--- a/image.c
+++ b/image.c
@@ -256,7 +256,9 @@ static i_img IIM_base_8bit_direct =
 
 =item i_img_8_new(x, y, ch)
 
-=category Image creation
+=category Image creation/destruction
+
+=synopsis i_img *img = i_img_8_new(width, height, channels);
 
 Creates a new image object I<x> pixels wide, and I<y> pixels high with
 I<ch> channels.
@@ -421,13 +423,12 @@ i_img_exorcise(i_img *im) {
 }
 
 /* 
-=item i_img_destroy(im)
-
-=category Image
+=item i_img_destroy(img)
 
-Destroy image and free data via exorcise.
+=category Image creation/destruction
+=synopsis i_img_destroy(img)
 
-   im - Image pointer
+Destroy an image object
 
 =cut
 */
@@ -1041,7 +1042,8 @@ i_scale_nn(i_img *im, float scx, float scy) {
 /*
 =item i_sametype(i_img *im, int xsize, int ysize)
 
-=category Image creation
+=category Image creation/destruction
+=synopsis i_img *img = i_sametype(src, width, height);
 
 Returns an image of the same type (sample size, channels, paletted/direct).
 
@@ -1083,7 +1085,8 @@ i_img *i_sametype(i_img *src, int xsize, int ysize) {
 /*
 =item i_sametype_chans(i_img *im, int xsize, int ysize, int channels)
 
-=category Image creation
+=category Image creation/destruction
+=synopsis i_img *img = i_sametype_chans(src, width, height, channels);
 
 Returns an image of the same type (sample size).
 

diff --git a/img16.c b/img16.c
index e486c012f53d891c006e0a851545acc8f364bbbc..4be3416ce890fd1c6ea58fe5d06b2629e2f0fc58 100644 (file)
--- a/img16.c
+++ b/img16.c
@@ -191,7 +191,8 @@ i_img *i_img_16_new_low(i_img *im, int x, int y, int ch) {
 /*
 =item i_img_16_new(x, y, ch)
 
-=category Image creation
+=category Image creation/destruction
+=synopsis i_img *img = i_img_16_new(width, height, channels);
 
 Create a new 16-bit/sample image.
 

diff --git a/imgdouble.c b/imgdouble.c
index 8cc7b391bb2597583ecc6ce05ebe8a05d8d62a54..435fac7f7daea19a3660b3e60f5b84cf013b3ccd 100644 (file)
--- a/imgdouble.c
+++ b/imgdouble.c
@@ -81,7 +81,8 @@ static i_img IIM_base_double_direct =
 /*
 =item i_img_double_new(int x, int y, int ch)
 
-=category Image creation
+=category Image creation/destruction
+=synopsis i_img *img = i_img_double_new(width, height, channels);
 
 Creates a new double per sample image.
 

diff --git a/lib/Imager/APIRef.pod b/lib/Imager/APIRef.pod
index eaa74737c170faef91262a35afdf7f5142aa5f05..a78691479928648b58e1b01c7d9b1f4d96fe2612 100644 (file)
--- a/lib/Imager/APIRef.pod
+++ b/lib/Imager/APIRef.pod
@@ -12,7 +12,6 @@ Imager::APIRef - Imager's C API.
 
   i_color color;
   color.rgba.red = 255; color.rgba.green = 0; color.rgba.blue = 255;
-  i_fill_t *fill = i_new_fill_...(...);
 
 
   # Drawing
@@ -37,12 +36,25 @@ Imager::APIRef - Imager's C API.
   i_set_image_file_limits(500, 500, 1000000);
 
   # Fills
+  i_fill_destroy(fill);
   fill = i_new_fill_fount(0, 0, 100, 100, i_ft_linear, i_ft_linear, 
                           i_fr_triangle, 0, i_fts_grid, 9, 1, segs);
+  i_fill_t *fill = i_new_fill_hatch(&fg_color, &bg_color, combine, hatch, custom_hatch, dx, dy);
+  i_fill_t *fill = i_new_fill_hatchf(&fg_fcolor, &bg_fcolor, combine, hatch, custom_hatch, dx, dy);
+  i_fill_t *fill = i_new_fill_image(src_img, matrix, x_offset, y_offset, combine);
+  i_fill_t *fill = i_new_fill_solid(&color, combine);
+  i_fill_t *fill = i_new_fill_solidf(&fcolor, combine);
 
   # Image
 
-  # Image creation
+  # Image creation/destruction
+  i_img *img = i_img_16_new(width, height, channels);
+  i_img *img = i_img_8_new(width, height, channels);
+  i_img_destroy(img)
+  i_img *img = i_img_double_new(width, height, channels);
+  i_img *img = i_img_pal_new(width, height, channels, max_palette_size)
+  i_img *img = i_sametype(src, width, height);
+  i_img *img = i_sametype_chans(src, width, height, channels);
 
   # Image quantization
 
@@ -50,8 +62,6 @@ Imager::APIRef - Imager's C API.
 
   # Tags
 
-   i_fill_destroy(fill);
-
 =head1 DESCRIPTION
 
 =head2 Drawing
@@ -609,17 +619,6 @@ From: File image.c
 pass NULL in trans for non transparent i_colors.
 
 
-=for comment
-From: File image.c
-
-=item i_img_destroy(im)
-
-
-Destroy image and free data via exorcise.
-
-   im - Image pointer
-
-
 =for comment
 From: File image.c
 
@@ -660,7 +659,7 @@ From: File rubthru.im
 
 =back
 
-=head2 Image creation
+=head2 Image creation/destruction
 
 =over
 
@@ -678,10 +677,20 @@ From: File img16.c
 =item i_img_8_new(x, y, ch)
 
 
+
 Creates a new image object I<x> pixels wide, and I<y> pixels high with
 I<ch> channels.
 
 
+=for comment
+From: File image.c
+
+=item i_img_destroy(img)
+
+
+Destroy an image object
+
+
 =for comment
 From: File image.c
 
@@ -699,6 +708,8 @@ From: File imgdouble.c
 
 Creates a new paletted image of the supplied dimensions.
 
+I<maxpal> is the maximum palette size and should normally be 256.
+
 Returns a new image or NULL on failure.
 
 

diff --git a/palimg.c b/palimg.c
index 261325954f2025d5546ff5518c3562a130caee0e..88498333ae7e96d27ea0fd12c65b174cb22fe484 100644 (file)
--- a/palimg.c
+++ b/palimg.c
@@ -135,10 +135,13 @@ i_img *i_img_pal_new_low(i_img *im, int x, int y, int channels, int maxpal) {
 /*
 =item i_img_pal_new(x, y, channels, maxpal)
 
-=category Image creation
+=category Image creation/destruction
+=synopsis i_img *img = i_img_pal_new(width, height, channels, max_palette_size)
 
 Creates a new paletted image of the supplied dimensions.
 
+I<maxpal> is the maximum palette size and should normally be 256.
+
 Returns a new image or NULL on failure.
 
 =cut