An abstract base class representing a source or sink of bytes.

An abstract base class to load and save images in a variety of formats.

An abstract base class to load images in a variety of formats.

An abstract base class to save images in a variety of formats.

TheVipsImage class and associated types and macros.

An abstract base class for the various interpolation functions.

An abstract base class for all objects in libvips.

An abstract base class for all operations in libvips.

AVipsRegion represents a small, rectangular part of an image.

AVipsSbuf provides a buffered reading interface for aVipsSource.

AVipsSource provides a unified interface for reading, seeking, andmapping data, regardless of the underlying source type.

Subclass ofVipsSource with action signals for handlers.

AVipsTarget provides a unified interface for writing data to variousoutput destinations.

Subclass ofVipsTarget with action signals for handlers.

AVipsThreadState represents a per-thread state.

Libvips has a simple mechanism for automating at least some aspects ofGObject properties. You add a set of macros to your_class_init() which describe the arguments, and set the get and setfunctions to the libvips ones.

A message buffer you can append stuff to safely and quickly. If the messagegets too long, you get “…” and truncation. Message buffers can be on thestack or heap.

A structure available to eval callbacks giving information on evaluationprogress. SeeVipsImage::eval.

AVipsRect is a rectangular area of pixels. This is a struct forperforming simple rectangle algebra.

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

The type of access an operation has to supply. Seevips_tilecache()andVipsForeign.

Seevips_join() and so on.

Seevips_rot() and so on.

Seevips_rot45() and so on.

The format used for each band element.

The various Porter-Duff andPDF blend modes. Seevips_composite(),for example.

How pixels are coded.

How to combine values. Seevips_compass(), for example.

Seevips_draw_image() and so on.

A direction on a compass. Used forvips_gravity(), for example.

Seevips_image_pipelinev(). Operations can hintthe kind of demand geometry they preferto theVIPS imageIO system.

Seevips_flip(),vips_join() and so on.

Seevips_embed(),vips_conv(),vips_affine() and so on.

How sensitive loaders are to errors, from never stop (very insensitive), tostop on the smallest warning (very sensitive).

How many pyramid layers to create.

How many pyramid layers to create.

What directory layout and metadata standard to use.

The compression format to use inside aHEIF container.

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.

The netpbm file format to save as.

Set subsampling mode.

The compression types supported by the tiff writer.

The predictor can help deflate and lzw compression. The values are fixed bythe tiff library.

Use inches or centimeters as the resolution unit for a tiff file.

Tune lossy encoder settings for different image types.

The rendering intent.VIPS_INTENT_ABSOLUTE is best forscientific work,VIPS_INTENT_RELATIVE is usually best foraccurate communication with other imaging libraries.

Pick the algorithm vips uses to decide image “interestingness”. This is usedbyvips_smartcrop(), for example, to decide what parts of the image to keep.

How the values in an image should be interpreted. For example, athree-band float image of typeVIPS_INTERPRETATION_LAB should have itspixels interpreted as coordinates inCIE Lab space.

The resampling kernels vips supports. Seevips_reduce(), for example.

See also:vips_boolean().

See also:vips_complex().

See also:vips_complex2().

See also:vips_complexget().

See also:vips_math().

See also:vips_math().

More like hit-miss, really.

See also:vips_relational().

See also:vips_round().

Pick a Profile Connection Space forvips_icc_import() andvips_icc_export().LAB is usually best,XYZ can be more convenient in some cases.

How accurate an operation should be.

How to calculate the output pixels when shrinking a 2x2 region.

TheSDF to generate,.

Controls whether an operation should upsize, downsize, both up anddownsize, or force a size.

Sets the word wrapping style forvips_text() when used with a maximum width.

Flags we associate with each object argument.

The set of coding types supported by a saver.

Some hints about the image loader.

Which metadata to retain.

The values mirror those of png.h in libpng.

The set of image types supported by a saver.

Flags we associate with an operation.

Fillout->valid with pixels.seq contains per-thread state, such as theinput regions. Setstop toTRUE to stop processing.

An interpolation function. It should read source pixels fromin withVIPS_REGION_ADDR(), it can look left and up from (x, y) bywindow_offsetpixels and it can access pixels in a window of sizewindow_size.

The function should write the pixels inarea fromregion.a is thevalue passed intovips_sink_disc().

