Method

VipsImagecache

Declaration [src] 

int
vips_cache (
  VipsImage* in,
  VipsImage** out,
  ...
)

Description [src]

Optional arguments:

  • tile_width: width of tiles in cache
  • tile_height: height of tiles in cache
  • max_tiles: maximum number of tiles to cache

This operation behaves rather like vips_copy() between images in and out, except that it keeps a cache of computed pixels. This cache is made of up to max_tiles tiles (a value of -1 means any number of tiles), and each tile is of size tile_width by tile_height pixels. By default it will cache 250 128 x 128 pixel tiles, enough for two 1920 x 1080 images.

This operation is a thin wrapper over vips_sink_screen(), see the documentation for that operation for details.

It uses a set of background threads to calculate pixels and the various active cache operations coordinate so as not to overwhelm your system. When a request is made for an area of pixels, the operation will block until all of those pixels have been calculated. Pixels are calculated with a set of threads.

See also: vips_tilecache().

This method is not directly available to language bindings.

Parameters

out VipsImage
 

Output image.
 The argument will be set by the function.
 The instance takes ownership of the data, and is responsible for freeing it.
...
 

NULL-terminated list of optional named arguments.

Return value

Returns: int
 

0 on success, -1 on error.