Namespace

Vips – 8.0

The libvips image processing library

Version	8.17
Authors	libvips team and contributors
License	LGPL-2.1-or-later
Website	https://www.libvips.org
Source	https://github.com/libvips/libvips

Build

C headers	`vips/vips.h`
pkg-config files	`vips`

Dependencies

GObject—2.0	The base type system library
	Browse documentation

GObject	The base type system library
	Browse documentation

Additional documentation

Classes

Connection	An abstract base class representing a source or sink of bytes. since: 8.0
Foreign	An abstract base class to load and save images in a variety of formats. since: 8.0
ForeignLoad	An abstract base class to load images in a variety of formats. since: 8.0
ForeignSave	An abstract base class to save images in a variety of formats. since: 8.0
GInputStream	since: 8.0
Image	The `VipsImage` class and associated types and macros. since: 8.0
Interpolate	An abstract base class for the various interpolation functions. since: 8.0
Object	An abstract base class for all objects in libvips. since: 8.0
Operation	An abstract base class for all operations in libvips. since: 8.0
Region	A `VipsRegion` represents a small, rectangular part of an image. since: 8.0
Sbuf	A `VipsSbuf` provides a buffered reading interface for a `VipsSource`. since: 8.0
Source	A `VipsSource` provides a unified interface for reading, seeking, and mapping data, regardless of the underlying source type. since: 8.0
SourceCustom	Subclass of `VipsSource` with action signals for handlers. since: 8.0
SourceGInputStream	since: 8.0
Target	A `VipsTarget` provides a unified interface for writing data to various output destinations. since: 8.0
TargetCustom	Subclass of `VipsTarget` with action signals for handlers. since: 8.0
ThreadState	A `VipsThreadState` represents a per-thread state. since: 8.0

Structs

Area	since: 8.0
Argument	Libvips has a simple mechanism for automating at least some aspects of `GObject` properties. You add a set of macros to your `_class_init()` which describe the arguments, and set the get and set functions to the libvips ones. since: 8.0
ArgumentClass	since: 8.0
ArgumentInstance	since: 8.0
ArrayDouble	since: 8.0
ArrayImage	since: 8.0
ArrayInt	since: 8.0
Blob	since: 8.0
Buf	A message buffer you can append stuff to safely and quickly. If the message gets too long, you get “…” and truncation. Message buffers can be on the stack or heap. since: 8.0
Dbuf	since: 8.0
Progress	A structure available to eval callbacks giving information on evaluation progress. See `VipsImage::eval`. since: 8.0
Rect	A `VipsRect` is a rectangular area of pixels. This is a struct for performing simple rectangle algebra. since: 8.0
RefString	since: 8.0
SaveString	since: 8.0
Semaphore	since: 8.0

Aliases

ArgumentTable

since: 8.0

Pel

A picture element. Cast this to whatever the associated VipsBandFormat says to get the value.

since: 8.0

Enumerations

Access	The type of access an operation has to supply. See `vips_tilecache()` and `VipsForeign`. since: 8.0
Align	See `vips_join()` and so on. since: 8.0
Angle	See `vips_rot()` and so on. since: 8.0
Angle45	See `vips_rot45()` and so on. since: 8.0
BandFormat	The format used for each band element. since: 8.0
BlendMode	The various Porter-Duff and PDF blend modes. See `vips_composite()`, for example. since: 8.0
Coding	How pixels are coded. since: 8.0
Combine	How to combine values. See `vips_compass()`, for example. since: 8.0
CombineMode	See `vips_draw_image()` and so on. since: 8.0
CompassDirection	A direction on a compass. Used for `vips_gravity()`, for example. since: 8.0
DemandStyle	See `vips_image_pipelinev()`. Operations can hint the kind of demand geometry they prefer to the VIPS image IO system. since: 8.0
Direction	See `vips_flip()`, `vips_join()` and so on. since: 8.0
Extend	See `vips_embed()`, `vips_conv()`, `vips_affine()` and so on. since: 8.0
FailOn	How sensitive loaders are to errors, from never stop (very insensitive), to stop on the smallest warning (very sensitive). since: 8.0
ForeignDzContainer	How many pyramid layers to create. since: 8.0
ForeignDzDepth	How many pyramid layers to create. since: 8.0
ForeignDzLayout	What directory layout and metadata standard to use. since: 8.0
ForeignHeifCompression	The compression format to use inside a HEIF container. since: 8.0
ForeignHeifEncoder	The selected encoder to use. If libheif hasn’t been compiled with the selected encoder, we will fallback to the default encoder for the compression format. since: 8.0
ForeignJpegSubsample	since: 8.0
ForeignPpmFormat	The netpbm file format to save as. since: 8.0
ForeignSubsample	Set subsampling mode. since: 8.0
ForeignTiffCompression	The compression types supported by the tiff writer. since: 8.0
ForeignTiffPredictor	The predictor can help deflate and lzw compression. The values are fixed by the tiff library. since: 8.0
ForeignTiffResunit	Use inches or centimeters as the resolution unit for a tiff file. since: 8.0
ForeignWebpPreset	Tune lossy encoder settings for different image types. since: 8.0
ImageType	since: 8.0
Intent	The rendering intent. `VipsIntent` is best for scientific work, `VipsIntent` is usually best for accurate communication with other imaging libraries. since: 8.0
Interesting	Pick the algorithm vips uses to decide image “interestingness”. This is used by `vips_smartcrop()`, for example, to decide what parts of the image to keep. since: 8.0
Interpretation	How the values in an image should be interpreted. For example, a three-band float image of type `VipsInterpretation` should have its pixels interpreted as coordinates in CIE Lab space. since: 8.0
Kernel	The resampling kernels vips supports. See `vips_reduce()`, for example. since: 8.0
OperationBoolean	See also: `vips_boolean()`. since: 8.0
OperationComplex	See also: `vips_complex()`. since: 8.0
OperationComplex2	See also: `vips_complex2()`. since: 8.0
OperationComplexget	See also: `vips_complexget()`. since: 8.0
OperationMath	See also: `vips_math()`. since: 8.0
OperationMath2	See also: `vips_math()`. since: 8.0
OperationMorphology	More like hit-miss, really. since: 8.0
OperationRelational	See also: `vips_relational()`. since: 8.0
OperationRound	See also: `vips_round()`. since: 8.0
PCS	Pick a Profile Connection Space for `vips_icc_import()` and `vips_icc_export()`. LAB is usually best, XYZ can be more convenient in some cases. since: 8.0
Precision	How accurate an operation should be. since: 8.0
RegionShrink	How to calculate the output pixels when shrinking a 2x2 region. since: 8.0
SdfShape	The SDF to generate, since: 8.0
Size	Controls whether an operation should upsize, downsize, both up and downsize, or force a size. since: 8.0
TextWrap	Sets the word wrapping style for `vips_text()` when used with a maximum width. since: 8.0