Start a new processing sequence for this generate function. This allocatesper-thread state, such as an input region.

Stop a processing sequence. This freesper-thread state, such as an input region.

This function is called to allocate a new work unit for the thread. It isalways single-threaded, so it can modify per-pool state (such as a counter).

This function is called by the main thread once for every work unitprocessed. It can be used to give the user progress feedback.

This function is called to process a work unit. Many copies of this can runat once, so it should not write to the per-pool state. It can write toper-thread state.

Add the standard vipsGOptionEntry to aGOptionGroup.

Convenience function — make aNULL-terminated array of input images.Use withvips_start_many().

Set the block state on all untrusted operations.

Drop the whole operation cache, handy for leak tracking. Also calledautomatically onvips_shutdown().

Get the maximum number of operations we keep in cache.

Get the maximum number of tracked files we allow before we start droppingcached operations. Seevips_tracked_get_files().

Get the maximum amount of tracked memory we allow before we start droppingcached operations. Seevips_tracked_get_mem().

Get the current number of operations in cache.

A binding-friendly version ofvips_cache_operation_buildp().

Look upoperation in the cache. If we get a hit, unrefoperation, ref theold one and return that through the argument pointer.

Print the whole operation cache to stdout. Handy for debugging.

Handy for debugging. Print the operation cache to stdout just before exit.

Set the maximum number of operations we keep in cache.

Set the maximum number of tracked files we allow before we start droppingcached operations. Seevips_tracked_get_files().

Set the maximum amount of tracked memory we allow before we start droppingcached operations. Seevips_tracked_get_mem().

Handy for debugging. Print operation cache actions to stdout as we run.

vips_call() calls the named operation, passing in required arguments andthen setting any optional ones from the remainder of the arguments as a setof name/value pairs.

This is the main entry point for the C and C++ varargs APIs.operationis executed, supplyingrequired andoptional arguments.

Check that the image is 8 or 16-bit integer, signed or unsigned.Otherwise set an error messageand return non-zero.

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 messageand return non-zero.

Check that the image hasbands bands.Otherwise set an error messageand return non-zero.

Check that the image has either one or three bands.Otherwise set an error messageand return non-zero.

Check that the images have the same number of bands, or that one of theimages has just 1 band.If not, set an error messageand return non-zero.

Check that an image has 1 orn bands. Handy for unary operations, cf.vips_check_bands_1orn().If not, set an error messageand return non-zero.

Check that the image has at leastbands bands.Otherwise set an error messageand return non-zero.

Check that the images have the same number of bands.If not, set an error messageand return non-zero.

Check that the image has the requiredcoding.If not, set an error messageand return non-zero.

Check that the image is uncoded,LABQ coded orRAD coded.If not, set an error messageand return non-zero.

Check that the image is uncoded orLABQ coded.If not, set an error messageand return non-zero.

Check that the images have the same coding.If not, set an error messageand return non-zero.

Check that the image is complex.Otherwise set an error messageand return non-zero.

Check that the image has the specified format.Otherwise set an error messageand return non-zero.

Check that the images have the same format.If not, set an error messageand return non-zero.

Histogram images must have width or height 1, and must not have more than65536 elements. Return 0 if the image will pass as a histogram, or -1 andset an error message otherwise.

Check that the image is in one of the integer formats.Otherwise set an error messageand return non-zero.

Matrix images must have width and height less than 100000 and have 1 band.

Check that the image has exactly one band.Otherwise set an error messageand return non-zero.

Check that the image is not complex.Otherwise set an error messageand return non-zero.

Check that the image is square and that the sides are odd.If not, set an error messageand return non-zero.

Check thatprec image is either float or int.If not, set an error messageand return non-zero.

Separable matrix images must have width or height 1.Return 0 if the image will pass, or -1 andset an error message otherwise.

Check that the images have the same size.If not, set an error messageand return non-zero.

Check that the image is has two “components”, ie. is a one-band complex ora two-band non-complex.Otherwise set an error messageand return non-zero.

Check that the image is 8 or 16-bit unsigned integer.Otherwise set an error messageand return non-zero.

Check that the image is 8 or 16-bit unsigned integer, or float.Otherwise set an error message and return non-zero.

Check that the image is in one of the unsigned integer formats.Otherwise set an error messageand return non-zero.

Check that the image is unsigned int or float.Otherwise set an error message and return non-zero.

