improve vips_rawload() docs

This commit is contained in:
John Cupitt 2014-04-04 10:27:39 +01:00
parent 04070445eb
commit 76f1217fab

View File

@ -168,10 +168,12 @@ vips_foreign_load_raw_init( VipsForeignLoadRaw *raw )
* @offset: offset in bytes from start of file
*
* This operation mmaps the file, setting @out so that access to that
* image will read from the file.
* image will read from the file.
*
* Use functions like vips_copy() to set the pixel type, byte ordering
* and so on.
* @out will be a 8-bit uchar image with @bands image bands, so @bands can
* be thought of as meaning "number of bytes per pixel". Use functions
* like vips_copy() to set the exact band format, number of bands, byte
* ordering and so on.
*
* See also: vips_image_new_from_file().
*