Bitfields

ArgumentFlags	Flags we associate with each object argument. since: 8.0
ForeignCoding	The set of coding types supported by a saver. since: 8.0
ForeignFlags	Some hints about the image loader. since: 8.0
ForeignKeep	Which metadata to retain. since: 8.0
ForeignPngFilter	The values mirror those of png.h in libpng. since: 8.0
ForeignSaveable	The set of image types supported by a saver. since: 8.0
OperationFlags	Flags we associate with an operation. since: 8.0

Callbacks

ArgumentClassMapFn	since: 8.0
ArgumentMapFn	since: 8.0
CallbackFn	since: 8.0
ClassMapFn	since: 8.0
GenerateFn	Fill `out`->valid with pixels. `seq` contains per-thread state, such as the input regions. Set `stop` to `TRUE` to stop processing. since: 8.0
ImageMapFn	since: 8.0
InterpolateMethod	An interpolation function. It should read source pixels from `in` with `VIPS_REGION_ADDR()`, it can look left and up from (x, y) by `window_offset` pixels and it can access pixels in a window of size `window_size`. since: 8.0
ObjectSetArguments	since: 8.0
OperationBuildFn	since: 8.0
RegionWrite	The function should write the pixels in `area` from `region`. `a` is the value passed into `vips_sink_disc()`. since: 8.0
SinkNotify	since: 8.0
SListFold2Fn	since: 8.0
SListMap2Fn	since: 8.0
SListMap4Fn	since: 8.0
StartFn	Start a new processing sequence for this generate function. This allocates per-thread state, such as an input region. since: 8.0
StopFn	Stop a processing sequence. This frees per-thread state, such as an input region. since: 8.0
ThreadpoolAllocateFn	This function is called to allocate a new work unit for the thread. It is always single-threaded, so it can modify per-pool state (such as a counter). since: 8.0
ThreadpoolProgressFn	This function is called by the main thread once for every work unit processed. It can be used to give the user progress feedback. since: 8.0
ThreadpoolWorkFn	This function is called to process a work unit. Many copies of this can run at once, so it should not write to the per-pool state. It can write to per-thread state. since: 8.0
ThreadStartFn	since: 8.0
TypeMap2Fn	since: 8.0
TypeMapFn	since: 8.0

Functions