Check that the image is not coded.If not, set an error messageand return non-zero.

Operations with a vector constant need a 1-element vector, or a vector withthe same number of elements as there are bands in the image, or a 1-bandimage and a many-element vector.

Check thatn ==len.

Search belowbasename, return the first class whose name ornicknamematches.

Loop over all the subclasses oftype. Non-abstract classes only.Stop whenfn returnsnon-NULL and return that value.

Calculate Ccmc from C.

Calculate C from Ccmc using a table.Callvips_col_make_tables_CMC() atleast once before using this function.

Calculate ab from Ch, h in degrees.

Calculate hcmc from C and h.

Calculate h from C and hcmc, using a table.Callvips_col_make_tables_CMC() atleast once before using this function.

CIEDE2000, from:.

Calculate Lcmc from L.

CalculateXYZ from Lab, D65.

Calculate L from Lcmc using a table. Callvips_col_make_tables_CMC() atleast once before using this function.

Make the lookup tables for cmc.

Turn scRGB intoXYZ.

CalculateXYZ from Lab, D65.

TurnXYZ into scRGB.

Returns the number of worker threads that vips should use when runningvips_threadpool_run().

Sets the number of worker threads that vips should use when runningvips_threadpool_run().

Format the string in the style ofprintf() and append to the 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.

Return a copy of the vips error buffer, and clear it.

Clear and reset the error buffer. This is typically called after presentingan error to the user.

Sends a formatted error message to stderr, then sends the contents of theerror buffer, if any, then shuts down vips and terminates the program withan error code.

Stop errors being logged. Usevips_error_thaw() to unfreeze. You cannest freeze/thaw pairs.

This function sets the glib error pointer from the vips error buffer andclears it. It’s handy for returning errors to glib functions from vips.

Format the string in the style ofprintf() and append to the error buffer.Then create and append a localised message based on the system error code,usually the value of errno.

Re-enable error logging.

Given a vips filename like “fred.jpg[Q=90]”, return a new string ofjust the filename part, “fred.jpg” in this case.

Given a vips filename like “fred.jpg[Q=90]”, return a new string ofjust the options part, “[Q=90]” in this case.

Return the flags forfilename usingloader.loader is something like “tiffload” or “VipsForeignLoadTiff”.

A fast but dangerous version ofvips_format_sizeof(). You must havepreviously range-checkedformat or you’ll crash.

This function adds theGError to the vips error buffer and clears it. It’sthe opposite ofvips_error_g().

Create a newGInputStream wrapping aVipsSource. This isuseful for loaders likeSVG andPDF which supportGInputStreammethods.

Wrapper forg_thread_try_new().

Return the number of bytes at which we flip between open via memory andopen via disc. This defaults to 100mb, but can be changed with theVIPS_DISC_THRESHOLD environment variable or the--vips-disc-thresholdcommand-line flag. Seevips_image_new_from_file().

Return the program name.

vips_guess_libdir() tries to guess the install directory (usually theconfigure libdir, or $prefix/lib). You should passin the value of argv[0] (the name your program was run as) as a clue tohelp it out, plus the name of the environment variable you let the useroverride your package install area with (eg. “VIPSHOME”).

vips_guess_prefix() tries to guess the install directory. You should passin the value of argv[0] (the name your program was run as) as a clue tohelp it out, plus the name of the environment variable you let the useroverride your package install area with (eg. “VIPSHOME”).

Like slist map, but for a hash table.

VIPS can optionally be built without theICC library. Use this function totest for its availability.

This function starts up libvips, seeVIPS_INIT().

Look up theinterpolate method in the class and call it. Usevips_interpolate_get_method() to get a direct pointer to the function andavoid the lookup overhead.

Turn on or off vips leak checking. See also--vips-leak,vips_add_option_entries() and theVIPS_LEAK environment variable.

g_malloc() local toobject, that is, the memory will be automaticallyfreed for you when the object is closed. Ifobject isNULL, you need tofree the memory explicitly withg_free().

Return the maximum coordinate value. This can be the default, a value setset by the--vips-max-coordCLI arg, or a value set in theVIPS_MAX_COORDenvironment variable.

Return theVIPS nickname for aGType. Handy for language bindings.

