doc polishing

This commit is contained in:
John Cupitt 2015-02-18 16:02:19 +00:00
parent fbed552f71
commit 9ec78d362a
2 changed files with 30 additions and 10 deletions

View File

@ -21,7 +21,8 @@
VIPS has a simple, native file format. It's very fast, there is no image VIPS has a simple, native file format. It's very fast, there is no image
size limit, and it supports size limit, and it supports
arbitrary metadata. Although few other programs can read these images arbitrary metadata. Although few other programs can read these images
(though recent versions of ImageMagick do support <code>.vips</code> (though recent versions of ImageMagick do have basic support for
<code>.vips</code>
format), it can be useful as an intermediate format for command-line format), it can be useful as an intermediate format for command-line
processing. For example: processing. For example:
@ -47,7 +48,7 @@ $ vips gamma t.v output.tif
such as image width in pixels. Next, the image data is stored as a set such as image width in pixels. Next, the image data is stored as a set
of band-interleaved scanlines, from the top of the image to the bottom. of band-interleaved scanlines, from the top of the image to the bottom.
Finally, after the pixel data comes an optional block of XML containing Finally, after the pixel data comes an optional block of XML containing
any extra metadata, such as ICC profiles. any extra metadata, such as an ICC profile or the EXIF data.
</para> </para>
</refsect1> </refsect1>
@ -58,6 +59,16 @@ $ vips gamma t.v output.tif
first (Intel ordering). Only the most basic information about the image first (Intel ordering). Only the most basic information about the image
is in the header: most metadata is stored in the XML extension block is in the header: most metadata is stored in the XML extension block
after the pixel data. after the pixel data.
</para>
<para>
If the first four bytes of the file are in order 08 f2 a6 b6, the image
data (see the next section)
is stored in Intel byte order (LSB first) and will need to be swapped
if read on a SPARC-style machine (MSB first).
If the magic number is b6 a6 f2 08, the image data is in SPARC order
and will need to swapped if read on an Intel-style machine. libvips does
this swapping automatically.
<table> <table>
<title>The VIPS header</title> <title>The VIPS header</title>
@ -76,7 +87,7 @@ $ vips gamma t.v output.tif
<entry>0 -- 3</entry> <entry>0 -- 3</entry>
<entry></entry> <entry></entry>
<entry></entry> <entry></entry>
<entry>VIPS magic number, 08 f2 f6 b6</entry> <entry>VIPS magic number: 08 f2 a6 b6, or b6 a6 f2 08</entry>
</row> </row>
<row> <row>
@ -163,6 +174,13 @@ $ vips gamma t.v output.tif
<entry>Vertical offset of origin, in pixels</entry> <entry>Vertical offset of origin, in pixels</entry>
</row> </row>
<row>
<entry>56 -- 63</entry>
<entry></entry>
<entry></entry>
<entry>Unused</entry>
</row>
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
@ -193,8 +211,8 @@ $ vips gamma t.v output.tif
<para> <para>
If <code>coding</code> is set to #VIPS_CODING_RAD, each pixel is If <code>coding</code> is set to #VIPS_CODING_RAD, each pixel is
RGB or XYZ float, with 8 bytes of mantissa RGB or XYZ float, with 8 bits of mantissa
and then 8 bytes of exponent, shared between the three channels. This and then 8 bits of exponent, shared between the three channels. This
coding style is used by the Radiance family of programs (and the HDR coding style is used by the Radiance family of programs (and the HDR
format) commonly used for HDR imaging. format) commonly used for HDR imaging.
</para> </para>
@ -216,10 +234,10 @@ $ vips gamma t.v output.tif
</para> </para>
<para> <para>
You can use <command>vipsheader -f getext x.v</command> to get the You can use <command>vipsheader -f getext some_file.v</command> to get
XML from a VIPS image, and the XML from a VIPS image, and
<command>vipsedit --setext x.v &lt; file.xml</command> to replace the <command>vipsedit --setext some_file.v &lt; file.xml</command> to
XML. replace the XML.
</para> </para>
</refsect1> </refsect1>

View File

@ -31,7 +31,9 @@
When your program starts, use VIPS_INIT() When your program starts, use VIPS_INIT()
to start up the VIPS library. You should pass it the name to start up the VIPS library. You should pass it the name
of your program, usually <code>argv[0]</code>. Use of your program, usually <code>argv[0]</code>. Use
vips_shutdown() when you exit. vips_shutdown() when you exit. VIPS_INIT() is a macro to let it check
that the libvips library you have linked to matches the libvips headers
you included.
</para> </para>
<para> <para>