add_option_entries	Add the standard vips `GOptionEntry` to a `GOptionGroup`. since: 8.0
allocate_input_array	Convenience function — make a `NULL`-terminated array of input images. Use with `vips_start_many()`. since: 8.0
amiMSBfirst	since: 8.0
block_untrusted_set	Set the block state on all untrusted operations. since: 8.0
break_token	since: 8.0
cache_drop_all	Drop the whole operation cache, handy for leak tracking. Also called automatically on `vips_shutdown()`. since: 8.0
cache_get_max	Get the maximum number of operations we keep in cache. since: 8.0
cache_get_max_files	Get the maximum number of tracked files we allow before we start dropping cached operations. See `vips_tracked_get_files()`. since: 8.0
cache_get_max_mem	Get the maximum amount of tracked memory we allow before we start dropping cached operations. See `vips_tracked_get_mem()`. since: 8.0
cache_get_size	Get the current number of operations in cache. since: 8.0
cache_operation_build	A binding-friendly version of `vips_cache_operation_buildp()`. since: 8.0
cache_operation_buildp	Look up `operation` in the cache. If we get a hit, unref `operation`, ref the old one and return that through the argument pointer. since: 8.0
cache_print	Print the whole operation cache to stdout. Handy for debugging. since: 8.0
cache_set_dump	Handy for debugging. Print the operation cache to stdout just before exit. since: 8.0
cache_set_max	Set the maximum number of operations we keep in cache. since: 8.0
cache_set_max_files	Set the maximum number of tracked files we allow before we start dropping cached operations. See `vips_tracked_get_files()`. since: 8.0
cache_set_max_mem	Set the maximum amount of tracked memory we allow before we start dropping cached operations. See `vips_tracked_get_mem()`. since: 8.0
cache_set_trace	Handy for debugging. Print operation cache actions to stdout as we run. since: 8.0
call	`vips_call()` calls the named operation, passing in required arguments and then setting any optional ones from the remainder of the arguments as a set of name/value pairs. since: 8.0
call_argv	since: 8.0
call_options	since: 8.0
call_required_optional	This is the main entry point for the C and C++ varargs APIs. `operation` is executed, supplying `required` and `optional` arguments. since: 8.0
call_split	since: 8.0
call_split_option_string	since: 8.0
check_8or16	Check that the image is 8 or 16-bit integer, signed or unsigned. Otherwise set an error message and return non-zero. since: 8.0
check_bandno	`bandno` should be a valid band number (ie. 0 to im->Bands - 1), or can be -1, meaning all bands. If not, set an error message and return non-zero. since: 8.0
check_bands	Check that the image has `bands` bands. Otherwise set an error message and return non-zero. since: 8.0
check_bands_1or3	Check that the image has either one or three bands. Otherwise set an error message and return non-zero. since: 8.0
check_bands_1orn	Check that the images have the same number of bands, or that one of the images has just 1 band. If not, set an error message and return non-zero. since: 8.0
check_bands_1orn_unary	Check that an image has 1 or `n` bands. Handy for unary operations, cf. `vips_check_bands_1orn()`. If not, set an error message and return non-zero. since: 8.0
check_bands_atleast	Check that the image has at least `bands` bands. Otherwise set an error message and return non-zero. since: 8.0
check_bands_same	Check that the images have the same number of bands. If not, set an error message and return non-zero. since: 8.0
check_coding	Check that the image has the required `coding`. If not, set an error message and return non-zero. since: 8.0
check_coding_known	Check that the image is uncoded, LABQ coded or RAD coded. If not, set an error message and return non-zero. since: 8.0
check_coding_noneorlabq	Check that the image is uncoded or LABQ coded. If not, set an error message and return non-zero. since: 8.0
check_coding_same	Check that the images have the same coding. If not, set an error message and return non-zero. since: 8.0
check_complex	Check that the image is complex. Otherwise set an error message and return non-zero. since: 8.0
check_format	Check that the image has the specified format. Otherwise set an error message and return non-zero. since: 8.0
check_format_same	Check that the images have the same format. If not, set an error message and return non-zero. since: 8.0
check_hist	Histogram images must have width or height 1, and must not have more than 65536 elements. Return 0 if the image will pass as a histogram, or -1 and set an error message otherwise. since: 8.0
check_int	Check that the image is in one of the integer formats. Otherwise set an error message and return non-zero. since: 8.0
check_matrix	Matrix images must have width and height less than 100000 and have 1 band. since: 8.0
check_mono	Check that the image has exactly one band. Otherwise set an error message and return non-zero. since: 8.0
check_noncomplex	Check that the image is not complex. Otherwise set an error message and return non-zero. since: 8.0
check_oddsquare	Check that the image is square and that the sides are odd. If not, set an error message and return non-zero. since: 8.0
check_precision_intfloat	Check that `prec` image is either float or int. If not, set an error message and return non-zero. since: 8.0
check_separable	Separable matrix images must have width or height 1. Return 0 if the image will pass, or -1 and set an error message otherwise. since: 8.0
check_size_same	Check that the images have the same size. If not, set an error message and return non-zero. since: 8.0
check_twocomponents	Check that the image is has two “components”, ie. is a one-band complex or a two-band non-complex. Otherwise set an error message and return non-zero. since: 8.0
check_u8or16	Check that the image is 8 or 16-bit unsigned integer. Otherwise set an error message and return non-zero. since: 8.0
check_u8or16orf	Check that the image is 8 or 16-bit unsigned integer, or float. Otherwise set an error message and return non-zero. since: 8.0
check_uint	Check that the image is in one of the unsigned integer formats. Otherwise set an error message and return non-zero. since: 8.0
check_uintorf	Check that the image is unsigned int or float. Otherwise set an error message and return non-zero. since: 8.0
check_uncoded	Check that the image is not coded. If not, set an error message and return non-zero. since: 8.0
check_vector	Operations with a vector constant need a 1-element vector, or a vector with the same number of elements as there are bands in the image, or a 1-band image and a many-element vector. since: 8.0
check_vector_length	Check that `n` == `len`. since: 8.0
class_find	Search below `basename`, return the first class whose name or `nickname` matches. since: 8.0
class_map_all	Loop over all the subclasses of `type`. Non-abstract classes only. Stop when `fn` returns non-`NULL` and return that value. since: 8.0
col_ab2Ch	since: 8.0
col_ab2h	since: 8.0
col_C2Ccmc	Calculate Ccmc from C. since: 8.0
col_Ccmc2C	Calculate C from Ccmc using a table. Call `vips_col_make_tables_CMC()` at least once before using this function. since: 8.0
col_Ch2ab	Calculate ab from Ch, h in degrees. since: 8.0
col_Ch2hcmc	Calculate hcmc from C and h. since: 8.0
col_Chcmc2h	Calculate h from C and hcmc, using a table. Call `vips_col_make_tables_CMC()` at least once before using this function. since: 8.0
col_dE00	CIEDE2000, from: since: 8.0
col_L2Lcmc	Calculate Lcmc from L. since: 8.0
col_Lab2XYZ	Calculate XYZ from Lab, D65. since: 8.0
col_Lcmc2L	Calculate L from Lcmc using a table. Call `vips_col_make_tables_CMC()` at least once before using this function. since: 8.0
col_make_tables_CMC	Make the lookup tables for cmc. since: 8.0
col_scRGB2BW_16	since: 8.0
col_scRGB2BW_8	since: 8.0
col_scRGB2sRGB_16	since: 8.0
col_scRGB2sRGB_8	since: 8.0
col_scRGB2XYZ	Turn scRGB into XYZ. since: 8.0
col_sRGB2scRGB_16	since: 8.0
col_sRGB2scRGB_16_noclip	since: 8.0
col_sRGB2scRGB_8	since: 8.0
col_sRGB2scRGB_8_noclip	since: 8.0
col_XYZ2Lab	Calculate XYZ from Lab, D65. since: 8.0
col_XYZ2scRGB	Turn XYZ into scRGB. since: 8.0
concurrency_get	Returns the number of worker threads that vips should use when running `vips_threadpool_run()`. since: 8.0
concurrency_set	Sets the number of worker threads that vips should use when running `vips_threadpool_run()`. since: 8.0
enum_from_nick	since: 8.0
enum_nick	since: 8.0
enum_string	since: 8.0
error	Format the string in the style of `printf()` and append to the error buffer. since: 8.0
error_buffer	Get a pointer to the start of the error buffer as a C string. The string is owned by the error system and must not be freed. since: 8.0
error_buffer_copy	Return a copy of the vips error buffer, and clear it. since: 8.0
error_clear	Clear and reset the error buffer. This is typically called after presenting an error to the user. since: 8.0
error_exit	Sends a formatted error message to stderr, then sends the contents of the error buffer, if any, then shuts down vips and terminates the program with an error code. since: 8.0
error_freeze	Stop errors being logged. Use `vips_error_thaw()` to unfreeze. You can nest freeze/thaw pairs. since: 8.0
error_g	This function sets the glib error pointer from the vips error buffer and clears it. It’s handy for returning errors to glib functions from vips. since: 8.0
error_system	Format the string in the style of `printf()` and append to the error buffer. Then create and append a localised message based on the system error code, usually the value of errno. since: 8.0
error_thaw	Re-enable error logging. since: 8.0
existsf	since: 8.0
file_length	since: 8.0
filename_get_filename	Given a vips filename like “fred.jpg[Q=90]”, return a new string of just the filename part, “fred.jpg” in this case. since: 8.0
filename_get_options	Given a vips filename like “fred.jpg[Q=90]”, return a new string of just the options part, “[Q=90]” in this case. since: 8.0
filename_suffix_match	since: 8.0
flags_from_nick	since: 8.0
foreign_flags	Return the flags for `filename` using `loader`. `loader` is something like “tiffload” or “VipsForeignLoadTiff”. since: 8.0
format_sizeof	since: 8.0
format_sizeof_unsafe	A fast but dangerous version of `vips_format_sizeof()`. You must have previously range-checked `format` or you’ll crash. since: 8.0
g_error	This function adds the `GError` to the vips error buffer and clears it. It’s the opposite of `vips_error_g()`. since: 8.0
g_thread_new	Wrapper for `g_thread_try_new()`. since: 8.0
get_argv0	See also `VIPS_INIT()`. since: 8.0
get_disc_threshold	Return the number of bytes at which we flip between open via memory and open via disc. This defaults to 100mb, but can be changed with the `VIPS_DISC_THRESHOLD` environment variable or the `--vips-disc-threshold` command-line flag. See `vips_image_new_from_file()`. since: 8.0
get_prgname	Return the program name. since: 8.0
guess_libdir	`vips_guess_libdir()` tries to guess the install directory (usually the configure libdir, or $prefix/lib). You should pass in the value of argv[0] (the name your program was run as) as a clue to help it out, plus the name of the environment variable you let the user override your package install area with (eg. “VIPSHOME”). since: 8.0
guess_prefix	`vips_guess_prefix()` tries to guess the install directory. You should pass in the value of argv[0] (the name your program was run as) as a clue to help it out, plus the name of the environment variable you let the user override your package install area with (eg. “VIPSHOME”). since: 8.0
hash_table_map	Like slist map, but for a hash table. since: 8.0
icc_is_compatible_profile	since: 8.0
icc_present	VIPS can optionally be built without the ICC library. Use this function to test for its availability. since: 8.0
init	This function starts up libvips, see `VIPS_INIT()`. since: 8.0
interpolate	Look up the `interpolate` method in the class and call it. Use `vips_interpolate_get_method()` to get a direct pointer to the function and avoid the lookup overhead. since: 8.0
iscasepostfix	since: 8.0
isdirf	since: 8.0
ispoweroftwo	since: 8.0
isprefix	since: 8.0
leak_set	Turn on or off vips leak checking. See also `--vips-leak`, `vips_add_option_entries()` and the `VIPS_LEAK` environment variable. since: 8.0
malloc	`g_malloc()` local to `object`, that is, the memory will be automatically freed for you when the object is closed. If `object` is `NULL`, you need to free the memory explicitly with `g_free()`. since: 8.0
map_equal	since: 8.0
max_coord_get	Return the maximum coordinate value. This can be the default, a value set set by the `--vips-max-coord` CLI arg, or a value set in the `VIPS_MAX_COORD` environment variable. since: 8.0
mkdirf	since: 8.0
nickname_find	Return the VIPS nickname for a `GType`. Handy for language bindings. since: 8.0
pipe_read_limit_set	If a source does not support mmap or seek and the source is used with a loader that can only work from memory, then the data will be automatically read into memory to EOF before the loader starts. This can produce high memory use if the descriptor represents a large object. since: 8.0
profile_set	If set, vips will record profiling information, and dump it on program exit. These profiles can be analysed with the `vipsprofile` program. since: 8.0
pythagoras	Pythagorean distance between two points in colour space. Lab/XYZ/CMC etc. since: 8.0
realpath	since: 8.0
rename	since: 8.0
rmdirf	since: 8.0
shutdown	Call this to drop caches, close plugins, terminate background threads, and finalize any internal library testing. since: 8.0
sink_memory	Loops over `im`, generating it to a memory buffer attached to `im`. It is used by vips to implement writing to a memory buffer. since: 8.0
slist_equal	Test two lists for equality. since: 8.0
slist_filter	Remove all occurrences of an item from a list. Returns the new head of the list. since: 8.0
slist_fold2	Fold over a slist, applying `fn` to each element. since: 8.0
slist_free_all	Free a `GSList` of things which need `g_free()`ing. since: 8.0
slist_map2	Map over a slist. _copy() the list in case the callback changes it. since: 8.0
slist_map2_rev	Map backwards. We _reverse() rather than recurse and unwind to save stack. since: 8.0
slist_map4	Map over a slist. _copy() the list in case the callback changes it. since: 8.0
start_many	Start function for many images in. `a` is a pointer to a `NULL`-terminated array of input images. since: 8.0
start_one	Start function for one image in. Input image is `a`. since: 8.0
stop_many	Stop function for many images in. `a` is a pointer to a `NULL`-terminated array of input images. since: 8.0
stop_one	Stop function for one image in. Input image is `a`. since: 8.0
strdup	`g_strdup()` a string. When `object` is freed, the string will be freed for you. If `object` is `NULL`, you need to free the memory yourself with `g_free()`. since: 8.0
strtod	since: 8.0
thread_execute	A newly created or reused thread will execute `func` with the argument `data`. since: 8.0
thread_isvips	since: 8.0
thread_shutdown	Free any thread-private data and flush any profiling information. since: 8.0
threadpool_run	This function runs a set of threads over an image. Each thread first calls `start` to create new per-thread state, then runs `allocate` to set up a new work unit (perhaps the next tile in an image, for example), then `work` to process that work unit. After each unit is processed, `progress` is called, so that the operation can give progress feedback. `progress` may be `NULL`. since: 8.0
tracked_aligned_alloc	Allocate an area of memory aligned on a boundary specified by `align` that will be tracked by `vips_tracked_get_mem()` and friends. since: 8.0
tracked_aligned_free	Only use it to free memory that was previously allocated with `vips_tracked_aligned_alloc()` with a `NULL` first argument. since: 8.0
tracked_close	Exactly as `close()`, but update the number of files currently open via `vips_tracked_get_files()`. This is used by the vips operation cache to drop cache when the number of files available is low. since: 8.0
tracked_free	Only use it to free memory that was previously allocated with `vips_tracked_malloc()` with a `NULL` first argument. since: 8.0
tracked_get_allocs	Returns the number of active allocations. since: 8.0
tracked_get_files	Returns the number of open files. since: 8.0
tracked_get_mem	Returns the number of bytes currently allocated via `vips_malloc()` and friends. vips uses this figure to decide when to start dropping cache, see `VipsOperation`. since: 8.0
tracked_get_mem_highwater	Returns the largest number of bytes simultaneously allocated via `vips_tracked_malloc()`. Handy for estimating max memory requirements for a program. since: 8.0
tracked_malloc	Allocate an area of memory that will be tracked by `vips_tracked_get_mem()` and friends. since: 8.0
tracked_open	Exactly as `open()`, but the number of files currently open via `vips_tracked_open()` is available via `vips_tracked_get_files()`. This is used by the vips operation cache to drop cache when the number of files available is low. since: 8.0
type_depth	since: 8.0
type_find	Search below `basename`, return the `GType` of the class whose name or `nickname` matches, or 0 for not found. If `basename` is `NULL`, the whole of `VipsObject` is searched. since: 8.0
type_map	Map over a type’s children. Stop when `fn` returns non-`NULL` and return that value. since: 8.0
type_map_all	Map over a type’s children, direct and indirect. Stop when `fn` returns non-`NULL` and return that value. since: 8.0
value_get_area	Get the pointer from an area. Don’t touch count (area is static). since: 8.0
value_get_array	Return the pointer to the array held by `value`. Optionally return the other properties of the array in `n`, `type`, `sizeof_type`. since: 8.0
value_get_array_double	Return the start of the array of doubles held by `value`. optionally return the number of elements in `n`. since: 8.0
value_get_array_image	Return the start of the array of images held by `value`. optionally return the number of elements in `n`. since: 8.0
value_get_array_int	Return the start of the array of ints held by `value`. optionally return the number of elements in `n`. since: 8.0
value_get_array_object	Return the start of the array of `GObject` held by `value`. Optionally return the number of elements in `n`. since: 8.0
value_get_blob	Returns the data pointer from a blob. Optionally returns the length too. since: 8.0
value_get_ref_string	Get the C string held internally by the `GValue`. since: 8.0
value_get_save_string	Get the C string held internally by the GValue. since: 8.0
value_is_null	since: 8.0
value_set_area	Set value to be a ref-counted area of memory with a free function. since: 8.0
value_set_array	Set `value` to be an array of things. since: 8.0
value_set_array_double	Set `value` to hold a copy of `array`. Pass in the array length in `n`. since: 8.0
value_set_array_image	Set `value` to hold an array of images. Pass in the array length in `n`. since: 8.0
value_set_array_int	Set `value` to hold a copy of `array`. Pass in the array length in `n`. since: 8.0
value_set_array_object	Set `value` to hold an array of `GObject`. Pass in the array length in `n`. since: 8.0
value_set_blob	Sets `value` to hold a `data`. When `value` is freed, `data` will be freed with `free_fn`. `value` also holds a note of the size of the memory area. since: 8.0
value_set_blob_free	Just like `vips_value_set_blob()`, but when `value` is freed, `data` will be freed with `g_free()`. since: 8.0
value_set_ref_string	Copies the C string `str` into `value`. since: 8.0
value_set_save_string	Copies the C string into `value`. since: 8.0
value_set_save_stringf	Generates a string and copies it into `value`. since: 8.0
vector_disable_targets	Takes a bitfield of targets to disable on the runtime platform. Handy for testing and benchmarking purposes. since: 8.0
vector_get_builtin_targets	Gets a bitfield of builtin targets that libvips was built with. since: 8.0
vector_get_supported_targets	Gets a bitfield of enabled targets that are supported on this CPU. The targets returned may change after calling `vips_vector_disable_targets()`. since: 8.0
vector_isenabled	since: 8.0
vector_set_enabled	since: 8.0
vector_target_name	Generates a human-readable ASCII string descriptor for a specific target. since: 8.0
verror	Append a message to the error buffer. since: 8.0
verror_system	Format the string in the style of `printf()` and append to the error buffer. Then create and append a localised message based on the system error code, usually the value of errno. since: 8.0
version	Get the major, minor or micro library version, with `flag` values 0, 1 and 2. since: 8.0
version_string	Get the VIPS version as a static string, including a build date and time. Do not free. since: 8.0