If a source does not support mmap or seek and the source isused with a loader that can only work from memory, then the data will beautomatically read into memory toEOF before the loader starts. This canproduce high memory use if the descriptor represents a large object.

If set, vips will record profiling information, and dump it on programexit. These profiles can be analysed with thevipsprofile program.

Pythagorean distance between two points in colour space. Lab/XYZ/CMC etc.

Call this to drop caches, close plugins, terminate background threads, andfinalize any internal library testing.

Loops overim, generating it to a memory buffer attached toim. It isused by vips to implement writing to a memory buffer.

Test two lists for equality.

Remove all occurrences of an item from a list.Returns the new head of the list.

Fold over a slist, applyingfn to each element.

Free aGSList of things which needg_free()ing.

Map over a slist. _copy() the list in case the callback changes it.

Map backwards. We _reverse() rather than recurse and unwind to save stack.

Map over a slist. _copy() the list in case the callback changes it.

Start function for many images in.a is a pointer toaNULL-terminated array of input images.

Start function for one image in. Input image isa.

Stop function for many images in.a is a pointer toaNULL-terminated array of input images.

Stop function for one image in. Input image isa.

g_strdup() a string. Whenobject is freed, the string will be freed foryou. Ifobject isNULL, you need tofree the memory yourself withg_free().

A newly created or reused thread will executefunc with theargumentdata.

Free any thread-private data and flush any profiling information.

This function runs a set of threads over an image. Each thread first callsstart to create new per-thread state, then runsallocate to set up a new work unit (perhaps the next tile in an image, forexample), thenwork to process that work unit. After each unit isprocessed,progress is called, so that the operation can giveprogress feedback.progress may beNULL.

Allocate an area of memory aligned on a boundary specifiedbyalign that will be tracked byvips_tracked_get_mem()and friends.

Only use it to free memory that waspreviously allocated withvips_tracked_aligned_alloc()with aNULL first argument.

Exactly asclose(), but update the number of files currently open viavips_tracked_get_files(). This is usedby the vips operation cache to drop cache when the number of filesavailable is low.

Only use it to free memory that waspreviously allocated withvips_tracked_malloc()with aNULL first argument.

Returns the number of active allocations.

Returns the number of open files.

Returns the number of bytes currently allocated viavips_malloc() andfriends. vips uses this figure to decide when to start dropping cache, seeVipsOperation.

Returns the largest number of bytes simultaneously allocated viavips_tracked_malloc(). Handy for estimating max memory requirements for a program.

Allocate an area of memory that will be tracked byvips_tracked_get_mem()and friends.

Exactly asopen(), but the number of files currently open viavips_tracked_open() is available viavips_tracked_get_files(). This is usedby the vips operation cache to drop cache when the number of filesavailable is low.

Search belowbasename, return theGType of the classwhose name ornickname matches, or 0 for not found.Ifbasename isNULL, the whole ofVipsObject is searched.

Map over a type’s children. Stop whenfn returns non-NULLand return that value.

Map over a type’s children, direct and indirect. Stop whenfn returnsnon-NULL and return that value.

Get the pointer from an area. Don’t touch count (area is static).

Return the pointer to the array held byvalue.Optionally return the other properties of the array inn,type,sizeof_type.

Return the start of the array of doubles held byvalue.optionally return the number of elements inn.

Return the start of the array of images held byvalue.optionally return the number of elements inn.

Return the start of the array of ints held byvalue.optionally return the number of elements inn.

Return the start of the array ofGObject held byvalue.Optionally return the number of elements inn.

Returns the data pointer from a blob. Optionally returns the length too.

Get the C string held internally by theGValue.

Get the C string held internally by the GValue.

Set value to be a ref-counted area of memory with a free function.

Setvalue to be an array of things.

Setvalue to hold a copy ofarray. Pass in the array length inn.

Setvalue to hold an array of images. Pass in the array length inn.

Setvalue to hold a copy ofarray. Pass in the array length inn.

Setvalue to hold an array ofGObject. Pass in the array length inn.

Setsvalue to hold adata. Whenvalue is freed,data will befreed withfree_fn.value also holds a note of the size of the memory area.

Just likevips_value_set_blob(), but whenvalue is freed,data will befreed withg_free().

Copies the C stringstr intovalue.

Copies the C string intovalue.

Generates a string and copies it intovalue.

Takes a bitfield of targets to disable on the runtime platform.Handy for testing and benchmarking purposes.

