From c7bab3210913ba37e06c8994e3c02820ea860cfd Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Mon, 17 Aug 2020 14:11:17 +0100 Subject: [PATCH] add optional params to doc strings --- cplusplus/gen-operators.py | 11 +- cplusplus/include/vips/VImage8.h | 1500 +++++++++++++++++++++++++++++- 2 files changed, 1509 insertions(+), 2 deletions(-) diff --git a/cplusplus/gen-operators.py b/cplusplus/gen-operators.py index e02cd758..e3ded719 100755 --- a/cplusplus/gen-operators.py +++ b/cplusplus/gen-operators.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +#!/usr/bin/python3 # This file generates the member definitions and declarations for all vips # operators. @@ -95,6 +95,15 @@ def generate_operation(operation_name, declaration_only=False): if declaration_only: result = '\n/**\n * {}.'.format(intro.description.capitalize()) + if len(intro.optional_input) > 0: + result += '\n *\n * **Optional parameters**' + for name in intro.optional_input: + details = intro.details[name] + result += f'\n * - {cppize(name)} -- ' + result += f'{details["blurb"]}, ' + result += f'{get_cpp_type(details["type"])}.' + result += '\n *' + for name in intro.method_args: result += '\n * @param {} {}.' \ .format(cppize(name), intro.details[name]['blurb']) diff --git a/cplusplus/include/vips/VImage8.h b/cplusplus/include/vips/VImage8.h index c4c03ed9..8bcbe570 100644 --- a/cplusplus/include/vips/VImage8.h +++ b/cplusplus/include/vips/VImage8.h @@ -1139,7 +1139,7 @@ public: */ // headers for vips operations -// Mon 17 Aug 10:55:59 BST 2020 +// Mon 17 Aug 14:09:48 BST 2020 // this file is generated automatically, do not edit! /** @@ -1200,6 +1200,10 @@ VImage Lab2LabS( VOption *options = 0 ) const; /** * Transform cielab to xyz. + * + * **Optional parameters** + * - temp -- Color temperature, std::vector. + * * @param options Set of options. * @return Output image. */ @@ -1249,6 +1253,10 @@ VImage XYZ2CMYK( VOption *options = 0 ) const; /** * Transform xyz to lab. + * + * **Optional parameters** + * - temp -- Colour temperature, std::vector. + * * @param options Set of options. * @return Output image. */ @@ -1292,6 +1300,18 @@ VImage add( VImage right, VOption *options = 0 ) const; /** * Affine transform of an image. + * + * **Optional parameters** + * - interpolate -- Interpolate pixels with this, . + * - oarea -- Area of output to generate, std::vector. + * - odx -- Horizontal output displacement, double. + * - ody -- Vertical output displacement, double. + * - idx -- Horizontal input displacement, double. + * - idy -- Vertical input displacement, double. + * - background -- Background value, std::vector. + * - premultiplied -- Images have premultiplied alpha, bool. + * - extend -- How to generate the extra pixels, VipsExtend. + * * @param matrix Transformation matrix. * @param options Set of options. * @return Output image. @@ -1300,6 +1320,14 @@ VImage affine( std::vector matrix, VOption *options = 0 ) const; /** * Load an analyze6 image. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -1308,6 +1336,16 @@ static VImage analyzeload( const char *filename, VOption *options = 0 ); /** * Join an array of images. + * + * **Optional parameters** + * - across -- Number of images across grid, int. + * - shim -- Pixels between images, int. + * - background -- Colour for new pixels, std::vector. + * - halign -- Align on the left, centre or right, VipsAlign. + * - valign -- Align on the top, centre or bottom, VipsAlign. + * - hspacing -- Horizontal spacing between images, int. + * - vspacing -- Vertical spacing between images, int. + * * @param in Array of input images. * @param options Set of options. * @return Output image. @@ -1338,6 +1376,10 @@ VImage bandbool( VipsOperationBoolean boolean, VOption *options = 0 ) const; /** * Fold up x axis into bands. + * + * **Optional parameters** + * - factor -- Fold by this factor, int. + * * @param options Set of options. * @return Output image. */ @@ -1368,6 +1410,10 @@ VImage bandmean( VOption *options = 0 ) const; /** * Band-wise rank of a set of images. + * + * **Optional parameters** + * - index -- Select this band element from sorted list, int. + * * @param in Array of input images. * @param options Set of options. * @return Output image. @@ -1376,6 +1422,10 @@ static VImage bandrank( std::vector in, VOption *options = 0 ); /** * Unfold image bands into x axis. + * + * **Optional parameters** + * - factor -- Unfold by this factor, int. + * * @param options Set of options. * @return Output image. */ @@ -1383,6 +1433,10 @@ VImage bandunfold( VOption *options = 0 ) const; /** * Make a black image. + * + * **Optional parameters** + * - bands -- Number of bands in image, int. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -1424,6 +1478,12 @@ VImage byteswap( VOption *options = 0 ) const; /** * Cache an image. + * + * **Optional parameters** + * - max_tiles -- Maximum number of tiles to cache, int. + * - tile_height -- Tile height in pixels, int. + * - tile_width -- Tile width in pixels, int. + * * @param options Set of options. * @return Output image. */ @@ -1431,6 +1491,11 @@ VImage cache( VOption *options = 0 ) const; /** * Canny edge detector. + * + * **Optional parameters** + * - sigma -- Sigma of Gaussian, double. + * - precision -- Convolve with this precision, VipsPrecision. + * * @param options Set of options. * @return Output image. */ @@ -1446,6 +1511,10 @@ VImage case_image( std::vector cases, VOption *options = 0 ) const; /** * Cast an image. + * + * **Optional parameters** + * - shift -- Shift integer values up and down, bool. + * * @param format Format to cast to. * @param options Set of options. * @return Output image. @@ -1454,6 +1523,10 @@ VImage cast( VipsBandFormat format, VOption *options = 0 ) const; /** * Convert to a new colorspace. + * + * **Optional parameters** + * - source_space -- Source color space, VipsInterpretation. + * * @param space Destination color space. * @param options Set of options. * @return Output image. @@ -1462,6 +1535,15 @@ VImage colourspace( VipsInterpretation space, VOption *options = 0 ) const; /** * Convolve with rotating mask. + * + * **Optional parameters** + * - times -- Rotate and convolve this many times, int. + * - angle -- Rotate mask by this much between convolutions, VipsAngle45. + * - combine -- Combine convolution results like this, VipsCombine. + * - precision -- Convolve with this precision, VipsPrecision. + * - layers -- Use this many layers in approximation, int. + * - cluster -- Cluster lines closer than this in approximation, int. + * * @param mask Input matrix image. * @param options Set of options. * @return Output image. @@ -1503,6 +1585,13 @@ VImage complexget( VipsOperationComplexget get, VOption *options = 0 ) const; /** * Blend an array of images with an array of blend modes. + * + * **Optional parameters** + * - x -- Array of x coordinates to join at, std::vector. + * - y -- Array of y coordinates to join at, std::vector. + * - compositing_space -- Composite images in this colour space, VipsInterpretation. + * - premultiplied -- Images have premultiplied alpha, bool. + * * @param in Array of input images. * @param mode Array of VipsBlendMode to join with. * @param options Set of options. @@ -1512,6 +1601,13 @@ static VImage composite( std::vector in, std::vector mode, VOption /** * Blend a pair of images with a blend mode. + * + * **Optional parameters** + * - x -- x position of overlay, int. + * - y -- y position of overlay, int. + * - compositing_space -- Composite images in this colour space, VipsInterpretation. + * - premultiplied -- Images have premultiplied alpha, bool. + * * @param overlay Overlay image. * @param mode VipsBlendMode to join with. * @param options Set of options. @@ -1521,6 +1617,12 @@ VImage composite2( VImage overlay, VipsBlendMode mode, VOption *options = 0 ) co /** * Convolution operation. + * + * **Optional parameters** + * - precision -- Convolve with this precision, VipsPrecision. + * - layers -- Use this many layers in approximation, int. + * - cluster -- Cluster lines closer than this in approximation, int. + * * @param mask Input matrix image. * @param options Set of options. * @return Output image. @@ -1529,6 +1631,11 @@ VImage conv( VImage mask, VOption *options = 0 ) const; /** * Approximate integer convolution. + * + * **Optional parameters** + * - layers -- Use this many layers in approximation, int. + * - cluster -- Cluster lines closer than this in approximation, int. + * * @param mask Input matrix image. * @param options Set of options. * @return Output image. @@ -1537,6 +1644,10 @@ VImage conva( VImage mask, VOption *options = 0 ) const; /** * Approximate separable integer convolution. + * + * **Optional parameters** + * - layers -- Use this many layers in approximation, int. + * * @param mask Input matrix image. * @param options Set of options. * @return Output image. @@ -1561,6 +1672,12 @@ VImage convi( VImage mask, VOption *options = 0 ) const; /** * Seperable convolution operation. + * + * **Optional parameters** + * - precision -- Convolve with this precision, VipsPrecision. + * - layers -- Use this many layers in approximation, int. + * - cluster -- Cluster lines closer than this in approximation, int. + * * @param mask Input matrix image. * @param options Set of options. * @return Output image. @@ -1569,6 +1686,20 @@ VImage convsep( VImage mask, VOption *options = 0 ) const; /** * Copy an image. + * + * **Optional parameters** + * - swap -- Swap bytes in image between little and big-endian, bool. + * - width -- Image width in pixels, int. + * - height -- Image height in pixels, int. + * - bands -- Number of bands in image, int. + * - format -- Pixel format in image, VipsBandFormat. + * - coding -- Pixel coding, VipsCoding. + * - interpretation -- Pixel interpretation, VipsInterpretation. + * - xres -- Horizontal resolution in pixels/mm, double. + * - yres -- Vertical resolution in pixels/mm, double. + * - xoffset -- Horizontal offset of origin, int. + * - yoffset -- Vertical offset of origin, int. + * * @param options Set of options. * @return Output image. */ @@ -1595,6 +1726,18 @@ VImage crop( int left, int top, int width, int height, VOption *options = 0 ) co /** * Load csv. + * + * **Optional parameters** + * - skip -- Skip this many lines at the start of the file, int. + * - lines -- Read this many lines from the file, int. + * - whitespace -- Set of whitespace characters, const char *. + * - separator -- Set of separator characters, const char *. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -1603,6 +1746,18 @@ static VImage csvload( const char *filename, VOption *options = 0 ); /** * Load csv. + * + * **Optional parameters** + * - skip -- Skip this many lines at the start of the file, int. + * - lines -- Read this many lines from the file, int. + * - whitespace -- Set of whitespace characters, const char *. + * - separator -- Set of separator characters, const char *. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -1611,6 +1766,13 @@ static VImage csvload_source( VSource source, VOption *options = 0 ); /** * Save image to csv. + * + * **Optional parameters** + * - separator -- Separator characters, const char *. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -1618,6 +1780,13 @@ void csvsave( const char *filename, VOption *options = 0 ) const; /** * Save image to csv. + * + * **Optional parameters** + * - separator -- Separator characters, const char *. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -1664,6 +1833,10 @@ VImage divide( VImage right, VOption *options = 0 ) const; /** * Draw a circle on an image. + * + * **Optional parameters** + * - fill -- Draw a solid object, bool. + * * @param ink Color for pixels. * @param cx Centre of draw_circle. * @param cy Centre of draw_circle. @@ -1674,6 +1847,11 @@ void draw_circle( std::vector ink, int cx, int cy, int radius, VOption * /** * Flood-fill an area. + * + * **Optional parameters** + * - test -- Test pixels in this image, VImage. + * - equal -- DrawFlood while equal to edge, bool. + * * @param ink Color for pixels. * @param x DrawFlood start point. * @param y DrawFlood start point. @@ -1683,6 +1861,10 @@ void draw_flood( std::vector ink, int x, int y, VOption *options = 0 ) c /** * Paint an image into another image. + * + * **Optional parameters** + * - mode -- Combining mode, VipsCombineMode. + * * @param sub Sub-image to insert into main image. * @param x Draw image here. * @param y Draw image here. @@ -1713,6 +1895,10 @@ void draw_mask( std::vector ink, VImage mask, int x, int y, VOption *opt /** * Paint a rectangle on an image. + * + * **Optional parameters** + * - fill -- Draw a solid object, bool. + * * @param ink Color for pixels. * @param left Rect to fill. * @param top Rect to fill. @@ -1734,6 +1920,30 @@ void draw_smudge( int left, int top, int width, int height, VOption *options = 0 /** * Save image to deepzoom file. + * + * **Optional parameters** + * - dirname -- Directory name to save to, const char *. + * - basename -- Base name to save to, const char *. + * - layout -- Directory layout, VipsForeignDzLayout. + * - suffix -- Filename suffix for tiles, const char *. + * - overlap -- Tile overlap in pixels, int. + * - tile_size -- Tile size in pixels, int. + * - tile_height -- Tile height in pixels, int. + * - tile_width -- Tile width in pixels, int. + * - centre -- Center image in tile, bool. + * - depth -- Pyramid depth, VipsForeignDzDepth. + * - angle -- Rotate image during save, VipsAngle. + * - container -- Pyramid container type, VipsForeignDzContainer. + * - properties -- Write a properties file to the output directory, bool. + * - compression -- ZIP deflate compression level, int. + * - region_shrink -- Method to shrink regions, VipsRegionShrink. + * - skip_blanks -- Skip tiles which are nearly equal to the background, int. + * - no_strip -- Don't strip tile metadata, bool. + * - id -- Resource ID, const char *. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -1741,6 +1951,30 @@ void dzsave( const char *filename, VOption *options = 0 ) const; /** * Save image to dz buffer. + * + * **Optional parameters** + * - dirname -- Directory name to save to, const char *. + * - basename -- Base name to save to, const char *. + * - layout -- Directory layout, VipsForeignDzLayout. + * - suffix -- Filename suffix for tiles, const char *. + * - overlap -- Tile overlap in pixels, int. + * - tile_size -- Tile size in pixels, int. + * - tile_height -- Tile height in pixels, int. + * - tile_width -- Tile width in pixels, int. + * - centre -- Center image in tile, bool. + * - depth -- Pyramid depth, VipsForeignDzDepth. + * - angle -- Rotate image during save, VipsAngle. + * - container -- Pyramid container type, VipsForeignDzContainer. + * - properties -- Write a properties file to the output directory, bool. + * - compression -- ZIP deflate compression level, int. + * - region_shrink -- Method to shrink regions, VipsRegionShrink. + * - skip_blanks -- Skip tiles which are nearly equal to the background, int. + * - no_strip -- Don't strip tile metadata, bool. + * - id -- Resource ID, const char *. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -1748,6 +1982,11 @@ VipsBlob *dzsave_buffer( VOption *options = 0 ) const; /** * Embed an image in a larger image. + * + * **Optional parameters** + * - extend -- How to generate the extra pixels, VipsExtend. + * - background -- Color for background pixels, std::vector. + * * @param x Left edge of input in output. * @param y Top edge of input in output. * @param width Image width in pixels. @@ -1770,6 +2009,10 @@ VImage extract_area( int left, int top, int width, int height, VOption *options /** * Extract band from an image. + * + * **Optional parameters** + * - n -- Number of bands to extract, int. + * * @param band Band to extract. * @param options Set of options. * @return Output image. @@ -1778,6 +2021,11 @@ VImage extract_band( int band, VOption *options = 0 ) const; /** * Make an image showing the eye's spatial response. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - factor -- Maximum spatial frequency, double. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -1809,6 +2057,11 @@ VImage fill_nearest( VOption *options = 0 ) const; /** * Search an image for non-edge areas. + * + * **Optional parameters** + * - threshold -- Object threshold, double. + * - background -- Color for background pixels, std::vector. + * * @param top Top edge of extract area. * @param width Width of extract area. * @param height Height of extract area. @@ -1819,6 +2072,14 @@ int find_trim( int *top, int *width, int *height, VOption *options = 0 ) const; /** * Load a fits image. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -1827,6 +2088,12 @@ static VImage fitsload( const char *filename, VOption *options = 0 ); /** * Save image to fits file. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -1834,6 +2101,11 @@ void fitssave( const char *filename, VOption *options = 0 ) const; /** * Flatten alpha out of an image. + * + * **Optional parameters** + * - background -- Background value, std::vector. + * - max_alpha -- Maximum value of alpha channel, double. + * * @param options Set of options. * @return Output image. */ @@ -1881,6 +2153,10 @@ VImage fwfft( VOption *options = 0 ) const; /** * Gamma an image. + * + * **Optional parameters** + * - exponent -- Gamma factor, double. + * * @param options Set of options. * @return Output image. */ @@ -1888,6 +2164,11 @@ VImage gamma( VOption *options = 0 ) const; /** * Gaussian blur. + * + * **Optional parameters** + * - min_ampl -- Minimum amplitude of Gaussian, double. + * - precision -- Convolve with this precision, VipsPrecision. + * * @param sigma Sigma of Gaussian. * @param options Set of options. * @return Output image. @@ -1896,6 +2177,12 @@ VImage gaussblur( double sigma, VOption *options = 0 ) const; /** * Make a gaussian image. + * + * **Optional parameters** + * - separable -- Generate separable Gaussian, bool. + * - integer -- Generate integer Gaussian, bool. + * - precision -- Generate with this precision, VipsPrecision. + * * @param sigma Sigma of Gaussian. * @param min_ampl Minimum amplitude of Gaussian. * @param options Set of options. @@ -1905,6 +2192,11 @@ static VImage gaussmat( double sigma, double min_ampl, VOption *options = 0 ); /** * Make a gaussnoise image. + * + * **Optional parameters** + * - sigma -- Standard deviation of pixels in generated image, double. + * - mean -- Mean of pixels in generated image, double. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -1923,6 +2215,16 @@ std::vector getpoint( int x, int y, VOption *options = 0 ) const; /** * Load gif with giflib. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -1931,6 +2233,16 @@ static VImage gifload( const char *filename, VOption *options = 0 ); /** * Load gif with giflib. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -1939,6 +2251,16 @@ static VImage gifload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load gif with giflib. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -1947,6 +2269,11 @@ static VImage gifload_source( VSource source, VOption *options = 0 ); /** * Global balance an image mosaic. + * + * **Optional parameters** + * - gamma -- Image gamma, double. + * - int_output -- Integer output, bool. + * * @param options Set of options. * @return Output image. */ @@ -1954,6 +2281,11 @@ VImage globalbalance( VOption *options = 0 ) const; /** * Place an image within a larger image with a certain gravity. + * + * **Optional parameters** + * - extend -- How to generate the extra pixels, VipsExtend. + * - background -- Color for background pixels, std::vector. + * * @param direction direction to place image within width/height. * @param width Image width in pixels. * @param height Image height in pixels. @@ -1964,6 +2296,10 @@ VImage gravity( VipsCompassDirection direction, int width, int height, VOption * /** * Make a grey ramp image. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -1983,6 +2319,18 @@ VImage grid( int tile_height, int across, int down, VOption *options = 0 ) const /** * Load a heif image. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - thumbnail -- Fetch thumbnail image, bool. + * - autorotate -- Rotate image using exif orientation, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -1991,6 +2339,18 @@ static VImage heifload( const char *filename, VOption *options = 0 ); /** * Load a heif image. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - thumbnail -- Fetch thumbnail image, bool. + * - autorotate -- Rotate image using exif orientation, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -1999,6 +2359,18 @@ static VImage heifload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load a heif image. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - thumbnail -- Fetch thumbnail image, bool. + * - autorotate -- Rotate image using exif orientation, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -2007,6 +2379,15 @@ static VImage heifload_source( VSource source, VOption *options = 0 ); /** * Save image in heif format. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - lossless -- Enable lossless compression, bool. + * - compression -- Compression format, VipsForeignHeifCompression. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to load from. * @param options Set of options. */ @@ -2014,6 +2395,15 @@ void heifsave( const char *filename, VOption *options = 0 ) const; /** * Save image in heif format. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - lossless -- Enable lossless compression, bool. + * - compression -- Compression format, VipsForeignHeifCompression. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -2021,6 +2411,15 @@ VipsBlob *heifsave_buffer( VOption *options = 0 ) const; /** * Save image in heif format. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - lossless -- Enable lossless compression, bool. + * - compression -- Compression format, VipsForeignHeifCompression. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -2042,6 +2441,10 @@ double hist_entropy( VOption *options = 0 ) const; /** * Histogram equalisation. + * + * **Optional parameters** + * - band -- Equalise with this band, int. + * * @param options Set of options. * @return Output image. */ @@ -2049,6 +2452,10 @@ VImage hist_equal( VOption *options = 0 ) const; /** * Find image histogram. + * + * **Optional parameters** + * - band -- Find histogram of band, int. + * * @param options Set of options. * @return Output histogram. */ @@ -2056,6 +2463,10 @@ VImage hist_find( VOption *options = 0 ) const; /** * Find indexed image histogram. + * + * **Optional parameters** + * - combine -- Combine bins like this, VipsCombine. + * * @param index Index image. * @param options Set of options. * @return Output histogram. @@ -2064,6 +2475,10 @@ VImage hist_find_indexed( VImage index, VOption *options = 0 ) const; /** * Find n-dimensional image histogram. + * + * **Optional parameters** + * - bins -- Number of bins in each dimension, int. + * * @param options Set of options. * @return Output histogram. */ @@ -2078,6 +2493,10 @@ bool hist_ismonotonic( VOption *options = 0 ) const; /** * Local histogram equalisation. + * + * **Optional parameters** + * - max_slope -- Maximum slope (CLAHE), int. + * * @param width Window width in pixels. * @param height Window height in pixels. * @param options Set of options. @@ -2109,6 +2528,12 @@ VImage hist_plot( VOption *options = 0 ) const; /** * Find hough circle transform. + * + * **Optional parameters** + * - scale -- Scale down dimensions by this factor, int. + * - min_radius -- Smallest radius to search for, int. + * - max_radius -- Largest radius to search for, int. + * * @param options Set of options. * @return Output image. */ @@ -2116,6 +2541,11 @@ VImage hough_circle( VOption *options = 0 ) const; /** * Find hough line transform. + * + * **Optional parameters** + * - width -- horizontal size of parameter space, int. + * - height -- Vertical size of parameter space, int. + * * @param options Set of options. * @return Output image. */ @@ -2123,6 +2553,13 @@ VImage hough_line( VOption *options = 0 ) const; /** * Output to device with icc profile. + * + * **Optional parameters** + * - pcs -- Set Profile Connection Space, VipsPCS. + * - intent -- Rendering intent, VipsIntent. + * - output_profile -- Filename to load output profile from, const char *. + * - depth -- Output device space depth in bits, int. + * * @param options Set of options. * @return Output image. */ @@ -2130,6 +2567,13 @@ VImage icc_export( VOption *options = 0 ) const; /** * Import from device with icc profile. + * + * **Optional parameters** + * - pcs -- Set Profile Connection Space, VipsPCS. + * - intent -- Rendering intent, VipsIntent. + * - embedded -- Use embedded input profile, if available, bool. + * - input_profile -- Filename to load input profile from, const char *. + * * @param options Set of options. * @return Output image. */ @@ -2137,6 +2581,14 @@ VImage icc_import( VOption *options = 0 ) const; /** * Transform between devices with icc profiles. + * + * **Optional parameters** + * - pcs -- Set Profile Connection Space, VipsPCS. + * - intent -- Rendering intent, VipsIntent. + * - embedded -- Use embedded input profile, if available, bool. + * - input_profile -- Filename to load input profile from, const char *. + * - depth -- Output device space depth in bits, int. + * * @param output_profile Filename to load output profile from. * @param options Set of options. * @return Output image. @@ -2145,6 +2597,12 @@ VImage icc_transform( const char *output_profile, VOption *options = 0 ) const; /** * Make a 1d image where pixel values are indexes. + * + * **Optional parameters** + * - bands -- Number of bands in LUT, int. + * - ushort -- Create a 16-bit LUT, bool. + * - size -- Size of 16-bit LUT, int. + * * @param options Set of options. * @return Output image. */ @@ -2152,6 +2610,10 @@ static VImage identity( VOption *options = 0 ); /** * Ifthenelse an image. + * + * **Optional parameters** + * - blend -- Blend smoothly between then and else parts, bool. + * * @param in1 Source for TRUE pixels. * @param in2 Source for FALSE pixels. * @param options Set of options. @@ -2161,6 +2623,11 @@ VImage ifthenelse( VImage in1, VImage in2, VOption *options = 0 ) const; /** * Insert image @sub into @main at @x, @y. + * + * **Optional parameters** + * - expand -- Expand output to hold all of both inputs, bool. + * - background -- Color for new pixels, std::vector. + * * @param sub Sub-image to insert into main image. * @param x Left edge of sub in main. * @param y Top edge of sub in main. @@ -2178,6 +2645,10 @@ VImage invert( VOption *options = 0 ) const; /** * Build an inverted look-up table. + * + * **Optional parameters** + * - size -- LUT size to generate, int. + * * @param options Set of options. * @return Output image. */ @@ -2185,6 +2656,10 @@ VImage invertlut( VOption *options = 0 ) const; /** * Inverse fft. + * + * **Optional parameters** + * - real -- Output only the real part of the transform, bool. + * * @param options Set of options. * @return Output image. */ @@ -2192,6 +2667,13 @@ VImage invfft( VOption *options = 0 ) const; /** * Join a pair of images. + * + * **Optional parameters** + * - expand -- Expand output to hold all of both inputs, bool. + * - shim -- Pixels between images, int. + * - background -- Colour for new pixels, std::vector. + * - align -- Align on the low, centre or high coordinate edge, VipsAlign. + * * @param in2 Second input image. * @param direction Join left-right or up-down. * @param options Set of options. @@ -2201,6 +2683,16 @@ VImage join( VImage in2, VipsDirection direction, VOption *options = 0 ) const; /** * Load jpeg from file. + * + * **Optional parameters** + * - shrink -- Shrink factor on load, int. + * - autorotate -- Rotate image using exif orientation, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2209,6 +2701,16 @@ static VImage jpegload( const char *filename, VOption *options = 0 ); /** * Load jpeg from buffer. + * + * **Optional parameters** + * - shrink -- Shrink factor on load, int. + * - autorotate -- Rotate image using exif orientation, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -2217,6 +2719,16 @@ static VImage jpegload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load image from jpeg source. + * + * **Optional parameters** + * - shrink -- Shrink factor on load, int. + * - autorotate -- Rotate image using exif orientation, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -2225,6 +2737,22 @@ static VImage jpegload_source( VSource source, VOption *options = 0 ); /** * Save image to jpeg file. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - profile -- ICC profile to embed, const char *. + * - optimize_coding -- Compute optimal Huffman coding tables, bool. + * - interlace -- Generate an interlaced (progressive) jpeg, bool. + * - no_subsample -- Disable chroma subsample, bool. + * - trellis_quant -- Apply trellis quantisation to each 8x8 block, bool. + * - overshoot_deringing -- Apply overshooting to samples with extreme values, bool. + * - optimize_scans -- Split spectrum of DCT coefficients into separate scans, bool. + * - quant_table -- Use predefined quantization table with given index, int. + * - subsample_mode -- Select chroma subsample operation mode, VipsForeignJpegSubsample. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2232,6 +2760,22 @@ void jpegsave( const char *filename, VOption *options = 0 ) const; /** * Save image to jpeg buffer. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - profile -- ICC profile to embed, const char *. + * - optimize_coding -- Compute optimal Huffman coding tables, bool. + * - interlace -- Generate an interlaced (progressive) jpeg, bool. + * - no_subsample -- Disable chroma subsample, bool. + * - trellis_quant -- Apply trellis quantisation to each 8x8 block, bool. + * - overshoot_deringing -- Apply overshooting to samples with extreme values, bool. + * - optimize_scans -- Split spectrum of DCT coefficients into separate scans, bool. + * - quant_table -- Use predefined quantization table with given index, int. + * - subsample_mode -- Select chroma subsample operation mode, VipsForeignJpegSubsample. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -2239,12 +2783,44 @@ VipsBlob *jpegsave_buffer( VOption *options = 0 ) const; /** * Save image to jpeg mime. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - profile -- ICC profile to embed, const char *. + * - optimize_coding -- Compute optimal Huffman coding tables, bool. + * - interlace -- Generate an interlaced (progressive) jpeg, bool. + * - no_subsample -- Disable chroma subsample, bool. + * - trellis_quant -- Apply trellis quantisation to each 8x8 block, bool. + * - overshoot_deringing -- Apply overshooting to samples with extreme values, bool. + * - optimize_scans -- Split spectrum of DCT coefficients into separate scans, bool. + * - quant_table -- Use predefined quantization table with given index, int. + * - subsample_mode -- Select chroma subsample operation mode, VipsForeignJpegSubsample. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. */ void jpegsave_mime( VOption *options = 0 ) const; /** * Save image to jpeg target. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - profile -- ICC profile to embed, const char *. + * - optimize_coding -- Compute optimal Huffman coding tables, bool. + * - interlace -- Generate an interlaced (progressive) jpeg, bool. + * - no_subsample -- Disable chroma subsample, bool. + * - trellis_quant -- Apply trellis quantisation to each 8x8 block, bool. + * - overshoot_deringing -- Apply overshooting to samples with extreme values, bool. + * - optimize_scans -- Split spectrum of DCT coefficients into separate scans, bool. + * - quant_table -- Use predefined quantization table with given index, int. + * - subsample_mode -- Select chroma subsample operation mode, VipsForeignJpegSubsample. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -2259,6 +2835,10 @@ VImage labelregions( VOption *options = 0 ) const; /** * Calculate (a * in + b). + * + * **Optional parameters** + * - uchar -- Output should be uchar, bool. + * * @param a Multiply by this. * @param b Add this. * @param options Set of options. @@ -2268,6 +2848,13 @@ VImage linear( std::vector a, std::vector b, VOption *options = /** * Cache an image as a set of lines. + * + * **Optional parameters** + * - tile_height -- Tile height in pixels, int. + * - access -- Expected access pattern, VipsAccess. + * - threaded -- Allow threaded access, bool. + * - persistent -- Keep cache between evaluations, bool. + * * @param options Set of options. * @return Output image. */ @@ -2275,6 +2862,12 @@ VImage linecache( VOption *options = 0 ) const; /** * Make a laplacian of gaussian image. + * + * **Optional parameters** + * - separable -- Generate separable Logmatian, bool. + * - integer -- Generate integer Logmatian, bool. + * - precision -- Generate with this precision, VipsPrecision. + * * @param sigma Radius of Logmatian. * @param min_ampl Minimum amplitude of Logmatian. * @param options Set of options. @@ -2284,6 +2877,18 @@ static VImage logmat( double sigma, double min_ampl, VOption *options = 0 ); /** * Load file with imagemagick. + * + * **Optional parameters** + * - all_frames -- Read all frames from an image, bool. + * - density -- Canvas resolution for rendering vector formats like SVG, const char *. + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2292,6 +2897,18 @@ static VImage magickload( const char *filename, VOption *options = 0 ); /** * Load buffer with imagemagick. + * + * **Optional parameters** + * - all_frames -- Read all frames from an image, bool. + * - density -- Canvas resolution for rendering vector formats like SVG, const char *. + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -2300,6 +2917,16 @@ static VImage magickload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Save file with imagemagick. + * + * **Optional parameters** + * - format -- Format to save in, const char *. + * - quality -- Quality to use, int. + * - optimize_gif_frames -- Apply GIF frames optimization, bool. + * - optimize_gif_transparency -- Apply GIF transparency optimization, bool. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2307,6 +2934,16 @@ void magicksave( const char *filename, VOption *options = 0 ) const; /** * Save image to magick buffer. + * + * **Optional parameters** + * - format -- Format to save in, const char *. + * - quality -- Quality to use, int. + * - optimize_gif_frames -- Apply GIF frames optimization, bool. + * - optimize_gif_transparency -- Apply GIF transparency optimization, bool. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -2314,6 +2951,10 @@ VipsBlob *magicksave_buffer( VOption *options = 0 ) const; /** * Resample with a map image. + * + * **Optional parameters** + * - interpolate -- Interpolate pixels with this, . + * * @param index Index pixels with this. * @param options Set of options. * @return Output image. @@ -2322,6 +2963,10 @@ VImage mapim( VImage index, VOption *options = 0 ) const; /** * Map an image though a lut. + * + * **Optional parameters** + * - band -- apply one-band lut to this band of in, int. + * * @param lut Look-up table image. * @param options Set of options. * @return Output image. @@ -2330,6 +2975,13 @@ VImage maplut( VImage lut, VOption *options = 0 ) const; /** * Make a butterworth filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param order Filter order. @@ -2342,6 +2994,13 @@ static VImage mask_butterworth( int width, int height, double order, double freq /** * Make a butterworth_band filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param order Filter order. @@ -2356,6 +3015,13 @@ static VImage mask_butterworth_band( int width, int height, double order, double /** * Make a butterworth ring filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param order Filter order. @@ -2369,6 +3035,13 @@ static VImage mask_butterworth_ring( int width, int height, double order, double /** * Make fractal filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param fractal_dimension Fractal dimension. @@ -2379,6 +3052,13 @@ static VImage mask_fractal( int width, int height, double fractal_dimension, VOp /** * Make a gaussian filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param frequency_cutoff Frequency cutoff. @@ -2390,6 +3070,13 @@ static VImage mask_gaussian( int width, int height, double frequency_cutoff, dou /** * Make a gaussian filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param frequency_cutoff_x Frequency cutoff x. @@ -2403,6 +3090,13 @@ static VImage mask_gaussian_band( int width, int height, double frequency_cutoff /** * Make a gaussian ring filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param frequency_cutoff Frequency cutoff. @@ -2415,6 +3109,13 @@ static VImage mask_gaussian_ring( int width, int height, double frequency_cutoff /** * Make an ideal filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param frequency_cutoff Frequency cutoff. @@ -2425,6 +3126,13 @@ static VImage mask_ideal( int width, int height, double frequency_cutoff, VOptio /** * Make an ideal band filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param frequency_cutoff_x Frequency cutoff x. @@ -2437,6 +3145,13 @@ static VImage mask_ideal_band( int width, int height, double frequency_cutoff_x, /** * Make an ideal ring filter. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - nodc -- Remove DC component, bool. + * - reject -- Invert the sense of the filter, bool. + * - optical -- Rotate quadrants to optical space, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param frequency_cutoff Frequency cutoff. @@ -2448,6 +3163,13 @@ static VImage mask_ideal_ring( int width, int height, double frequency_cutoff, d /** * First-order match of two images. + * + * **Optional parameters** + * - hwindow -- Half window size, int. + * - harea -- Half area size, int. + * - search -- Search to improve tie-points, bool. + * - interpolate -- Interpolate pixels with this, . + * * @param sec Secondary image. * @param xr1 Position of first reference tie-point. * @param yr1 Position of first reference tie-point. @@ -2490,6 +3212,14 @@ VImage math2_const( VipsOperationMath2 math2, std::vector c, VOption *op /** * Load mat from file. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2505,6 +3235,14 @@ VImage matrixinvert( VOption *options = 0 ) const; /** * Load matrix. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2513,6 +3251,14 @@ static VImage matrixload( const char *filename, VOption *options = 0 ); /** * Load matrix. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -2521,12 +3267,24 @@ static VImage matrixload_source( VSource source, VOption *options = 0 ); /** * Print matrix. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. */ void matrixprint( VOption *options = 0 ) const; /** * Save image to matrix. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2534,6 +3292,12 @@ void matrixsave( const char *filename, VOption *options = 0 ) const; /** * Save image to matrix. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -2541,6 +3305,10 @@ void matrixsave_target( VTarget target, VOption *options = 0 ) const; /** * Find image maximum. + * + * **Optional parameters** + * - size -- Number of maximum values to find, int. + * * @param options Set of options. * @return Output value. */ @@ -2548,6 +3316,13 @@ double max( VOption *options = 0 ) const; /** * Measure a set of patches on a color chart. + * + * **Optional parameters** + * - left -- Left edge of extract area, int. + * - top -- Top edge of extract area, int. + * - width -- Width of extract area, int. + * - height -- Height of extract area, int. + * * @param h Number of patches across chart. * @param v Number of patches down chart. * @param options Set of options. @@ -2557,6 +3332,10 @@ VImage measure( int h, int v, VOption *options = 0 ) const; /** * Merge two images. + * + * **Optional parameters** + * - mblend -- Maximum blend size, int. + * * @param sec Secondary image. * @param direction Horizontal or vertical merge. * @param dx Horizontal displacement from sec to ref. @@ -2568,6 +3347,10 @@ VImage merge( VImage sec, VipsDirection direction, int dx, int dy, VOption *opti /** * Find image minimum. + * + * **Optional parameters** + * - size -- Number of minimum values to find, int. + * * @param options Set of options. * @return Output value. */ @@ -2584,6 +3367,13 @@ VImage morph( VImage mask, VipsOperationMorphology morph, VOption *options = 0 ) /** * Mosaic two images. + * + * **Optional parameters** + * - hwindow -- Half window size, int. + * - harea -- Half area size, int. + * - mblend -- Maximum blend size, int. + * - bandno -- Band to search for features on, int. + * * @param sec Secondary image. * @param direction Horizontal or vertical mosaic. * @param xref Position of reference tie-point. @@ -2597,6 +3387,15 @@ VImage mosaic( VImage sec, VipsDirection direction, int xref, int yref, int xsec /** * First-order mosaic of two images. + * + * **Optional parameters** + * - hwindow -- Half window size, int. + * - harea -- Half area size, int. + * - search -- Search to improve tie-points, bool. + * - interpolate -- Interpolate pixels with this, . + * - mblend -- Maximum blend size, int. + * - bandno -- Band to search for features on, int. + * * @param sec Secondary image. * @param direction Horizontal or vertical mosaic. * @param xr1 Position of first reference tie-point. @@ -2614,6 +3413,10 @@ VImage mosaic1( VImage sec, VipsDirection direction, int xr1, int yr1, int xs1, /** * Pick most-significant byte from an image. + * + * **Optional parameters** + * - band -- Band to msb, int. + * * @param options Set of options. * @return Output image. */ @@ -2629,6 +3432,14 @@ VImage multiply( VImage right, VOption *options = 0 ) const; /** * Load a nifti image. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2637,6 +3448,12 @@ static VImage niftiload( const char *filename, VOption *options = 0 ); /** * Save image to nifti file. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2644,6 +3461,14 @@ void niftisave( const char *filename, VOption *options = 0 ) const; /** * Load an openexr image. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2652,6 +3477,18 @@ static VImage openexrload( const char *filename, VOption *options = 0 ); /** * Load file with openslide. + * + * **Optional parameters** + * - attach_associated -- Attach all asssociated images, bool. + * - level -- Load this level from the file, int. + * - autocrop -- Crop to image bounds, bool. + * - associated -- Load this associated image, const char *. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2660,6 +3497,19 @@ static VImage openslideload( const char *filename, VOption *options = 0 ); /** * Load pdf from file. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - dpi -- Render at this DPI, double. + * - scale -- Scale output by this factor, double. + * - background -- Background value, std::vector. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2668,6 +3518,19 @@ static VImage pdfload( const char *filename, VOption *options = 0 ); /** * Load pdf from buffer. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - dpi -- Render at this DPI, double. + * - scale -- Scale output by this factor, double. + * - background -- Background value, std::vector. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -2676,6 +3539,19 @@ static VImage pdfload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load pdf from source. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - dpi -- Render at this DPI, double. + * - scale -- Scale output by this factor, double. + * - background -- Background value, std::vector. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -2692,6 +3568,11 @@ int percent( double percent, VOption *options = 0 ) const; /** * Make a perlin noise image. + * + * **Optional parameters** + * - cell_size -- Size of Perlin cells, int. + * - uchar -- Output an unsigned char image, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -2709,6 +3590,14 @@ VImage phasecor( VImage in2, VOption *options = 0 ) const; /** * Load png from file. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2717,6 +3606,14 @@ static VImage pngload( const char *filename, VOption *options = 0 ); /** * Load png from buffer. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -2725,6 +3622,14 @@ static VImage pngload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load png from source. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -2733,6 +3638,21 @@ static VImage pngload_source( VSource source, VOption *options = 0 ); /** * Save image to png file. + * + * **Optional parameters** + * - compression -- Compression factor, int. + * - interlace -- Interlace image, bool. + * - profile -- ICC profile to embed, const char *. + * - filter -- libpng row filter flag(s), int. + * - palette -- Quantise to 8bpp palette, bool. + * - colours -- Max number of palette colours, int. + * - Q -- Quantisation quality, int. + * - dither -- Amount of dithering, double. + * - bitdepth -- Write as a 1, 2, 4 or 8 bit image, int. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2740,6 +3660,21 @@ void pngsave( const char *filename, VOption *options = 0 ) const; /** * Save image to png buffer. + * + * **Optional parameters** + * - compression -- Compression factor, int. + * - interlace -- Interlace image, bool. + * - profile -- ICC profile to embed, const char *. + * - filter -- libpng row filter flag(s), int. + * - palette -- Quantise to 8bpp palette, bool. + * - colours -- Max number of palette colours, int. + * - Q -- Quantisation quality, int. + * - dither -- Amount of dithering, double. + * - bitdepth -- Write as a 1, 2, 4 or 8 bit image, int. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -2747,6 +3682,21 @@ VipsBlob *pngsave_buffer( VOption *options = 0 ) const; /** * Save image to target as png. + * + * **Optional parameters** + * - compression -- Compression factor, int. + * - interlace -- Interlace image, bool. + * - profile -- ICC profile to embed, const char *. + * - filter -- libpng row filter flag(s), int. + * - palette -- Quantise to 8bpp palette, bool. + * - colours -- Max number of palette colours, int. + * - Q -- Quantisation quality, int. + * - dither -- Amount of dithering, double. + * - bitdepth -- Write as a 1, 2, 4 or 8 bit image, int. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -2754,6 +3704,14 @@ void pngsave_target( VTarget target, VOption *options = 0 ) const; /** * Load ppm from file. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2762,6 +3720,14 @@ static VImage ppmload( const char *filename, VOption *options = 0 ); /** * Load ppm base class. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -2770,6 +3736,15 @@ static VImage ppmload_source( VSource source, VOption *options = 0 ); /** * Save image to ppm file. + * + * **Optional parameters** + * - ascii -- save as ascii, bool. + * - squash -- save as one bit, bool. + * - bitdepth -- Write as a 1 bit image, int. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2777,6 +3752,15 @@ void ppmsave( const char *filename, VOption *options = 0 ) const; /** * Save to ppm. + * + * **Optional parameters** + * - ascii -- save as ascii, bool. + * - squash -- save as one bit, bool. + * - bitdepth -- Write as a 1 bit image, int. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -2784,6 +3768,10 @@ void ppmsave_target( VTarget target, VOption *options = 0 ) const; /** * Premultiply image alpha. + * + * **Optional parameters** + * - max_alpha -- Maximum value of alpha channel, double. + * * @param options Set of options. * @return Output image. */ @@ -2815,6 +3803,10 @@ VImage project( VImage *rows, VOption *options = 0 ) const; /** * Resample an image with a quadratic transform. + * + * **Optional parameters** + * - interpolate -- Interpolate values with this, . + * * @param coeff Coefficient matrix. * @param options Set of options. * @return Output image. @@ -2830,6 +3822,14 @@ VImage rad2float( VOption *options = 0 ) const; /** * Load a radiance image from a file. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -2838,6 +3838,14 @@ static VImage radload( const char *filename, VOption *options = 0 ); /** * Load rad from buffer. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -2846,6 +3854,14 @@ static VImage radload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load rad from source. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -2854,6 +3870,12 @@ static VImage radload_source( VSource source, VOption *options = 0 ); /** * Save image to radiance file. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2861,6 +3883,12 @@ void radsave( const char *filename, VOption *options = 0 ) const; /** * Save image to radiance buffer. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -2868,6 +3896,12 @@ VipsBlob *radsave_buffer( VOption *options = 0 ) const; /** * Save image to radiance target. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -2885,6 +3919,17 @@ VImage rank( int width, int height, int index, VOption *options = 0 ) const; /** * Load raw data from a file. + * + * **Optional parameters** + * - offset -- Offset in bytes from start of file, . + * - format -- Pixel format in image, VipsBandFormat. + * - interpretation -- Pixel interpretation, VipsInterpretation. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param width Image width in pixels. * @param height Image height in pixels. @@ -2896,6 +3941,12 @@ static VImage rawload( const char *filename, int width, int height, int bands, V /** * Save image to raw file. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -2903,6 +3954,12 @@ void rawsave( const char *filename, VOption *options = 0 ) const; /** * Write raw image to file descriptor. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param fd File descriptor to write to. * @param options Set of options. */ @@ -2918,6 +3975,11 @@ VImage recomb( VImage m, VOption *options = 0 ) const; /** * Reduce an image. + * + * **Optional parameters** + * - kernel -- Resampling kernel, VipsKernel. + * - centre -- Use centre sampling convention, bool. + * * @param hshrink Horizontal shrink factor. * @param vshrink Vertical shrink factor. * @param options Set of options. @@ -2927,6 +3989,11 @@ VImage reduce( double hshrink, double vshrink, VOption *options = 0 ) const; /** * Shrink an image horizontally. + * + * **Optional parameters** + * - kernel -- Resampling kernel, VipsKernel. + * - centre -- Use centre sampling convention, bool. + * * @param hshrink Horizontal shrink factor. * @param options Set of options. * @return Output image. @@ -2935,6 +4002,11 @@ VImage reduceh( double hshrink, VOption *options = 0 ) const; /** * Shrink an image vertically. + * + * **Optional parameters** + * - kernel -- Resampling kernel, VipsKernel. + * - centre -- Use centre sampling convention, bool. + * * @param vshrink Vertical shrink factor. * @param options Set of options. * @return Output image. @@ -2986,6 +4058,15 @@ VImage replicate( int across, int down, VOption *options = 0 ) const; /** * Resize an image. + * + * **Optional parameters** + * - interpolate -- Interpolate pixels with this, . + * - kernel -- Resampling kernel, VipsKernel. + * - centre -- Use centre sampling convention, bool. + * - vscale -- Vertical scale image by this factor, double. + * - idx -- Horizontal input displacement, double. + * - idy -- Vertical input displacement, double. + * * @param scale Scale image by this factor. * @param options Set of options. * @return Output image. @@ -3002,6 +4083,10 @@ VImage rot( VipsAngle angle, VOption *options = 0 ) const; /** * Rotate an image. + * + * **Optional parameters** + * - angle -- Angle to rotate image, VipsAngle45. + * * @param options Set of options. * @return Output image. */ @@ -3009,6 +4094,15 @@ VImage rot45( VOption *options = 0 ) const; /** * Rotate an image by a number of degrees. + * + * **Optional parameters** + * - interpolate -- Interpolate pixels with this, . + * - background -- Background value, std::vector. + * - odx -- Horizontal output displacement, double. + * - ody -- Vertical output displacement, double. + * - idx -- Horizontal input displacement, double. + * - idy -- Vertical input displacement, double. + * * @param angle Rotate anticlockwise by this many degrees. * @param options Set of options. * @return Output image. @@ -3039,6 +4133,10 @@ VImage sRGB2scRGB( VOption *options = 0 ) const; /** * Convert scrgb to bw. + * + * **Optional parameters** + * - depth -- Output device space depth in bits, int. + * * @param options Set of options. * @return Output image. */ @@ -3053,6 +4151,10 @@ VImage scRGB2XYZ( VOption *options = 0 ) const; /** * Convert an scrgb image to srgb. + * + * **Optional parameters** + * - depth -- Output device space depth in bits, int. + * * @param options Set of options. * @return Output image. */ @@ -3060,6 +4162,11 @@ VImage scRGB2sRGB( VOption *options = 0 ) const; /** * Scale an image to uchar. + * + * **Optional parameters** + * - exp -- Exponent for log scale, double. + * - log -- Log scale, bool. + * * @param options Set of options. * @return Output image. */ @@ -3067,6 +4174,12 @@ VImage scale( VOption *options = 0 ) const; /** * Check sequential access. + * + * **Optional parameters** + * - trace -- trace pixel requests, bool. + * - tile_height -- Tile height in pixels, int. + * - access -- Expected access pattern, VipsAccess. + * * @param options Set of options. * @return Output image. */ @@ -3074,6 +4187,16 @@ VImage sequential( VOption *options = 0 ) const; /** * Unsharp masking for print. + * + * **Optional parameters** + * - radius -- radius of Gaussian, int. + * - sigma -- Sigma of Gaussian, double. + * - x1 -- Flat/jaggy threshold, double. + * - y2 -- Maximum brightening, double. + * - y3 -- Maximum darkening, double. + * - m1 -- Slope for flat areas, double. + * - m2 -- Slope for jaggy areas, double. + * * @param options Set of options. * @return Output image. */ @@ -3113,6 +4236,17 @@ VImage sign( VOption *options = 0 ) const; /** * Similarity transform of an image. + * + * **Optional parameters** + * - scale -- Scale by this factor, double. + * - angle -- Rotate anticlockwise by this many degrees, double. + * - interpolate -- Interpolate pixels with this, . + * - background -- Background value, std::vector. + * - odx -- Horizontal output displacement, double. + * - ody -- Vertical output displacement, double. + * - idx -- Horizontal input displacement, double. + * - idy -- Vertical input displacement, double. + * * @param options Set of options. * @return Output image. */ @@ -3120,6 +4254,12 @@ VImage similarity( VOption *options = 0 ) const; /** * Make a 2d sine wave. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * - hfreq -- Horizontal spatial frequency, double. + * - vfreq -- Vertical spatial frequency, double. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -3129,6 +4269,10 @@ static VImage sines( int width, int height, VOption *options = 0 ); /** * Extract an area from an image. + * + * **Optional parameters** + * - interesting -- How to measure interestingness, VipsInteresting. + * * @param width Width of extract area. * @param height Height of extract area. * @param options Set of options. @@ -3167,6 +4311,13 @@ VImage stats( VOption *options = 0 ) const; /** * Statistical difference. + * + * **Optional parameters** + * - s0 -- New deviation, double. + * - b -- Weight of new deviation, double. + * - m0 -- New mean, double. + * - a -- Weight of new mean, double. + * * @param width Window width in pixels. * @param height Window height in pixels. * @param options Set of options. @@ -3176,6 +4327,10 @@ VImage stdif( int width, int height, VOption *options = 0 ) const; /** * Subsample an image. + * + * **Optional parameters** + * - point -- Point sample, bool. + * * @param xfac Horizontal subsample factor. * @param yfac Vertical subsample factor. * @param options Set of options. @@ -3201,6 +4356,17 @@ static VImage sum( std::vector in, VOption *options = 0 ); /** * Load svg with rsvg. + * + * **Optional parameters** + * - dpi -- Render at this DPI, double. + * - scale -- Scale output by this factor, double. + * - unlimited -- Allow SVG of any size, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -3209,6 +4375,17 @@ static VImage svgload( const char *filename, VOption *options = 0 ); /** * Load svg with rsvg. + * + * **Optional parameters** + * - dpi -- Render at this DPI, double. + * - scale -- Scale output by this factor, double. + * - unlimited -- Allow SVG of any size, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -3217,6 +4394,17 @@ static VImage svgload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load svg from source. + * + * **Optional parameters** + * - dpi -- Render at this DPI, double. + * - scale -- Scale output by this factor, double. + * - unlimited -- Allow SVG of any size, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -3233,6 +4421,12 @@ static VImage switch_image( std::vector tests, VOption *options = 0 ); /** * Run an external command. + * + * **Optional parameters** + * - in -- Array of input images, std::vector. + * - out_format -- Format for output filename, const char *. + * - in_format -- Format for input filename, const char *. + * * @param cmd_format Command to run. * @param options Set of options. */ @@ -3240,6 +4434,17 @@ static void system( const char *cmd_format, VOption *options = 0 ); /** * Make a text image. + * + * **Optional parameters** + * - font -- Font to render with, const char *. + * - width -- Maximum image width in pixels, int. + * - height -- Maximum image height in pixels, int. + * - align -- Align on the low, centre or high edge, VipsAlign. + * - dpi -- DPI to render at, int. + * - justify -- Justify lines, bool. + * - spacing -- Line spacing, int. + * - fontfile -- Load this font file, const char *. + * * @param text Text to render. * @param options Set of options. * @return Output image. @@ -3248,6 +4453,18 @@ static VImage text( const char *text, VOption *options = 0 ); /** * Generate thumbnail from file. + * + * **Optional parameters** + * - height -- Size to this height, int. + * - size -- Only upsize, only downsize, or both, VipsSize. + * - no_rotate -- Don't use orientation tags to rotate image upright, bool. + * - crop -- Reduce to fill target rectangle, then crop, VipsInteresting. + * - linear -- Reduce in linear light, bool. + * - import_profile -- Fallback import profile, const char *. + * - export_profile -- Fallback export profile, const char *. + * - intent -- Rendering intent, VipsIntent. + * - auto_rotate -- Use orientation tags to rotate image upright, bool. + * * @param filename Filename to read from. * @param width Size to this width. * @param options Set of options. @@ -3257,6 +4474,19 @@ static VImage thumbnail( const char *filename, int width, VOption *options = 0 ) /** * Generate thumbnail from buffer. + * + * **Optional parameters** + * - option_string -- Options that are passed on to the underlying loader, const char *. + * - height -- Size to this height, int. + * - size -- Only upsize, only downsize, or both, VipsSize. + * - no_rotate -- Don't use orientation tags to rotate image upright, bool. + * - crop -- Reduce to fill target rectangle, then crop, VipsInteresting. + * - linear -- Reduce in linear light, bool. + * - import_profile -- Fallback import profile, const char *. + * - export_profile -- Fallback export profile, const char *. + * - intent -- Rendering intent, VipsIntent. + * - auto_rotate -- Use orientation tags to rotate image upright, bool. + * * @param buffer Buffer to load from. * @param width Size to this width. * @param options Set of options. @@ -3266,6 +4496,18 @@ static VImage thumbnail_buffer( VipsBlob *buffer, int width, VOption *options = /** * Generate thumbnail from image. + * + * **Optional parameters** + * - height -- Size to this height, int. + * - size -- Only upsize, only downsize, or both, VipsSize. + * - no_rotate -- Don't use orientation tags to rotate image upright, bool. + * - crop -- Reduce to fill target rectangle, then crop, VipsInteresting. + * - linear -- Reduce in linear light, bool. + * - import_profile -- Fallback import profile, const char *. + * - export_profile -- Fallback export profile, const char *. + * - intent -- Rendering intent, VipsIntent. + * - auto_rotate -- Use orientation tags to rotate image upright, bool. + * * @param width Size to this width. * @param options Set of options. * @return Output image. @@ -3274,6 +4516,19 @@ VImage thumbnail_image( int width, VOption *options = 0 ) const; /** * Generate thumbnail from source. + * + * **Optional parameters** + * - option_string -- Options that are passed on to the underlying loader, const char *. + * - height -- Size to this height, int. + * - size -- Only upsize, only downsize, or both, VipsSize. + * - no_rotate -- Don't use orientation tags to rotate image upright, bool. + * - crop -- Reduce to fill target rectangle, then crop, VipsInteresting. + * - linear -- Reduce in linear light, bool. + * - import_profile -- Fallback import profile, const char *. + * - export_profile -- Fallback export profile, const char *. + * - intent -- Rendering intent, VipsIntent. + * - auto_rotate -- Use orientation tags to rotate image upright, bool. + * * @param source Source to load from. * @param width Size to this width. * @param options Set of options. @@ -3283,6 +4538,18 @@ static VImage thumbnail_source( VSource source, int width, VOption *options = 0 /** * Load tiff from file. + * + * **Optional parameters** + * - page -- Load this page from the image, int. + * - subifd -- Select subifd index, int. + * - n -- Load this many pages, int. + * - autorotate -- Rotate image using orientation tag, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -3291,6 +4558,18 @@ static VImage tiffload( const char *filename, VOption *options = 0 ); /** * Load tiff from buffer. + * + * **Optional parameters** + * - page -- Load this page from the image, int. + * - subifd -- Select subifd index, int. + * - n -- Load this many pages, int. + * - autorotate -- Rotate image using orientation tag, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -3299,6 +4578,18 @@ static VImage tiffload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load tiff from source. + * + * **Optional parameters** + * - page -- Load this page from the image, int. + * - subifd -- Select subifd index, int. + * - n -- Load this many pages, int. + * - autorotate -- Rotate image using orientation tag, bool. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -3307,6 +4598,34 @@ static VImage tiffload_source( VSource source, VOption *options = 0 ); /** * Save image to tiff file. + * + * **Optional parameters** + * - compression -- Compression for this file, VipsForeignTiffCompression. + * - Q -- Q factor, int. + * - predictor -- Compression prediction, VipsForeignTiffPredictor. + * - profile -- ICC profile to embed, const char *. + * - tile -- Write a tiled tiff, bool. + * - tile_width -- Tile width in pixels, int. + * - tile_height -- Tile height in pixels, int. + * - pyramid -- Write a pyramidal tiff, bool. + * - squash -- Squash images down to 1 bit, bool. + * - miniswhite -- Use 0 for white in 1-bit images, bool. + * - bitdepth -- Write as a 1, 2, 4 or 8 bit image, int. + * - resunit -- Resolution unit, VipsForeignTiffResunit. + * - xres -- Horizontal resolution in pixels/mm, double. + * - yres -- Vertical resolution in pixels/mm, double. + * - bigtiff -- Write a bigtiff image, bool. + * - rgbjpeg -- Output RGB JPEG rather than YCbCr, bool. + * - properties -- Write a properties document to IMAGEDESCRIPTION, bool. + * - region_shrink -- Method to shrink regions, VipsRegionShrink. + * - level -- ZSTD compression level, int. + * - subifd -- Save pyr layers as sub-IFDs, bool. + * - lossless -- Enable WEBP lossless mode, bool. + * - depth -- Pyramid depth, VipsForeignDzDepth. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -3314,6 +4633,34 @@ void tiffsave( const char *filename, VOption *options = 0 ) const; /** * Save image to tiff buffer. + * + * **Optional parameters** + * - compression -- Compression for this file, VipsForeignTiffCompression. + * - Q -- Q factor, int. + * - predictor -- Compression prediction, VipsForeignTiffPredictor. + * - profile -- ICC profile to embed, const char *. + * - tile -- Write a tiled tiff, bool. + * - tile_width -- Tile width in pixels, int. + * - tile_height -- Tile height in pixels, int. + * - pyramid -- Write a pyramidal tiff, bool. + * - squash -- Squash images down to 1 bit, bool. + * - miniswhite -- Use 0 for white in 1-bit images, bool. + * - bitdepth -- Write as a 1, 2, 4 or 8 bit image, int. + * - resunit -- Resolution unit, VipsForeignTiffResunit. + * - xres -- Horizontal resolution in pixels/mm, double. + * - yres -- Vertical resolution in pixels/mm, double. + * - bigtiff -- Write a bigtiff image, bool. + * - rgbjpeg -- Output RGB JPEG rather than YCbCr, bool. + * - properties -- Write a properties document to IMAGEDESCRIPTION, bool. + * - region_shrink -- Method to shrink regions, VipsRegionShrink. + * - level -- ZSTD compression level, int. + * - subifd -- Save pyr layers as sub-IFDs, bool. + * - lossless -- Enable WEBP lossless mode, bool. + * - depth -- Pyramid depth, VipsForeignDzDepth. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -3321,6 +4668,15 @@ VipsBlob *tiffsave_buffer( VOption *options = 0 ) const; /** * Cache an image as a set of tiles. + * + * **Optional parameters** + * - tile_width -- Tile width in pixels, int. + * - tile_height -- Tile height in pixels, int. + * - max_tiles -- Maximum number of tiles to cache, int. + * - access -- Expected access pattern, VipsAccess. + * - threaded -- Allow threaded access, bool. + * - persistent -- Keep cache between evaluations, bool. + * * @param options Set of options. * @return Output image. */ @@ -3328,6 +4684,19 @@ VImage tilecache( VOption *options = 0 ) const; /** * Build a look-up table. + * + * **Optional parameters** + * - in_max -- Size of LUT to build, int. + * - out_max -- Maximum value in output LUT, int. + * - Lb -- Lowest value in output, double. + * - Lw -- Highest value in output, double. + * - Ps -- Position of shadow, double. + * - Pm -- Position of mid-tones, double. + * - Ph -- Position of highlights, double. + * - S -- Adjust shadows by this much, double. + * - M -- Adjust mid-tones by this much, double. + * - H -- Adjust highlights by this much, double. + * * @param options Set of options. * @return Output image. */ @@ -3335,6 +4704,10 @@ static VImage tonelut( VOption *options = 0 ); /** * Transpose3d an image. + * + * **Optional parameters** + * - page_height -- Height of each input page, int. + * * @param options Set of options. * @return Output image. */ @@ -3342,6 +4715,11 @@ VImage transpose3d( VOption *options = 0 ) const; /** * Unpremultiply image alpha. + * + * **Optional parameters** + * - max_alpha -- Maximum value of alpha channel, double. + * - alpha_band -- Unpremultiply with this alpha, int. + * * @param options Set of options. * @return Output image. */ @@ -3349,6 +4727,14 @@ VImage unpremultiply( VOption *options = 0 ) const; /** * Load vips from file. + * + * **Optional parameters** + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -3357,6 +4743,12 @@ static VImage vipsload( const char *filename, VOption *options = 0 ); /** * Save image to vips file. + * + * **Optional parameters** + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -3364,6 +4756,18 @@ void vipssave( const char *filename, VOption *options = 0 ) const; /** * Load webp from file. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - scale -- Scale factor on load, double. + * - shrink -- Shrink factor on load, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param filename Filename to load from. * @param options Set of options. * @return Output image. @@ -3372,6 +4776,18 @@ static VImage webpload( const char *filename, VOption *options = 0 ); /** * Load webp from buffer. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - scale -- Scale factor on load, double. + * - shrink -- Shrink factor on load, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param buffer Buffer to load from. * @param options Set of options. * @return Output image. @@ -3380,6 +4796,18 @@ static VImage webpload_buffer( VipsBlob *buffer, VOption *options = 0 ); /** * Load webp from source. + * + * **Optional parameters** + * - page -- Load this page from the file, int. + * - n -- Load this many pages, int. + * - scale -- Scale factor on load, double. + * - shrink -- Shrink factor on load, int. + * - memory -- Force open via memory, bool. + * - access -- Required access pattern for this file, VipsAccess. + * - sequential -- Sequential read only, bool. + * - fail -- Fail on first error, bool. + * - disc -- Open to disc, bool. + * * @param source Source to load from. * @param options Set of options. * @return Output image. @@ -3388,6 +4816,23 @@ static VImage webpload_source( VSource source, VOption *options = 0 ); /** * Save image to webp file. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - lossless -- enable lossless compression, bool. + * - preset -- Preset for lossy compression, VipsForeignWebpPreset. + * - smart_subsample -- Enable high quality chroma subsampling, bool. + * - near_lossless -- Enable preprocessing in lossless mode (uses Q), bool. + * - alpha_q -- Change alpha plane fidelity for lossy compression, int. + * - min_size -- Optimise for minium size, bool. + * - kmin -- Minimum number of frames between key frames, int. + * - kmax -- Maximum number of frames between key frames, int. + * - reduction_effort -- Level of CPU effort to reduce file size, int. + * - profile -- ICC profile to embed, const char *. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param filename Filename to save to. * @param options Set of options. */ @@ -3395,6 +4840,23 @@ void webpsave( const char *filename, VOption *options = 0 ) const; /** * Save image to webp buffer. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - lossless -- enable lossless compression, bool. + * - preset -- Preset for lossy compression, VipsForeignWebpPreset. + * - smart_subsample -- Enable high quality chroma subsampling, bool. + * - near_lossless -- Enable preprocessing in lossless mode (uses Q), bool. + * - alpha_q -- Change alpha plane fidelity for lossy compression, int. + * - min_size -- Optimise for minium size, bool. + * - kmin -- Minimum number of frames between key frames, int. + * - kmax -- Maximum number of frames between key frames, int. + * - reduction_effort -- Level of CPU effort to reduce file size, int. + * - profile -- ICC profile to embed, const char *. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param options Set of options. * @return Buffer to save to. */ @@ -3402,6 +4864,23 @@ VipsBlob *webpsave_buffer( VOption *options = 0 ) const; /** * Save image to webp target. + * + * **Optional parameters** + * - Q -- Q factor, int. + * - lossless -- enable lossless compression, bool. + * - preset -- Preset for lossy compression, VipsForeignWebpPreset. + * - smart_subsample -- Enable high quality chroma subsampling, bool. + * - near_lossless -- Enable preprocessing in lossless mode (uses Q), bool. + * - alpha_q -- Change alpha plane fidelity for lossy compression, int. + * - min_size -- Optimise for minium size, bool. + * - kmin -- Minimum number of frames between key frames, int. + * - kmax -- Maximum number of frames between key frames, int. + * - reduction_effort -- Level of CPU effort to reduce file size, int. + * - profile -- ICC profile to embed, const char *. + * - strip -- Strip all metadata from image, bool. + * - background -- Background value, std::vector. + * - page_height -- Set page height for multipage save, int. + * * @param target Target to save to. * @param options Set of options. */ @@ -3409,6 +4888,10 @@ void webpsave_target( VTarget target, VOption *options = 0 ) const; /** * Make a worley noise image. + * + * **Optional parameters** + * - cell_size -- Size of Worley cells, int. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -3418,6 +4901,11 @@ static VImage worley( int width, int height, VOption *options = 0 ); /** * Wrap image origin. + * + * **Optional parameters** + * - x -- Left edge of input in output, int. + * - y -- Top edge of input in output, int. + * * @param options Set of options. * @return Output image. */ @@ -3425,6 +4913,12 @@ VImage wrap( VOption *options = 0 ) const; /** * Make an image where pixel values are coordinates. + * + * **Optional parameters** + * - csize -- Size of third dimension, int. + * - dsize -- Size of fourth dimension, int. + * - esize -- Size of fifth dimension, int. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options. @@ -3434,6 +4928,10 @@ static VImage xyz( int width, int height, VOption *options = 0 ); /** * Make a zone plate. + * + * **Optional parameters** + * - uchar -- Output an unsigned char image, bool. + * * @param width Image width in pixels. * @param height Image height in pixels. * @param options Set of options.