| Top |
| #define | VIPS_DEPRECATED_FOR() |
| int | (*VipsCallbackFn) () |
| void * | (*VipsSListMap2Fn) () |
| void * | (*VipsSListMap4Fn) () |
| void * | (*VipsSListFold2Fn) () |
| char * | vips_path_filename7 () |
| char * | vips_path_mode7 () |
| int | bands | Read / Write |
| VipsCoding | coding | Read / Write |
| VipsDemandStyle | demand | Read / Write |
| char * | filename | Read / Write |
| gpointer | foreign-buffer | Read / Write |
| VipsBandFormat | format | Read / Write |
| int | height | Read / Write |
| VipsInterpretation | interpretation | Read / Write |
| gboolean | kill | Read / Write |
| char * | mode | Read / Write |
| guint64 | sizeof-header | Read / Write |
| int | width | Read / Write |
| int | xoffset | Read / Write |
| double | xres | Read / Write |
| int | yoffset | Read / Write |
| double | yres | Read / Write |
| VipsBlob * | blob | Read / Write |
| VipsBlob * | blob | Read / Write |
| gboolean | memory | Read / Write |
| #define | VIPS_API |
| #define | VIPS_DEPRECATED |
| typedef | VipsPel |
| enum | VipsPrecision |
| VipsBuf | |
| VipsImage | |
| VipsRegion | |
| VipsSource | |
| VipsTarget |
GObject ╰── VipsObject ├── VipsConnection │ ├── VipsSource │ │ ╰── VipsSourceCustom │ ╰── VipsTarget │ ╰── VipsTargetCustom ├── VipsImage ╰── VipsRegion
char *
vips_path_filename7 (const char *path);
Return the filename part of a vips7 path. For testing only.
typedef unsigned char VipsPel;
A picture element. Cast this to whatever the associated VipsBandFormat says to get the value.
typedef struct _VipsImage VipsImage;
An image. These can represent an image on disc, a memory buffer, an image in the process of being written to disc or a partially evaluated image in memory.
typedef struct {
/* Users may read these two fields.
*/
VipsImage *im; /* Link back to parent image */
VipsRect valid; /* Area of parent we can see */
/* The rest of VipsRegion is private.
*/
} VipsRegion;
A small part of a VipsImage. valid
holds the left/top/width/height of the
area of pixels that are available from the region.
See also: VIPS_REGION_ADDR(), vips_region_new(), vips_region_prepare().
“bands” property “bands” int
Number of bands in image.
Owner: VipsImage
Flags: Read / Write
Allowed values: [1,10000000]
Default value: 1
“coding” property“coding” VipsCoding
Pixel coding.
Owner: VipsImage
Flags: Read / Write
Default value: VIPS_CODING_NONE
“demand” property“demand” VipsDemandStyle
Preferred demand style for this image.
Owner: VipsImage
Flags: Read / Write
Default value: VIPS_DEMAND_STYLE_SMALLTILE
“filename” property “filename” char *
Image filename.
Owner: VipsImage
Flags: Read / Write
Default value: NULL
“foreign-buffer” property“foreign-buffer” gpointer
Pointer to foreign pixels.
Owner: VipsImage
Flags: Read / Write
“format” property“format” VipsBandFormat
Pixel format in image.
Owner: VipsImage
Flags: Read / Write
Default value: VIPS_FORMAT_UCHAR
“height” property “height” int
Image height in pixels.
Owner: VipsImage
Flags: Read / Write
Allowed values: [1,10000000]
Default value: 1
“interpretation” property“interpretation” VipsInterpretation
Pixel interpretation.
Owner: VipsImage
Flags: Read / Write
Default value: VIPS_INTERPRETATION_MULTIBAND
“kill” property“kill” gboolean
Block evaluation on this image.
Owner: VipsImage
Flags: Read / Write
Default value: FALSE
“mode” property “mode” char *
Open mode.
Owner: VipsImage
Flags: Read / Write
Default value: "p"
“sizeof-header” property“sizeof-header” guint64
Offset in bytes from start of file.
Owner: VipsImage
Flags: Read / Write
Allowed values: <= 1000000000
Default value: 64
“width” property “width” int
Image width in pixels.
Owner: VipsImage
Flags: Read / Write
Allowed values: [1,10000000]
Default value: 1
“xoffset” property “xoffset” int
Horizontal offset of origin.
Owner: VipsImage
Flags: Read / Write
Allowed values: [-10000000,10000000]
Default value: 0
“xres” property “xres” double
Horizontal resolution in pixels/mm.
Owner: VipsImage
Flags: Read / Write
Allowed values: [-0,1e+06]
Default value: 0
“yoffset” property “yoffset” int
Vertical offset of origin.
Owner: VipsImage
Flags: Read / Write
Allowed values: [-10000000,10000000]
Default value: 0
“yres” property “yres” double
Vertical resolution in pixels/mm.
Owner: VipsImage
Flags: Read / Write
Allowed values: [-0,1e+06]
Default value: 0
“memory” property“memory” gboolean
File descriptor should output to memory.
Owner: VipsTarget
Flags: Read / Write
Default value: FALSE
“eval” signalvoid user_function (VipsImage *image, gpointer progress, gpointer user_data)
The ::eval signal is emitted once per work unit (typically a 128 x 128 area of pixels) during image computation.
You can use this signal to update user-interfaces with progress feedback. Beware of updating too frequently: you will usually need some throttling mechanism.
Use vips_image_set_progress() to turn on progress reporting for an
image.
image |
the image being calculated |
|
progress |
VipsProgress for this image. |
[type VipsProgress] |
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“invalidate” signalvoid user_function (VipsImage *image, gpointer user_data)
The ::invalidate signal is emitted when an image or one of it's
upstream data sources has been destructively modified. See
vips_image_invalidate_all().
image |
the image that has changed |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“minimise” signalvoid user_function (VipsImage *image, gpointer user_data)
The ::minimise signal is emitted when an image has been asked to
minimise memory usage. All non-essential caches are dropped.
See vips_image_minimise_all().
image |
the image that is being minimised |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“posteval” signalvoid user_function (VipsImage *image, gpointer progress, gpointer user_data)
The ::posteval signal is emitted once at the end of the computation
of image
. It's a good place to shut down evaluation feedback.
Use vips_image_set_progress() to turn on progress reporting for an
image.
image |
the image that was calculated |
|
progress |
VipsProgress for this image. |
[type VipsProgress] |
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“preeval” signalvoid user_function (VipsImage *image, gpointer progress, gpointer user_data)
The ::preeval signal is emitted once before computation of image
starts. It's a good place to set up evaluation feedback.
Use vips_image_set_progress() to turn on progress reporting for an
image.
image |
the image to be calculated |
|
progress |
VipsProgress for this image. |
[type VipsProgress] |
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“written” signalvoid user_function (VipsImage *image, gpointer result, gpointer user_data)
The ::written signal is emitted just after an image has been written to. It is used by vips to implement things like write to foreign file formats.
image |
the image that was calculated |
|
result |
set to non-zero to indicate error. |
[out][type gint] |
user_data |
user data set when the signal handler was connected. |
Flags: Action