sergiotarxz/libvips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc polishing

Browse Source
This commit is contained in:
John Cupitt 2017-04-23 18:52:05 +01:00
parent a067dc4140
commit 8bf0a05948
9 changed files with 88 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -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

4
configure.ac
View File

@ -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])

2
doc/Using-vipsthumbnail.md
View File

@ -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

4
doc/Using-vipsthumbnail.xml
View File

@ -19,7 +19,7 @@
<programlisting language="php">
$filename = ...;
$image = Vips\Image::thumbnail($filename, 200, [&quot;height&quot; =&gt; 200]);
$image.writeToFile(&quot;my-thumbnail.jpg&quot;);
$image-&gt;writeToFile(&quot;my-thumbnail.jpg&quot;);
</programlisting>
<refsect3 id="libvips-options">
<title>libvips options</title>
@ -115,7 +115,7 @@ $ vipsthumbnail owl.jpg --smartcrop attention -s 128
<refsect3 id="linear-light">
<title>Linear light</title>
<para>
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.
</para>
<para>
<literal>vipsthumbnail</literal> has an option to perform image shrinking in linear space, that is, a colourspace where values are proportional to photon numbers. For example:

60
doc/function-list.xml
View File

@ -328,6 +328,11 @@
<entry>extract an area from an image</entry>
<entry>vips_extract_area(), vips_crop()</entry>
</row>
<row>
<entry>smartcrop</entry>
<entry>extract an area from an image</entry>
<entry>vips_smartcrop()</entry>
</row>
<row>
<entry>extract_band</entry>
<entry>extract band from an image</entry>
@ -591,6 +596,16 @@
<entry>make a fractal surface</entry>
<entry>vips_fractsurf()</entry>
</row>
<row>
<entry>worley</entry>
<entry>make a worley noise image</entry>
<entry>vips_worley()</entry>
</row>
<row>
<entry>perlin</entry>
<entry>make a perlin noise image</entry>
<entry>vips_perlin()</entry>
</row>
<row>
<entry>radload</entry>
<entry>load a Radiance image from a file</entry>
@ -761,6 +776,11 @@
<entry>save image to deep zoom format</entry>
<entry>vips_dzsave()</entry>
</row>
<row>
<entry>dzsave_buffer</entry>
<entry>save image to dz buffer</entry>
<entry>vips_dzsave_buffer()</entry>
</row>
<row>
<entry>pngsave</entry>
<entry>save image to png file</entry>
@ -801,6 +821,11 @@
<entry>save image to tiff file</entry>
<entry>vips_tiffsave()</entry>
</row>
<row>
<entry>tiffsave_buffer</entry>
<entry>save image to tiff buffer</entry>
<entry>vips_tiffsave_buffer()</entry>
</row>
<row>
<entry>fitssave</entry>
<entry>save image to fits file</entry>
@ -836,6 +861,16 @@
<entry>reduce an image</entry>
<entry>vips_reduce()</entry>
</row>
<row>
<entry>thumbnail</entry>
<entry>generate thumbnail from file</entry>
<entry>vips_thumbnail()</entry>
</row>
<row>
<entry>thumbnail_buffer</entry>
<entry>generate thumbnail from buffer</entry>
<entry>vips_thumbnail_buffer()</entry>
</row>
<row>
<entry>mapim</entry>
<entry>resample an image with an arbitrary warp</entry>
@ -971,6 +1006,11 @@
<entry>convert an sRGB image to scRGB</entry>
<entry>vips_sRGB2scRGB()</entry>
</row>
<row>
<entry>scRGB2BW</entry>
<entry>convert scRGB to BW</entry>
<entry>vips_scRGB2BW()</entry>
</row>
<row>
<entry>scRGB2sRGB</entry>
<entry>convert an scRGB image to sRGB</entry>
@ -1066,6 +1106,21 @@
<entry>convolution operation</entry>
<entry>vips_conv()</entry>
</row>
<row>
<entry>conva</entry>
<entry>approximate integer convolution</entry>
<entry>vips_conva()</entry>
</row>
<row>
<entry>convf</entry>
<entry>float convolution operation</entry>
<entry>vips_convf()</entry>
</row>
<row>
<entry>convi</entry>
<entry>int convolution operation</entry>
<entry>vips_convi()</entry>
</row>
<row>
<entry>compass</entry>
<entry>convolve with rotating mask</entry>
@ -1076,6 +1131,11 @@
<entry>seperable convolution operation</entry>
<entry>vips_convsep()</entry>
</row>
<row>
<entry>convasep</entry>
<entry>approximate separable integer convolution</entry>
<entry>vips_convasep()</entry>
</row>
<row>
<entry>fastcor</entry>
<entry>fast correlation</entry>

2
doc/gen-function-list.py
View File

@ -11,6 +11,8 @@
# <entry>vips_gamma()</entry>
# </row>
import gi
gi.require_version('Vips', '8.0')
from gi.repository import Vips, GObject
vips_type_operation = GObject.GType.from_name("VipsOperation")

6
doc/using-C.xml
View File

@ -155,6 +155,12 @@ operation flags: sequential-unbuffered
See #VipsOperation for more information on running operations on images.
</para>
<para>
The API docs have a <link linkend="function-list">handy table of all vips
operations</link>, if you want to find out how to do something, try
searching that.
</para>
<para>
When you are done, you can write
the final image to a disc file, to a formatted memory buffer, or to

6
doc/using-command-line.xml
View File

@ -71,6 +71,12 @@ VipsOperation (operation), operations
<literal>VipsForeign</literal> will show some of the extra flags
supported by the file load/save operations.
</para>
<para>
The API docs have a <link linkend="function-list">handy table of all vips
operations</link>, if you want to find out how to do something, try
searching that.
</para>
</refsect3>
<refsect3 id="using-command-line-options">

6
doc/using-cpp.xml
View File

@ -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.
</para>
<para>
The API docs have a <link linkend="function-list">handy table of all vips
operations</link>, if you want to find out how to do something, try
searching that.
</para>
</refsect3>
<refsect3 id="cpp-expansion">