vips_format_sizeof ()

guint64vips_format_sizeof (VipsBandFormat format);

vips_format_sizeof_unsafe ()

guint64vips_format_sizeof_unsafe (VipsBandFormat format);

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

[skip]

vips_interpretation_max_alpha ()

doublevips_interpretation_max_alpha (VipsInterpretation interpretation);

vips_image_get_width ()

intvips_image_get_width (constVipsImage *image);

vips_image_get_height ()

intvips_image_get_height (constVipsImage *image);

vips_image_get_bands ()

intvips_image_get_bands (constVipsImage *image);

vips_image_get_format ()

VipsBandFormatvips_image_get_format (constVipsImage *image);

vips_image_get_format_max ()

doublevips_image_get_format_max (VipsBandFormat format);

vips_image_guess_format ()

VipsBandFormatvips_image_guess_format (constVipsImage *image);

Return theVipsBandFormat for an image, guessing a sane value ifthe set value looks crazy.

For example, for a float image tagged as rgb16, we'd return ushort.

vips_image_get_coding ()

VipsCodingvips_image_get_coding (constVipsImage *image);

vips_image_get_interpretation ()

VipsInterpretationvips_image_get_interpretation (constVipsImage *image);

Return theVipsInterpretation set in the image header.Usevips_image_guess_interpretation() if you want a sanity-checked value.

vips_image_guess_interpretation ()

VipsInterpretationvips_image_guess_interpretation (constVipsImage *image);

Return theVipsInterpretation for an image, guessing a sane value ifthe set value looks crazy.

vips_image_get_xres ()

doublevips_image_get_xres (constVipsImage *image);

vips_image_get_yres ()

doublevips_image_get_yres (constVipsImage *image);

vips_image_get_xoffset ()

intvips_image_get_xoffset (constVipsImage *image);

vips_image_get_yoffset ()

intvips_image_get_yoffset (constVipsImage *image);

vips_image_get_filename ()

constchar *vips_image_get_filename (constVipsImage *image);

vips_image_get_mode ()

constchar *vips_image_get_mode (constVipsImage *image);

Image modes are things like"t", meaning a memory buffer, and"p"meaning a delayed computation.

vips_image_get_scale ()

doublevips_image_get_scale (constVipsImage *image);

Matrix images can have an optionalscale field for use by integerconvolution.

vips_image_get_offset ()

doublevips_image_get_offset (constVipsImage *image);

Matrix images can have an optionaloffset field for use by integerconvolution.

vips_image_get_page_height ()

intvips_image_get_page_height (VipsImage *image);

Multi-page images can have a page height. Fetch it, and sanity check it. Ifpage-height is not set, it defaults to the image height.

vips_image_get_n_pages ()

intvips_image_get_n_pages (VipsImage *image);

Fetch and sanity-checkVIPS_META_N_PAGES. Default to 1 if not present orcrazy.

This is the number of pages in the image file, not the number of pages thathave been loaded intoimage.

vips_image_get_n_subifds ()

intvips_image_get_n_subifds (VipsImage *image);

Fetch and sanity-checkVIPS_META_N_SUBIFDS. Default to 0 if not present orcrazy.

vips_image_get_orientation ()

intvips_image_get_orientation (VipsImage *image);

Fetch and sanity-checkVIPS_META_ORIENTATION. Default to 1 (no rotate,no flip) if not present or crazy.

vips_image_get_orientation_swap ()

gbooleanvips_image_get_orientation_swap (VipsImage *image);

ReturnTRUE if applying the orientation would swap width and height.

vips_image_get_concurrency ()

intvips_image_get_concurrency (VipsImage *image,int default_concurrency);

Fetch and sanity-checkVIPS_CONCURRENCY. Default to 1 if not present orcrazy.

vips_image_get_data ()

constvoid *vips_image_get_data (VipsImage *image);

Return a pointer to the image's pixel data, if possible. This can involveallocating large amounts of memory and performing a long computation. Imagepixels are laid out in band-packed rows.

Since this function modifiesimage, it is not threadsafe. Only call it onimages which you are sure have not been shared with another thread.

See also:vips_image_wio_input(),vips_image_copy_memory().

vips_image_init_fields ()

