Functions | |
VimosImageArray * | newImageArray (int size) |
Create an empty image array of appropriate size. | |
void | deleteImageArray (VimosImageArray *array) |
Delete an image array object. | |
void | destroyImageArray (VimosImageArray *array) |
Destroy an image array object. | |
int | imageArrayIsEmpty (const VimosImageArray *array) |
Check if an image array object is empty. | |
int | imageArrayCapacity (const VimosImageArray *array) |
Get the capacity of an image array. | |
int | imageArraySize (const VimosImageArray *array) |
Get the number of images stored in an image array. | |
const VimosImage * | imageArrayGet (const VimosImageArray *array, int index) |
The function retrieves an image from an image array object. | |
int | imageArraySet (VimosImageArray *array, int index, const VimosImage *image) |
Set an element of an image array. | |
VimosImage * | imageArrayRemove (VimosImageArray *array, int index) |
Remove an image from an image array object. | |
VimosImage ** | imageArrayGetData (const VimosImageArray *array) |
Get reference to the array objects data. |
void deleteImageArray | ( | VimosImageArray * | array | ) |
Delete an image array object.
array | Image array object to be deallocated. |
NULL
nothing is done.void destroyImageArray | ( | VimosImageArray * | array | ) |
Destroy an image array object.
array | Image array object to be destroyed. |
NULL
nothing is done.int imageArrayCapacity | ( | const VimosImageArray * | array | ) |
Get the capacity of an image array.
array | Image array object. |
const VimosImage* imageArrayGet | ( | const VimosImageArray * | array, | |
int | index | |||
) |
The function retrieves an image from an image array object.
NULL
is returned.array | Image array object. | |
index | Array element offset. |
VimosImage** imageArrayGetData | ( | const VimosImageArray * | array | ) |
Get reference to the array objects data.
array | Image array object. |
int imageArrayIsEmpty | ( | const VimosImageArray * | array | ) |
Check if an image array object is empty.
VM_TRUE
if the array is empty, otherwise VM_FALSE
is returned.array | Image array object to be tested. |
VimosImage* imageArrayRemove | ( | VimosImageArray * | array, | |
int | index | |||
) |
Remove an image from an image array object.
array | Image array object. | |
index | Array element offset. |
NULL
. If no image was stored in the array element the function succeeds and the returned reference is NULL
.
int imageArraySet | ( | VimosImageArray * | array, | |
int | index, | |||
const VimosImage * | image | |||
) |
Set an element of an image array.
EXIT_SUCCESS
if no error occurred, or EXIT_FAILURE
otherwise.array | Image array object. | |
index | Array element offset. | |
image | Image object. |
NULL
as image image.int imageArraySize | ( | const VimosImageArray * | array | ) |
Get the number of images stored in an image array.
array | Image array object. |
VimosImageArray* newImageArray | ( | int | size | ) |
Create an empty image array of appropriate size.
NULL
otherwise.size | Size of the image array. |
NULL
.