Vips.ArrayImage¶

Fields¶

Name	Type	Access	Description
area	`Vips.Area`	r/w

Methods¶

class	`empty` ()
class	`new` (array)
class	`new_from_string` (string, flags)
	`append` (image)
	`get` ()

Details¶

class Vips.ArrayImage¶

classmethod empty()¶

Returns:: A new [struct`ArrayImage`].
Return type:: Vips.ArrayImage

Make an empty image array. Handy with [method`ArrayImage`.append] for bindings which can’t handle object array arguments.

::: seealso [method`ArrayImage`.append].

classmethod new(array)¶

Parameters:: array ([Vips.Image]) – array of [class`Image`]
Returns:: A new [struct`ArrayImage`].
Return type:: Vips.ArrayImage

Allocate a new array of images and copy array into it. Free with [method`Area`.unref].

The images will all be reffed by this function. They will be automatically unreffed for you by [method`Area`.unref].

Add an extra NULL element at the end, handy for eg. [func`Image`.pipeline_array] etc.

::: seealso [struct`Area`].

classmethod new_from_string(string, flags)¶

Parameters:

string (str) –
flags (Vips.Access) –

Return type:

Vips.ArrayImage

append(image)¶

Parameters:: image (Vips.Image) – add this
Returns:: A new [struct`ArrayImage`].
Return type:: Vips.ArrayImage

Make a new [struct`ArrayImage`], one larger than self, with image appended to the end. Handy with [ctor`ArrayImage`.empty] for bindings which can’t handle object array arguments.

::: seealso [ctor`ArrayImage`.empty].

get()¶

Returns:: array of [class`Image`]
Return type:: [Vips.Image]

Fetch an image array from a [struct`ArrayImage`]. Useful for language bindings.