voidvips_image_init_fields (VipsImage *image,int xsize,int ysize,int bands,VipsBandFormat format,VipsCoding coding,VipsInterpretation interpretation,double xres,double yres);

A convenience function to set the header fields after creating an image.Normally you copy the fields from your input images withvips_image_pipelinev() and then makeany adjustments you need, but if you are creating an image from scratch,for examplevips_black() orvips_jpegload(), you do need to set all thefields yourself.

See also:vips_image_pipelinev().

vips_image_set ()

voidvips_image_set (VipsImage *image,constchar *name,GValue *value);

Set a piece of metadata onimage. Any old metadata with that name isdestroyed. TheGValue is copied into the image, so you need to unset thevalue when you're done with it.

For example, to set an integer on an image (though you would use theconvenience functionvips_image_set_int() in practice), you would do:

123456

GValuevalue=G_VALUE_INIT;g_value_init(&value,G_TYPE_INT);g_value_set_int(&value,42);vips_image_set(image,name,&value);g_value_unset(&value);

See also:vips_image_get().

vips_image_get ()

intvips_image_get (constVipsImage *image,constchar *name,GValue *value_copy);

Fillvalue_copy with a copy of the header field.value_copy must be zeroedbut uninitialised.

This will return -1 and add a message to the error buffer if the fielddoes not exist. Usevips_image_get_typeof() to test for theexistence of a field first if you are not certain it will be there.

For example, to read a double from an image (though of course you would usevips_image_get_double() in practice):

1234567891011121314151617

GValuevalue=G_VALUE_INIT;doubled;if(vips_image_get(image,name,&value))return-1;if(G_VALUE_TYPE(&value)!=G_TYPE_DOUBLE){vips_error("mydomain",_("field\"%s\" is of type %s, not double"),name,g_type_name(G_VALUE_TYPE(&value)));g_value_unset(&value);return-1;}d=g_value_get_double(&value);g_value_unset(&value);

See also:vips_image_get_typeof(),vips_image_get_double().

vips_image_get_as_string ()

intvips_image_get_as_string (constVipsImage *image,constchar *name,char **out);

Returnsname fromimage inout.This function will read any field, returning it as a printable string.You need to free the string withg_free() when you are done with it.

This will base64-encode BLOBs, for example. Usevips_buf_appendgv() tomake a string that's for humans.

See also:vips_image_get(),vips_image_get_typeof(),vips_buf_appendgv().

vips_image_get_typeof ()

GTypevips_image_get_typeof (constVipsImage *image,constchar *name);

Read theGType for a header field. Returns zero if there is nofield of that name.

See also:vips_image_get().

vips_image_remove ()

gbooleanvips_image_remove (VipsImage *image,constchar *name);

Find and remove an item of metadata. ReturnFALSE if no metadata of thatname was found.

See also:vips_image_set(),vips_image_get_typeof().

VipsImageMapFn ()

void *(*VipsImageMapFn) (VipsImage *image,constchar *name,GValue *value,void *a);

vips_image_map ()

void *vips_image_map (VipsImage *image,VipsImageMapFn fn,void *a);

This function callsfn for every header field, including every item ofmetadata.

Like all _map functions, the user function should returnNULL to continueiteration, or a non-NULL pointer to indicate early termination.

See also:vips_image_get_typeof(),vips_image_get().

vips_image_get_fields ()

gchar **vips_image_get_fields (VipsImage *image);

Get aNULL-terminated array listing all the metadata field names onimage.Free the return result withg_strfreev().

This is handy for language bindings. From C, it's usually more convenient tousevips_image_map().

vips_image_set_area ()

voidvips_image_set_area (VipsImage *image,constchar *name,VipsCallbackFn free_fn,void *data);

Attachesdata as a metadata item onimage under the namename. WhenVIPS no longer needs the metadata, it will be freed withfree_fn.

See also:vips_image_get_double(),vips_image_set()

vips_image_get_area ()

intvips_image_get_area (constVipsImage *image,constchar *name,constvoid **data);

Getsdata fromimage under the namename. A conveniencefunction overvips_image_get(). Usevips_image_get_typeof() to test forthe existence of a piece of metadata.

