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

update dzsave docs

Browse Source
This commit is contained in:
John Cupitt 2014-05-06 14:38:24 +01:00
parent 249c87906a
commit 5478a9bb81
2 changed files with 4 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
TODO
View File

@ -1,7 +1,3 @@
- sort out dzsave docs ... note auto-zip and new path system
- try

22
libvips/foreign/dzsave.c
View File

@ -1780,21 +1780,14 @@ vips_foreign_save_dz_init( VipsForeignSaveDz *dz )
* @depth: how deep to make the pyramid
* @centre: centre the tiles
* @angle: rotate the image by this much
* @container: container format
* @container: set container type
*
* Save an image as a set of tiles at various resolutions. By default dzsave
* uses DeepZoom layout -- use @layout to pick other conventions.
*
* @name is split into three parts: $(dirname) (everything before the
* last '/'), $(basename) (everything after the last '/') and $(rootname)
* ($(basename) minus any extensions).
*
* In DeepZoom layout a directory in $(dirname) called
* "$(basename)_files" is created to hold the tiles, and an XML file called
* "$(basename).dzi" is written with the image metadata,
*
* In Zoomify and Google layout, a directory called @name is created to
* hold the tile structure.
* vips_dzsave() creates a directory called @name to hold the tiles. If @name
* ends ".zip", vips_dzsave() will create a zip file called @name to hold the
* tiles. You can use @container to force zip file output.
*
* You can set @suffix to something like ".jpg[Q=85]" to control the tile write
* options.
@ -1810,13 +1803,6 @@ vips_foreign_save_dz_init( VipsForeignSaveDz *dz )
* Use @depth to control how low the pyramid goes. This defaults to the
* correct setting for the @layout you select.
*
* Use @container to set where to write the zoom structure. By default it
* writes to the filesystem, but set this to #VIPS_FOREIGN_DZ_CONTAINER_ZIP
* and dzsave will create a zip file called @name to hold the pyramid.
*
* Using #VIPS_FOREIGN_DZ_CONTAINER_ZIP can save a separate zip stage,
* which will be very slow on some platforms.
*
* See also: vips_tiffsave().
*
* Returns: 0 on success, -1 on error.