Function Macros

ABS	since: 8.0
ALIGNED	since: 8.0
ARG_BOOL	since: 8.0
ARG_BOXED	since: 8.0
ARG_DOUBLE	since: 8.0
ARG_ENUM	since: 8.0
ARG_FLAGS	since: 8.0
ARG_IMAGE	since: 8.0
ARG_INT	since: 8.0
ARG_INTERPOLATE	since: 8.0
ARG_OBJECT	since: 8.0
ARG_POINTER	since: 8.0
ARG_STRING	since: 8.0
ARG_UINT64	since: 8.0
ARGUMENT_COLLECT_SET	since: 8.0
ARGUMENT_FOR_ALL	since: 8.0
ARRAY	Allocate memory for an array of objects of type `T`. The memory is not cleared. since: 8.0
ARRAY_ADDR	since: 8.0
BUF_STATIC	Initialize a heap buffer. For example: since: 8.0
CEIL	since: 8.0
CLIP	since: 8.0
CLIP_CHAR	since: 8.0
CLIP_NONE	since: 8.0
CLIP_SHORT	since: 8.0
CLIP_UCHAR	since: 8.0
CLIP_UINT	since: 8.0
CLIP_USHORT	since: 8.0
COUNT_PIXELS	since: 8.0
DEG	since: 8.0
DEPRECATED_FOR	since: 8.0
DEPRECATED_MACRO_FOR	since: 8.0
FABS	since: 8.0
FCLIP	since: 8.0
FLOOR	since: 8.0
FMAX	since: 8.0
FMIN	since: 8.0
FREE	since: 8.0
FREEF	since: 8.0
GATE_FREE	since: 8.0
GATE_MALLOC	since: 8.0
GATE_START	since: 8.0
GATE_STOP	since: 8.0
IMAGE_ADDR	This macro returns a pointer to a pixel in an image, cast to a `VipsPel` *. It only works for images which are fully available in memory, so memory buffers and small mapped images only. since: 8.0
IMAGE_N_ELEMENTS	since: 8.0
IMAGE_N_PELS	since: 8.0
IMAGE_SIZEOF_ELEMENT	since: 8.0
IMAGE_SIZEOF_IMAGE	since: 8.0
IMAGE_SIZEOF_LINE	since: 8.0
IMAGE_SIZEOF_PEL	since: 8.0
INIT	`VIPS_INIT()` starts up the world of VIPS. You should call this on program startup before using any other VIPS operations. If you do not call `VIPS_INIT()`, VIPS will call it for you when you use your first VIPS operation, but it may not be able to get hold of `ARGV0` and VIPS may therefore be unable to find its data files. It is much better to call this macro yourself. since: 8.0
ISNAN	since: 8.0
MALLOC	since: 8.0
MATRIX	This macro returns a pointer to a pixel in an image, cast to a double*. The image must have a single band, be `VipsBandFormat` and be fully available in memory, so memory buffers and small mapped images only. since: 8.0
MAX	since: 8.0
MIN	since: 8.0
NEW	Allocate memory for a thing of type `T`. The memory is not cleared. since: 8.0
NUMBER	since: 8.0
object_local	since: 8.0
ONCE	since: 8.0
RAD	since: 8.0
RECT_BOTTOM	since: 8.0
RECT_HCENTRE	since: 8.0
RECT_RIGHT	since: 8.0
RECT_VCENTRE	since: 8.0
REGION_ADDR	This macro returns a pointer to a pixel in a region. The (`X`, `Y`) coordinates need to be within the `VipsRect` (`R`->valid). since: 8.0
REGION_ADDR_TOPLEFT	This macro returns a pointer to the top-left pixel in the `VipsRegion`, that is, the pixel at (`R`->valid.left, `R`->valid.top). since: 8.0
REGION_LSKIP	since: 8.0
REGION_N_ELEMENTS	since: 8.0
REGION_SIZEOF_ELEMENT	since: 8.0
REGION_SIZEOF_LINE	since: 8.0
REGION_SIZEOF_PEL	since: 8.0
RINT	since: 8.0
ROUND	since: 8.0
ROUND_DOWN	since: 8.0
ROUND_INT	since: 8.0
ROUND_UINT	since: 8.0
ROUND_UP	since: 8.0
SBUF_FETCH	After a successful `VIPS_SBUF_REQUIRE()`, you can use this require times to fetch characters of input. since: 8.0
SBUF_GETC	Fetch the next character from the source. since: 8.0
SBUF_PEEK	After a successful `VIPS_SBUF_REQUIRE()`, you can index this to get require characters of input. since: 8.0
SBUF_REQUIRE	Make sure at least `require` characters are available for `VIPS_SBUF_PEEK()` and `VIPS_SBUF_FETCH()`. since: 8.0
SBUF_UNGETC	The opposite of `vips_sbuf_getc()`: undo the previous getc. since: 8.0
SETSTR	since: 8.0
SWAP	since: 8.0
TARGET_CLONES	since: 8.0
TARGET_PUTC	since: 8.0
UNREF	since: 8.0
UNROLL	since: 8.0