See also:vips_image_set_area(),vips_image_get(),vips_image_get_typeof()

vips_image_set_blob ()

voidvips_image_set_blob (VipsImage *image,constchar *name,VipsCallbackFn free_fn,constvoid *data,size_t length);

Attachesdata as a metadata item onimage under the namename.

See also:vips_image_get_blob(),vips_image_set().

vips_image_set_blob_copy ()

voidvips_image_set_blob_copy (VipsImage *image,constchar *name,constvoid *data,size_t length);

Attachesdata as a metadata item onimage under the namename, takinga copy of the memory area.

See also:vips_image_get_blob(),vips_image_set().

vips_image_get_blob ()

intvips_image_get_blob (constVipsImage *image,constchar *name,constvoid **data,size_t *length);

Getsdata fromimage under the namename, optionally returns itslength inlength. Usevips_image_get_typeof() to test for the existenceof a piece of metadata.

See also:vips_image_get(),vips_image_get_typeof(),vips_blob_get(),

vips_image_get_int ()

intvips_image_get_int (constVipsImage *image,constchar *name,int *out);

Getsout fromim under the namename.The value will be transformed intoan int, if possible.

See also:vips_image_get(),vips_image_get_typeof()

vips_image_set_int ()

voidvips_image_set_int (VipsImage *image,constchar *name,int i);

Attachesi as a metadata item onimage under the namename. Aconveniencefunction overvips_image_set().

See also:vips_image_get_int(),vips_image_set()

vips_image_get_double ()

intvips_image_get_double (constVipsImage *image,constchar *name,double *out);

Getsout fromim under the namename.The value will be transformed intoa double, if possible.

See also:vips_image_get(),vips_image_get_typeof()

vips_image_set_double ()

voidvips_image_set_double (VipsImage *image,constchar *name,double d);

Attachesd as a metadata item onimage asname. Aconveniencefunction overvips_image_set().

See also:vips_image_get_double(),vips_image_set()

vips_image_get_string ()

intvips_image_get_string (constVipsImage *image,constchar *name,constchar **out);

Getsout fromim under the namename.The field must be of typeG_TYPE_STRING, VIPS_TYPE_REF_STRING.

Do not freeout.

Usevips_image_get_as_string() to fetch any field as a string.

See also:vips_image_get(),vips_image_get_typeof()

vips_image_set_string ()

voidvips_image_set_string (VipsImage *image,constchar *name,constchar *str);

Attachesstr as a metadata item onimage asname.A conveniencefunction overvips_image_set() usingVIPS_TYPE_REF_STRING.

See also:vips_image_get_double(),vips_image_set().

vips_image_print_field ()

voidvips_image_print_field (constVipsImage *image,constchar *name);

Prints fieldname to stdout as ASCII. Handy for debugging.

vips_image_get_image ()

intvips_image_get_image (constVipsImage *image,constchar *name,VipsImage **out);

Getsout fromim under the namename.The field must be of typeVIPS_TYPE_IMAGE. You must unrefout withg_object_unref().

Usevips_image_get_typeof() to test for theexistence of a piece of metadata.

See also:vips_image_get(),vips_image_set_image()

vips_image_set_image ()

voidvips_image_set_image (VipsImage *image,constchar *name,VipsImage *im);

Attachesim as a metadata item onimage asname.A convenience function overvips_image_set().

See also:vips_image_get_image(),vips_image_set().

vips_image_set_array_int ()

voidvips_image_set_array_int (VipsImage *image,constchar *name,constint *array,int n);

Attachesarray as a metadata item onimage asname.A convenience function overvips_image_set().

See also:vips_image_get_image(),vips_image_set().

vips_image_get_array_int ()

intvips_image_get_array_int (VipsImage *image,constchar *name,int **out,int *n);

Getsout fromim under the namename.The field must be of typeVIPS_TYPE_ARRAY_INT.

Do not freeout.out is valid as long asimage is valid.

Usevips_image_get_typeof() to test for theexistence of a piece of metadata.

See also:vips_image_get(),vips_image_set_image()

vips_image_get_array_double ()

intvips_image_get_array_double (VipsImage *image,constchar *name,double **out,int *n);