Gets a bitfield of builtin targets that libvips was built with.

Gets a bitfield of enabled targets that are supported on thisCPU. Thetargets returned may change after callingvips_vector_disable_targets().

Generates a human-readableASCII string descriptor for a specific target.

Append a message to the error buffer.

Format the string in the style ofprintf() and append to the error buffer.Then create and append a localised message based on the system error code,usually the value of errno.

Get the major, minor or micro library version, withflag values 0, 1 and 2.

Get theVIPS version as a static string, including a build date and time.Do not free.

Allocate memory for an array of objects of typeT. The memory is not cleared.

Initialize a heap buffer. For example:.

This macro returns a pointer to a pixel in an image, cast to aVipsPel *.It only works for images which are fully available in memory, so memorybuffers and small mapped images only.

VIPS_INIT() starts up the world ofVIPS. You should call this onprogram startup before using any otherVIPS operations. If you do not callVIPS_INIT(),VIPS will call it for you when you use your firstVIPSoperation, but it may not be able to get hold ofARGV0 andVIPS maytherefore be unable to find its data files. It is much better to callthis macro yourself.

This macro returns a pointer to a pixel in an image, cast to a double*. Theimage must have a single band, beVIPS_FORMAT_DOUBLE and befully available in memory, so memory buffers and smallmapped images only.

Allocate memory for a thing of typeT. The memory is not cleared.

This macro returns a pointer to a pixel in a region. The (X,Y)coordinates need to be within theVipsRect (R->valid).

This macro returns a pointer to the top-left pixel in theVipsRegion, thatis, the pixel at (R->valid.left,R->valid.top).

After a successfulVIPS_SBUF_REQUIRE(), you can use this require timesto fetch characters of input.

Fetch the next character from the source.

After a successfulVIPS_SBUF_REQUIRE(), you can index this to getrequire characters of input.

Make sure at leastrequire characters are available forVIPS_SBUF_PEEK() andVIPS_SBUF_FETCH().

The opposite ofvips_sbuf_getc(): undo the previous getc.

Areas under curves for illuminant A (2856K), 2 degree observer.

Areas under curves for illuminant B (4874K), 2 degree observer.

Areas under curves for illuminant C (6774K), 2 degree observer.

Areas under curves for black body at 3250K, 2 degree observer.

Areas under curves for D50, 2 degree observer.

Areas under curves for D55, 2 degree observer.

Areas under curves for D65, 2 degree observer.

Areas under curves for D75, 2 degree observer.

Areas under curves for D93, 2 degree observer.

Areas under curves for equal energy illuminant E.

VIPS_INTERPOLATE_SHIFT as a multiplicative constant.

Many of the vips interpolators use fixed-point arithmetic for valuecalculation. This is how many bits of precision they use.

The first four bytes of aVIPS file in Intel byte ordering.

The first four bytes of aVIPS file inSPARC byte ordering.

The bits per sample for each channel.

If set, the suggested concurrency for this image.

The name that read and write operations use for the image’sEXIF data.

The name we use to attach anICC profile. The file read and writeoperations forTIFF,JPEG,PNG and others use this item of metadata toattach and saveICC profiles. The profile is updated by thevips_icc_transform() operations.

TheIMAGEDESCRIPTION tag. Often has useful metadata.

The name that read and write operations use for the image’sIPTC data.

Record the name of the original loader here. Handy for hinting file formatsand for debugging.

If set, the number of pages in the original file.

If set, the number of subifds in the first page of the file.

The orientation tag for this image. An int from 1 - 8 using the standardexif/tiff meanings.

If set, the height of each page when this image was loaded. If you save animage with “page-height” set to a format that supports multiple pages, suchas tiff, the image will be saved as a series of pages.

Does this image have a palette?

The name thatTIFF read and write operations use for the image’sTIFFTAG_PHOTOSHOP data.

TheJPEG andTIFF read and write operations use this to record thefile’s preferred unit for resolution.

Images loaded viavips_sequential() have this int field defined. Someoperations (eg.vips_shrinkv()) add extra caches if they see it on their input.

The name that read and write operations use for the image’sXMP data.

VIPS_TRANSFORM_SHIFT as a multiplicative constant.

Many of the libvips interpolators use fixed-point arithmetic for coordinatecalculation. This is how many bits of precision they use.