From 8bf0a05948fa28af9b5ac771b7d2fa35050595df Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Sun, 23 Apr 2017 18:52:05 +0100 Subject: [PATCH] doc polishing --- ChangeLog | 4 ++- configure.ac | 4 +-- doc/Using-vipsthumbnail.md | 2 +- doc/Using-vipsthumbnail.xml | 4 +-- doc/function-list.xml | 60 +++++++++++++++++++++++++++++++++++++ doc/gen-function-list.py | 2 ++ doc/using-C.xml | 6 ++++ doc/using-command-line.xml | 6 ++++ doc/using-cpp.xml | 6 ++++ 9 files changed, 88 insertions(+), 6 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6143df9d..ae223c70 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,6 @@ +23/4/17 started 8.5.5 +- doc polishing + 23/4/17 started 8.5.4 - don't depend on image width when setting n_lines, thanks kleisauke @@ -131,7 +134,6 @@ 18/5/16 started 8.3.2 - more robust vips image reading - more robust tiff read [Matt Richards] ->>>>>>> master 15/4/16 started 8.3.1 - rename vips wrapper script, it was still vips-8.2, thanks Benjamin diff --git a/configure.ac b/configure.ac index 77db0091..2bce35fc 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ # also update the version number in the m4 macros below -AC_INIT([vips], [8.5.4], [vipsip@jiscmail.ac.uk]) +AC_INIT([vips], [8.5.5], [vipsip@jiscmail.ac.uk]) # required for gobject-introspection AC_PREREQ(2.62) @@ -18,7 +18,7 @@ AC_CONFIG_MACRO_DIR([m4]) # user-visible library versioning m4_define([vips_major_version], [8]) m4_define([vips_minor_version], [5]) -m4_define([vips_micro_version], [4]) +m4_define([vips_micro_version], [5]) m4_define([vips_version], [vips_major_version.vips_minor_version.vips_micro_version]) diff --git a/doc/Using-vipsthumbnail.md b/doc/Using-vipsthumbnail.md index 09428ea6..52841f52 100644 --- a/doc/Using-vipsthumbnail.md +++ b/doc/Using-vipsthumbnail.md @@ -20,7 +20,7 @@ with a libvips binding. For example, from PHP you could write: ```php $filename = ...; $image = Vips\Image::thumbnail($filename, 200, ["height" => 200]); -$image.writeToFile("my-thumbnail.jpg"); +$image->writeToFile("my-thumbnail.jpg"); ``` # libvips options diff --git a/doc/Using-vipsthumbnail.xml b/doc/Using-vipsthumbnail.xml index 71d62f62..a195f4ba 100644 --- a/doc/Using-vipsthumbnail.xml +++ b/doc/Using-vipsthumbnail.xml @@ -19,7 +19,7 @@ $filename = ...; $image = Vips\Image::thumbnail($filename, 200, ["height" => 200]); -$image.writeToFile("my-thumbnail.jpg"); +$image->writeToFile("my-thumbnail.jpg"); libvips options @@ -115,7 +115,7 @@ $ vipsthumbnail owl.jpg --smartcrop attention -s 128 Linear light - Shrinking images involves combining many pixels into one. Arithmetic averaging really ought to be in terms of the number of photons, but (for historical reasons) the values stored in image files are usually related to the voltage that should be applied to a CRT electron gun. + Shrinking images involves combining many pixels into one. Arithmetic averaging really ought to be in terms of the number of photons, but (for historical reasons) the values stored in image files are usually related to the voltage that should be applied to the electron gun in a CRT display. vipsthumbnail has an option to perform image shrinking in linear space, that is, a colourspace where values are proportional to photon numbers. For example: diff --git a/doc/function-list.xml b/doc/function-list.xml index 8a1d1864..70557baa 100644 --- a/doc/function-list.xml +++ b/doc/function-list.xml @@ -328,6 +328,11 @@ extract an area from an image vips_extract_area(), vips_crop() + + smartcrop + extract an area from an image + vips_smartcrop() + extract_band extract band from an image @@ -591,6 +596,16 @@ make a fractal surface vips_fractsurf() + + worley + make a worley noise image + vips_worley() + + + perlin + make a perlin noise image + vips_perlin() + radload load a Radiance image from a file @@ -761,6 +776,11 @@ save image to deep zoom format vips_dzsave() + + dzsave_buffer + save image to dz buffer + vips_dzsave_buffer() + pngsave save image to png file @@ -801,6 +821,11 @@ save image to tiff file vips_tiffsave() + + tiffsave_buffer + save image to tiff buffer + vips_tiffsave_buffer() + fitssave save image to fits file @@ -836,6 +861,16 @@ reduce an image vips_reduce() + + thumbnail + generate thumbnail from file + vips_thumbnail() + + + thumbnail_buffer + generate thumbnail from buffer + vips_thumbnail_buffer() + mapim resample an image with an arbitrary warp @@ -971,6 +1006,11 @@ convert an sRGB image to scRGB vips_sRGB2scRGB() + + scRGB2BW + convert scRGB to BW + vips_scRGB2BW() + scRGB2sRGB convert an scRGB image to sRGB @@ -1066,6 +1106,21 @@ convolution operation vips_conv() + + conva + approximate integer convolution + vips_conva() + + + convf + float convolution operation + vips_convf() + + + convi + int convolution operation + vips_convi() + compass convolve with rotating mask @@ -1076,6 +1131,11 @@ seperable convolution operation vips_convsep() + + convasep + approximate separable integer convolution + vips_convasep() + fastcor fast correlation diff --git a/doc/gen-function-list.py b/doc/gen-function-list.py index 3573b62a..5856bd3e 100755 --- a/doc/gen-function-list.py +++ b/doc/gen-function-list.py @@ -11,6 +11,8 @@ # vips_gamma() # +import gi +gi.require_version('Vips', '8.0') from gi.repository import Vips, GObject vips_type_operation = GObject.GType.from_name("VipsOperation") diff --git a/doc/using-C.xml b/doc/using-C.xml index b9315bd1..e6c3e4c4 100644 --- a/doc/using-C.xml +++ b/doc/using-C.xml @@ -155,6 +155,12 @@ operation flags: sequential-unbuffered See #VipsOperation for more information on running operations on images. + + The API docs have a handy table of all vips + operations, if you want to find out how to do something, try + searching that. + + When you are done, you can write the final image to a disc file, to a formatted memory buffer, or to diff --git a/doc/using-command-line.xml b/doc/using-command-line.xml index 828fc256..73c42504 100644 --- a/doc/using-command-line.xml +++ b/doc/using-command-line.xml @@ -71,6 +71,12 @@ VipsOperation (operation), operations VipsForeign will show some of the extra flags supported by the file load/save operations. + + + The API docs have a handy table of all vips + operations, if you want to find out how to do something, try + searching that. + diff --git a/doc/using-cpp.xml b/doc/using-cpp.xml index 9cbe9e15..e739e176 100644 --- a/doc/using-cpp.xml +++ b/doc/using-cpp.xml @@ -219,6 +219,12 @@ VImage VImage::add( VImage right, VOption *options = 0 ); you can write to a memory array, to a formatted image in memory, or to another image. + + + The API docs have a handy table of all vips + operations, if you want to find out how to do something, try + searching that. +