Getsout fromim under the namename.The field must be of typeVIPS_TYPE_ARRAY_INT.

Do not freeout.out is valid as long asimage is valid.

Usevips_image_get_typeof() to test for theexistence of a piece of metadata.

See also:vips_image_get(),vips_image_set_image()

vips_image_set_array_double ()

voidvips_image_set_array_double (VipsImage *image,constchar *name,constdouble *array,int n);

Attachesarray as a metadata item onimage asname.A convenience function overvips_image_set().

See also:vips_image_get_image(),vips_image_set().

vips_image_history_printf ()

intvips_image_history_printf (VipsImage *image,constchar *format,...);

Add a line to the image history. Theformat and arguments are expanded, thedate and time is appended prefixed with a hash character, and the wholestring is appended to the image history and terminated with a newline.

For example:

12

vips_image_history_printf(image,"vips invert %s %s",in->filename,out->filename);

Might add the string

1

"vips invert /home/john/fred.v /home/john/jim.v # Fri Apr 3 23:30:35 2009\n"

VIPS operations don't add history lines for you because a single action atthe application level might involve many VIPS operations. History must berecorded by the application.

vips_image_history_args ()

intvips_image_history_args (VipsImage *image,constchar *name,int argc,char *argv[]);

Formats the name/argv as a single string and callsvips_image_history_printf(). Aconvenience function for command-line prorams.

See also:vips_image_get_history().

vips_image_get_history ()

constchar *vips_image_get_history (VipsImage *image);

This function reads the image history as a C string. The string is ownedby VIPS and must not be freed.

VIPS tracks the history of each image, that is, the sequence of operationsthat generated that image. Applications built on VIPS need to callvips_image_history_printf() for each action they perform, setting thecommand-line equivalent for the action.

See also:vips_image_history_printf().

VIPS_META_EXIF_NAME

#define VIPS_META_EXIF_NAME "exif-data"

The name that read and write operations use for the image's EXIF data.

VIPS_META_XMP_NAME

#define VIPS_META_XMP_NAME "xmp-data"

The name that read and write operations use for the image's XMP data.

VIPS_META_IPTC_NAME

#define VIPS_META_IPTC_NAME "iptc-data"

The name that read and write operations use for the image's IPTC data.

VIPS_META_PHOTOSHOP_NAME

#define VIPS_META_PHOTOSHOP_NAME "photoshop-data"

The name that TIFF read and write operations use for the image'sTIFFTAG_PHOTOSHOP data.

VIPS_META_ICC_NAME

#define VIPS_META_ICC_NAME "icc-profile-data"

The name we use to attach an ICC profile. The file read and writeoperations for TIFF, JPEG, PNG and others use this item of metadata toattach and save ICC profiles. The profile is updated by thevips_icc_transform() operations.

VIPS_META_IMAGEDESCRIPTION

#define VIPS_META_IMAGEDESCRIPTION "image-description"

The IMAGEDESCRIPTION tag. Often has useful metadata.

VIPS_META_RESOLUTION_UNIT

#define VIPS_META_RESOLUTION_UNIT "resolution-unit"

The JPEG and TIFF read and write operations use this to record thefile's preferred unit for resolution.

VIPS_META_BITS_PER_SAMPLE

#define VIPS_META_BITS_PER_SAMPLE "bits-per-sample"

The bits per sample for each channel.

VIPS_META_PALETTE

#define VIPS_META_PALETTE "palette"

Does this image have a palette?

VIPS_META_LOADER

#define VIPS_META_LOADER "vips-loader"

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

VIPS_META_SEQUENTIAL

#define VIPS_META_SEQUENTIAL "vips-sequential"

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

VIPS_META_ORIENTATION

#define VIPS_META_ORIENTATION "orientation"

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

VIPS_META_PAGE_HEIGHT

#define VIPS_META_PAGE_HEIGHT "page-height"

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

VIPS_META_N_PAGES

#define VIPS_META_N_PAGES "n-pages"

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

VIPS_META_N_SUBIFDS

#define VIPS_META_N_SUBIFDS "n-subifds"

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

VIPS_META_CONCURRENCY

#define VIPS_META_CONCURRENCY "concurrency"

If set, the suggested concurrency for this image.