Libpiv API documentation

 Search for 

gpiv-img_utils.h File Reference

utilities module for GpivImage structure More...

Go to the source code of this file.

Functions
GpivImage *	gpiv_alloc_img (const GpivImagePar *image_par)
gchar *	gpiv_check_alloc_img (const GpivImage *image)
void	gpiv_free_img (GpivImage *gpiv_image)
GpivImage *	gpiv_cp_img (const GpivImage *image)
gchar *	gpiv_cp_img_data (const GpivImage *image_src, GpivImage *image_dest)

---

Detailed Description

utilities module for GpivImage structure

SOURCES: lib/img_utils.c

LAST MODIFICATION DATE:

Id

Definition in file gpiv-img_utils.h.

---

Function Documentation

GpivImage* gpiv_alloc_img

(

const GpivImagePar *

image_par

)

Allocates memory for GpivImage frames

Parameters:

[in]

image_par

image parameters

Returns:

GpivImage

gchar* gpiv_check_alloc_img

(

const GpivImage *

image

)

Checks if image frames have been allocated TODO BUGFIX: check on correct size

Parameters:

[in]

image

image to be checked if allocated

Returns:

NULL on success or error message on failure

GpivImage* gpiv_cp_img

(

const GpivImage *

image

)

Duplicates image. The returned image will have to be freed with gpiv_free_img when no longer needed.

Parameters:

[in]

image

source image

Returns:

GpivImage containing the copied header and image data from the source image or NULL on failure.

gchar* gpiv_cp_img_data	(	const GpivImage *	image_src,
		GpivImage *	image_dest
	)

Copies contents of img_src to img_dest. Image_src and image_dest will have to be allocated with gpiv_alloc_img before and will have to be freed with gpiv_free_img when no longer needed.

Parameters:

[in]	image_src	source image to be copied
[out]	image_dest	destination image, copy of source

Returns:

NULL on success or error message on failure

void gpiv_free_img

(

GpivImage *

gpiv_image

)

Frees memory of gpiv_image

Parameters:

[in]

gpiv_image

image structure containging data frames and parameters

Returns:

void

---