Constants

A_X0	Areas under curves for illuminant A (2856K), 2 degree observer. since: 8.0
A_Y0	since: 8.0
A_Z0	since: 8.0
ARGUMENT_OPTIONAL_INPUT	since: 8.0
ARGUMENT_OPTIONAL_OUTPUT	since: 8.0
ARGUMENT_REQUIRED_INPUT	since: 8.0
ARGUMENT_REQUIRED_OUTPUT	since: 8.0
B_X0	Areas under curves for illuminant B (4874K), 2 degree observer. since: 8.0
B_Y0	since: 8.0
B_Z0	since: 8.0
C_X0	Areas under curves for illuminant C (6774K), 2 degree observer. since: 8.0
C_Y0	since: 8.0
C_Z0	since: 8.0
CONFIG	since: 8.0
D3250_X0	Areas under curves for black body at 3250K, 2 degree observer. since: 8.0
D3250_Y0	since: 8.0
D3250_Z0	since: 8.0
D50_X0	Areas under curves for D50, 2 degree observer. since: 8.0
D50_Y0	since: 8.0
D50_Z0	since: 8.0
D55_X0	Areas under curves for D55, 2 degree observer. since: 8.0
D55_Y0	since: 8.0
D55_Z0	since: 8.0
D65_X0	Areas under curves for D65, 2 degree observer. since: 8.0
D65_Y0	since: 8.0
D65_Z0	since: 8.0
D75_X0	Areas under curves for D75, 2 degree observer. since: 8.0
D75_Y0	since: 8.0
D75_Z0	since: 8.0
D93_X0	Areas under curves for D93, 2 degree observer. since: 8.0
D93_Y0	since: 8.0
D93_Z0	since: 8.0
DEFAULT_MAX_COORD	since: 8.0
E_X0	Areas under curves for equal energy illuminant E. since: 8.0
E_Y0	since: 8.0
E_Z0	since: 8.0
ENABLE_DEPRECATED	since: 8.0
INTERPOLATE_SCALE	`VIPS_INTERPOLATE_SHIFT` as a multiplicative constant. since: 8.0
INTERPOLATE_SHIFT	Many of the vips interpolators use fixed-point arithmetic for value calculation. This is how many bits of precision they use. since: 8.0
LIBRARY_AGE	since: 8.0
LIBRARY_CURRENT	since: 8.0
LIBRARY_REVISION	since: 8.0
MAGIC_INTEL	The first four bytes of a VIPS file in Intel byte ordering. since: 8.0
MAGIC_SPARC	The first four bytes of a VIPS file in SPARC byte ordering. since: 8.0
MAJOR_VERSION	since: 8.0
META_BITS_PER_SAMPLE	The bits per sample for each channel. since: 8.0
META_CONCURRENCY	If set, the suggested concurrency for this image. since: 8.0
META_EXIF_NAME	The name that read and write operations use for the image’s EXIF data. since: 8.0
META_ICC_NAME	The name we use to attach an ICC profile. The file read and write operations for TIFF, JPEG, PNG and others use this item of metadata to attach and save ICC profiles. The profile is updated by the `vips_icc_transform()` operations. since: 8.0
META_IMAGEDESCRIPTION	The IMAGEDESCRIPTION tag. Often has useful metadata. since: 8.0
META_IPTC_NAME	The name that read and write operations use for the image’s IPTC data. since: 8.0
META_LOADER	Record the name of the original loader here. Handy for hinting file formats and for debugging. since: 8.0
META_N_PAGES	If set, the number of pages in the original file. since: 8.0
META_N_SUBIFDS	If set, the number of subifds in the first page of the file. since: 8.0
META_ORIENTATION	The orientation tag for this image. An int from 1 - 8 using the standard exif/tiff meanings. since: 8.0
META_PAGE_HEIGHT	If set, the height of each page when this image was loaded. If you save an image with “page-height” set to a format that supports multiple pages, such as tiff, the image will be saved as a series of pages. since: 8.0
META_PALETTE	Does this image have a palette? since: 8.0
META_PHOTOSHOP_NAME	The name that TIFF read and write operations use for the image’s TIFFTAG_PHOTOSHOP data. since: 8.0
META_RESOLUTION_UNIT	The JPEG and TIFF read and write operations use this to record the file’s preferred unit for resolution. since: 8.0
META_SEQUENTIAL	Images loaded via `vips_sequential()` have this int field defined. Some operations (eg. `vips_shrinkv()`) add extra caches if they see it on their input. since: 8.0
META_XMP_NAME	The name that read and write operations use for the image’s XMP data. since: 8.0
MICRO_VERSION	since: 8.0
MINOR_VERSION	since: 8.0
PATH_MAX	since: 8.0
PI	since: 8.0
SBUF_BUFFER_SIZE	since: 8.0
TARGET_BUFFER_SIZE	since: 8.0
TARGET_CUSTOM_BUFFER_SIZE	since: 8.0
TRANSFORM_SCALE	`VIPS_TRANSFORM_SHIFT` as a multiplicative constant. since: 8.0
TRANSFORM_SHIFT	Many of the libvips interpolators use fixed-point arithmetic for coordinate calculation. This is how many bits of precision they use. since: 8.0
VERSION	since: 8.0
VERSION_STRING	since: 8.0

Dependencies

Related libraries

Additional documentation

Classes

Structs

Aliases

Enumerations

Bitfields

Callbacks

Functions

Function Macros

Constants