Main Page   Modules   Compound List   File List   Compound Members   File Members  

Image Package


Modules

Set Attributes of an Image
Allocate/Free an Image
Extract a Part of an Image
Fill an Image
Access Individual Pixels of an Image
Binary Image Operations
Access Whole Channels of an Image
Image Comparison
Composite one image on another
Return Size Attributes of a Pixel or an Image
Get Attributes of an Image
Test Attributes of an Image
Flip an Image vertically
Invert an Image
Image Pyramids
Image I/O
Copy an Image

Compounds

struct  Gan_Image
 structure definition for image More...

struct  Gan_ImageWindow
 Definition of a rectangular sub-part of an image. More...


Defines

#define GAN_PIXFMT   GAN_GREY_LEVEL_IMAGE
#define GAN_IMFMT   gl
#define GAN_IMAGE_STRUCT_DEFINED

Typedefs

typedef Gan_Image Gan_Image
 structure definition for image

typedef Gan_ImageWindow Gan_ImageWindow
 Definition of a rectangular sub-part of an image.


Functions

Gan_Imagegan_image_set_gen_b (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_b (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_BitWord *pix_data, size_t pix_data_size, Gan_BitWord **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_b (Gan_Image *image, Gan_Alignment alignment, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in binary image.

Gan_Bool gan_image_mask_window_b (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear binary image except in specified rectangular region.

Gan_Imagegan_image_form_gen (Gan_Image *img, Gan_ImageFormat format, Gan_Type type, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, void *pix_data, size_t pix_data_size, void *row_data, size_t row_data_size)
 Form image.

Gan_Bool gan_image_set_data_free_func (Gan_Image *img, void(*data_free_func)(void *))
 Sets the function to free the image data buffer.

size_t gan_image_pixel_size (Gan_ImageFormat format, Gan_Type type)
 Returns the size of an image pixel in bytes.

size_t gan_image_min_stride (Gan_ImageFormat format, Gan_Type type, unsigned long width, size_t alignment)
 Returns the minimum size of a row of image pixels in bytes.

Gan_Bool gan_image_fill_const (Gan_Image *img, Gan_Pixel *pixel)
 Fill an image with a constant value.

Gan_Bool gan_image_fill_zero (Gan_Image *img)
 Fills an image with zero pixels.

Gan_Bool gan_image_fill_const_window (Gan_Image *img, unsigned r0, unsigned c0, unsigned height, unsigned width, Gan_Pixel *pixel)
 Fill a subwindow of an image.

Gan_Pixel gan_image_get_pix (Gan_Image *img, unsigned row, unsigned col)
 Gets a pixel from an image.

void * gan_image_get_pixptr (Gan_Image *img, unsigned row, unsigned col)
 Gets a pointer to a pixel from an image.

Gan_Bool gan_image_get_pix_zero (Gan_Image *img, unsigned row, unsigned col)
 Gets a pixel from an image and compares it with zero.

Gan_Bool gan_image_set_pix (Gan_Image *img, unsigned row, unsigned col, Gan_Pixel *pix)
 Sets a pixel in an image.

Gan_Bool gan_image_set_pix_zero (Gan_Image *img, unsigned row, unsigned col)
 Sets a pixel in an image to zero.

Gan_Bool gan_image_get_active_subwindow (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

Gan_Bool gan_image_mask_window (Gan_Image *image, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image to zero except in specified rectangular region.

void gan_image_free_va (Gan_Image *img,...)
 Free a NULL-terminated variable argument list of images.

Gan_Imagegan_image_set_format_type_dims_gen (Gan_Image *img, Gan_ImageFormat format, Gan_Type type, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
 Sets the format, type, dimensions and stride of an image.

Gan_Imagegan_image_set_gen_gl_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, double *pix_data, size_t pix_data_size, double **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_d (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

double * gan_image_get_pixptr_gl_d (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level double image.

double ** gan_image_get_pixarr_gl_d (Gan_Image *img)
 Return the pixel array from a grey-level double image.

Gan_Bool gan_image_mask_window_gl_d (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_gl_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, float *pix_data, size_t pix_data_size, float **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_f (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

float * gan_image_get_pixptr_gl_f (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level float image.

float ** gan_image_get_pixarr_gl_f (Gan_Image *img)
 Return the pixel array from a grey-level float image.

Gan_Bool gan_image_mask_window_gl_f (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_gl_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, int *pix_data, size_t pix_data_size, int **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_i (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

int * gan_image_get_pixptr_gl_i (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level int image.

int ** gan_image_get_pixarr_gl_i (Gan_Image *img)
 Return the pixel array from a grey-level int image.

Gan_Bool gan_image_mask_window_gl_i (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_gl_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, short *pix_data, size_t pix_data_size, short **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_s (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

short * gan_image_get_pixptr_gl_s (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level short image.

short ** gan_image_get_pixarr_gl_s (Gan_Image *img)
 Return the pixel array from a grey-level short image.

Gan_Bool gan_image_mask_window_gl_s (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_gl_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, unsigned char *pix_data, size_t pix_data_size, unsigned char **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_uc (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

unsigned char * gan_image_get_pixptr_gl_uc (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level unsigned char image.

unsigned char ** gan_image_get_pixarr_gl_uc (Gan_Image *img)
 Return the pixel array from a grey-level unsigned char image.

Gan_Bool gan_image_mask_window_gl_uc (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_gl_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, unsigned int *pix_data, size_t pix_data_size, unsigned int **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_ui (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

unsigned int * gan_image_get_pixptr_gl_ui (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level unsigned int image.

unsigned int ** gan_image_get_pixarr_gl_ui (Gan_Image *img)
 Return the pixel array from a grey-level unsigned int image.

Gan_Bool gan_image_mask_window_gl_ui (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_gl_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, gan_ui16 *pix_data, size_t pix_data_size, gan_ui16 **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_ui16 (Gan_Image *image, Gan_ImageWindow *subwin)
gan_ui16 * gan_image_get_pixptr_gl_ui16 (Gan_Image *img, unsigned row, unsigned col)
gan_ui16 ** gan_image_get_pixarr_gl_ui16 (Gan_Image *img)
Gan_Bool gan_image_mask_window_gl_ui16 (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
Gan_Imagegan_image_set_gen_gl_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, gan_ui32 *pix_data, size_t pix_data_size, gan_ui32 **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_ui32 (Gan_Image *image, Gan_ImageWindow *subwin)
gan_ui32 * gan_image_get_pixptr_gl_ui32 (Gan_Image *img, unsigned row, unsigned col)
gan_ui32 ** gan_image_get_pixarr_gl_ui32 (Gan_Image *img)
Gan_Bool gan_image_mask_window_gl_ui32 (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
Gan_Imagegan_image_set_gen_gl_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, gan_ui8 *pix_data, size_t pix_data_size, gan_ui8 **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_ui8 (Gan_Image *image, Gan_ImageWindow *subwin)
gan_ui8 * gan_image_get_pixptr_gl_ui8 (Gan_Image *img, unsigned row, unsigned col)
gan_ui8 ** gan_image_get_pixarr_gl_ui8 (Gan_Image *img)
Gan_Bool gan_image_mask_window_gl_ui8 (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
Gan_Imagegan_image_set_gen_gl_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gl_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, unsigned short *pix_data, size_t pix_data_size, unsigned short **row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_gl_us (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

unsigned short * gan_image_get_pixptr_gl_us (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level unsigned short image.

unsigned short ** gan_image_get_pixarr_gl_us (Gan_Image *img)
 Return the pixel array from a grey-level unsigned short image.

Gan_Bool gan_image_mask_window_gl_us (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_gla_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_GLAPixel_d *pix_data, size_t pix_data_size, struct Gan_GLAPixel_d **row_data, size_t row_data_size)
Gan_GLAPixel_dgan_image_get_pixptr_gla_d (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level alpha double image.

Gan_GLAPixel_d ** gan_image_get_pixarr_gla_d (Gan_Image *img)
 Return the pixel array from a grey-level alpha double image.

Gan_Imagegan_image_set_gen_gla_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_GLAPixel_f *pix_data, size_t pix_data_size, struct Gan_GLAPixel_f **row_data, size_t row_data_size)
Gan_GLAPixel_fgan_image_get_pixptr_gla_f (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level alpha float image.

Gan_GLAPixel_f ** gan_image_get_pixarr_gla_f (Gan_Image *img)
 Return the pixel array from a grey-level alpha float image.

Gan_Imagegan_image_set_gen_gla_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_GLAPixel_i *pix_data, size_t pix_data_size, struct Gan_GLAPixel_i **row_data, size_t row_data_size)
Gan_GLAPixel_igan_image_get_pixptr_gla_i (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level alpha int image.

Gan_GLAPixel_i ** gan_image_get_pixarr_gla_i (Gan_Image *img)
 Return the pixel array from a grey-level alpha int image.

Gan_Imagegan_image_set_gen_gla_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_GLAPixel_s *pix_data, size_t pix_data_size, struct Gan_GLAPixel_s **row_data, size_t row_data_size)
Gan_GLAPixel_sgan_image_get_pixptr_gla_s (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level alpha short image.

Gan_GLAPixel_s ** gan_image_get_pixarr_gla_s (Gan_Image *img)
 Return the pixel array from a grey-level alpha short image.

Gan_Imagegan_image_set_gen_gla_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_GLAPixel_uc *pix_data, size_t pix_data_size, struct Gan_GLAPixel_uc **row_data, size_t row_data_size)
Gan_GLAPixel_ucgan_image_get_pixptr_gla_uc (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level alpha unsigned char image.

Gan_GLAPixel_uc ** gan_image_get_pixarr_gla_uc (Gan_Image *img)
 Return the pixel array from a grey-level alpha unsigned char image.

Gan_Imagegan_image_set_gen_gla_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_GLAPixel_ui *pix_data, size_t pix_data_size, struct Gan_GLAPixel_ui **row_data, size_t row_data_size)
Gan_GLAPixel_uigan_image_get_pixptr_gla_ui (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level alpha unsigned int image.

Gan_GLAPixel_ui ** gan_image_get_pixarr_gla_ui (Gan_Image *img)
 Return the pixel array from a grey-level alpha unsigned int image.

Gan_Imagegan_image_set_gen_gla_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_GLAPixel_ui16 *pix_data, size_t pix_data_size, Gan_GLAPixel_ui16 **row_data, size_t row_data_size)
Gan_GLAPixel_ui16 * gan_image_get_pixptr_gla_ui16 (Gan_Image *img, unsigned row, unsigned col)
Gan_GLAPixel_ui16 ** gan_image_get_pixarr_gla_ui16 (Gan_Image *img)
Gan_Imagegan_image_set_gen_gla_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_GLAPixel_ui32 *pix_data, size_t pix_data_size, Gan_GLAPixel_ui32 **row_data, size_t row_data_size)
Gan_GLAPixel_ui32 * gan_image_get_pixptr_gla_ui32 (Gan_Image *img, unsigned row, unsigned col)
Gan_GLAPixel_ui32 ** gan_image_get_pixarr_gla_ui32 (Gan_Image *img)
Gan_Imagegan_image_set_gen_gla_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_GLAPixel_ui8 *pix_data, size_t pix_data_size, Gan_GLAPixel_ui8 **row_data, size_t row_data_size)
Gan_GLAPixel_ui8 * gan_image_get_pixptr_gla_ui8 (Gan_Image *img, unsigned row, unsigned col)
Gan_GLAPixel_ui8 ** gan_image_get_pixarr_gla_ui8 (Gan_Image *img)
Gan_Imagegan_image_set_gen_gla_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_gla_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_GLAPixel_us *pix_data, size_t pix_data_size, struct Gan_GLAPixel_us **row_data, size_t row_data_size)
Gan_GLAPixel_usgan_image_get_pixptr_gla_us (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level alpha unsigned short image.

Gan_GLAPixel_us ** gan_image_get_pixarr_gla_us (Gan_Image *img)
 Return the pixel array from a grey-level alpha unsigned short image.

Gan_Imagegan_image_set_gen_p (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_p (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, void **pix_data, size_t pix_data_size, void ***row_data, size_t row_data_size)
Gan_Bool gan_image_get_active_subwindow_p (Gan_Image *image, Gan_ImageWindow *subwin)
 Computes bounding box of non-zero pixels in grey-level image.

void ** gan_image_get_pixptr_p (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a grey-level void * image.

void *** gan_image_get_pixarr_p (Gan_Image *img)
 Return the pixel array from a grey-level void * image.

Gan_Bool gan_image_mask_window_p (Gan_Image *pImage, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Clear image except in specified rectangular region.

Gan_Imagegan_image_set_gen_rgb_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBPixel_d *pix_data, size_t pix_data_size, struct Gan_RGBPixel_d **row_data, size_t row_data_size)
Gan_RGBPixel_dgan_image_get_pixptr_rgb_d (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB colour double image.

Gan_RGBPixel_d ** gan_image_get_pixarr_rgb_d (Gan_Image *img)
 Return the pixel array from a RGB colour double image.

Gan_Imagegan_image_set_gen_rgb_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBPixel_f *pix_data, size_t pix_data_size, struct Gan_RGBPixel_f **row_data, size_t row_data_size)
Gan_RGBPixel_fgan_image_get_pixptr_rgb_f (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB colour float image.

Gan_RGBPixel_f ** gan_image_get_pixarr_rgb_f (Gan_Image *img)
 Return the pixel array from a RGB colour float image.

Gan_Imagegan_image_set_gen_rgb_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBPixel_i *pix_data, size_t pix_data_size, struct Gan_RGBPixel_i **row_data, size_t row_data_size)
Gan_RGBPixel_igan_image_get_pixptr_rgb_i (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB colour int image.

Gan_RGBPixel_i ** gan_image_get_pixarr_rgb_i (Gan_Image *img)
 Return the pixel array from a RGB colour int image.

Gan_Imagegan_image_set_gen_rgb_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBPixel_s *pix_data, size_t pix_data_size, struct Gan_RGBPixel_s **row_data, size_t row_data_size)
Gan_RGBPixel_sgan_image_get_pixptr_rgb_s (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB colour short image.

Gan_RGBPixel_s ** gan_image_get_pixarr_rgb_s (Gan_Image *img)
 Return the pixel array from a RGB colour short image.

Gan_Imagegan_image_set_gen_rgb_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBPixel_uc *pix_data, size_t pix_data_size, struct Gan_RGBPixel_uc **row_data, size_t row_data_size)
Gan_RGBPixel_ucgan_image_get_pixptr_rgb_uc (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB colour unsigned char image.

Gan_RGBPixel_uc ** gan_image_get_pixarr_rgb_uc (Gan_Image *img)
 Return the pixel array from a RGB colour unsigned char image.

Gan_Imagegan_image_set_gen_rgb_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBPixel_ui *pix_data, size_t pix_data_size, struct Gan_RGBPixel_ui **row_data, size_t row_data_size)
Gan_RGBPixel_uigan_image_get_pixptr_rgb_ui (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB colour unsigned int image.

Gan_RGBPixel_ui ** gan_image_get_pixarr_rgb_ui (Gan_Image *img)
 Return the pixel array from a RGB colour unsigned int image.

Gan_Imagegan_image_set_gen_rgb_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_RGBPixel_ui16 *pix_data, size_t pix_data_size, Gan_RGBPixel_ui16 **row_data, size_t row_data_size)
Gan_RGBPixel_ui16 * gan_image_get_pixptr_rgb_ui16 (Gan_Image *img, unsigned row, unsigned col)
Gan_RGBPixel_ui16 ** gan_image_get_pixarr_rgb_ui16 (Gan_Image *img)
Gan_Imagegan_image_set_gen_rgb_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_RGBPixel_ui32 *pix_data, size_t pix_data_size, Gan_RGBPixel_ui32 **row_data, size_t row_data_size)
Gan_RGBPixel_ui32 * gan_image_get_pixptr_rgb_ui32 (Gan_Image *img, unsigned row, unsigned col)
Gan_RGBPixel_ui32 ** gan_image_get_pixarr_rgb_ui32 (Gan_Image *img)
Gan_Imagegan_image_set_gen_rgb_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_RGBPixel_ui8 *pix_data, size_t pix_data_size, Gan_RGBPixel_ui8 **row_data, size_t row_data_size)
Gan_RGBPixel_ui8 * gan_image_get_pixptr_rgb_ui8 (Gan_Image *img, unsigned row, unsigned col)
Gan_RGBPixel_ui8 ** gan_image_get_pixarr_rgb_ui8 (Gan_Image *img)
Gan_Imagegan_image_set_gen_rgb_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgb_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBPixel_us *pix_data, size_t pix_data_size, struct Gan_RGBPixel_us **row_data, size_t row_data_size)
Gan_RGBPixel_usgan_image_get_pixptr_rgb_us (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB colour unsigned short image.

Gan_RGBPixel_us ** gan_image_get_pixarr_rgb_us (Gan_Image *img)
 Return the pixel array from a RGB colour unsigned short image.

Gan_Imagegan_image_set_gen_rgba_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBAPixel_d *pix_data, size_t pix_data_size, struct Gan_RGBAPixel_d **row_data, size_t row_data_size)
Gan_RGBAPixel_dgan_image_get_pixptr_rgba_d (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB-colour alpha double image.

Gan_RGBAPixel_d ** gan_image_get_pixarr_rgba_d (Gan_Image *img)
 Return the pixel array from a RGB-colour alpha double image.

Gan_Imagegan_image_set_gen_rgba_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBAPixel_f *pix_data, size_t pix_data_size, struct Gan_RGBAPixel_f **row_data, size_t row_data_size)
Gan_RGBAPixel_fgan_image_get_pixptr_rgba_f (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB-colour alpha float image.

Gan_RGBAPixel_f ** gan_image_get_pixarr_rgba_f (Gan_Image *img)
 Return the pixel array from a RGB-colour alpha float image.

Gan_Imagegan_image_set_gen_rgba_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBAPixel_i *pix_data, size_t pix_data_size, struct Gan_RGBAPixel_i **row_data, size_t row_data_size)
Gan_RGBAPixel_igan_image_get_pixptr_rgba_i (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB-colour alpha int image.

Gan_RGBAPixel_i ** gan_image_get_pixarr_rgba_i (Gan_Image *img)
 Return the pixel array from a RGB-colour alpha int image.

Gan_Imagegan_image_set_gen_rgba_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBAPixel_s *pix_data, size_t pix_data_size, struct Gan_RGBAPixel_s **row_data, size_t row_data_size)
Gan_RGBAPixel_sgan_image_get_pixptr_rgba_s (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB-colour alpha short image.

Gan_RGBAPixel_s ** gan_image_get_pixarr_rgba_s (Gan_Image *img)
 Return the pixel array from a RGB-colour alpha short image.

Gan_Imagegan_image_set_gen_rgba_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_uc (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBAPixel_uc *pix_data, size_t pix_data_size, struct Gan_RGBAPixel_uc **row_data, size_t row_data_size)
Gan_RGBAPixel_ucgan_image_get_pixptr_rgba_uc (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB-colour alpha unsigned char image.

Gan_RGBAPixel_uc ** gan_image_get_pixarr_rgba_uc (Gan_Image *img)
 Return the pixel array from a RGB-colour alpha unsigned char image.

Gan_Imagegan_image_set_gen_rgba_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_ui (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBAPixel_ui *pix_data, size_t pix_data_size, struct Gan_RGBAPixel_ui **row_data, size_t row_data_size)
Gan_RGBAPixel_uigan_image_get_pixptr_rgba_ui (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB-colour alpha unsigned int image.

Gan_RGBAPixel_ui ** gan_image_get_pixarr_rgba_ui (Gan_Image *img)
 Return the pixel array from a RGB-colour alpha unsigned int image.

Gan_Imagegan_image_set_gen_rgba_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_ui16 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_RGBAPixel_ui16 *pix_data, size_t pix_data_size, Gan_RGBAPixel_ui16 **row_data, size_t row_data_size)
Gan_RGBAPixel_ui16 * gan_image_get_pixptr_rgba_ui16 (Gan_Image *img, unsigned row, unsigned col)
Gan_RGBAPixel_ui16 ** gan_image_get_pixarr_rgba_ui16 (Gan_Image *img)
Gan_Imagegan_image_set_gen_rgba_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_ui32 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_RGBAPixel_ui32 *pix_data, size_t pix_data_size, Gan_RGBAPixel_ui32 **row_data, size_t row_data_size)
Gan_RGBAPixel_ui32 * gan_image_get_pixptr_rgba_ui32 (Gan_Image *img, unsigned row, unsigned col)
Gan_RGBAPixel_ui32 ** gan_image_get_pixarr_rgba_ui32 (Gan_Image *img)
Gan_Imagegan_image_set_gen_rgba_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_ui8 (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, Gan_RGBAPixel_ui8 *pix_data, size_t pix_data_size, Gan_RGBAPixel_ui8 **row_data, size_t row_data_size)
Gan_RGBAPixel_ui8 * gan_image_get_pixptr_rgba_ui8 (Gan_Image *img, unsigned row, unsigned col)
Gan_RGBAPixel_ui8 ** gan_image_get_pixarr_rgba_ui8 (Gan_Image *img)
Gan_Imagegan_image_set_gen_rgba_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_rgba_us (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_RGBAPixel_us *pix_data, size_t pix_data_size, struct Gan_RGBAPixel_us **row_data, size_t row_data_size)
Gan_RGBAPixel_usgan_image_get_pixptr_rgba_us (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a RGB-colour alpha unsigned short image.

Gan_RGBAPixel_us ** gan_image_get_pixarr_rgba_us (Gan_Image *img)
 Return the pixel array from a RGB-colour alpha unsigned short image.

Gan_Imagegan_image_set_gen_vfield2D_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield2D_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector2 *pix_data, size_t pix_data_size, struct Gan_Vector2 **row_data, size_t row_data_size)
Gan_Vector2gan_image_get_pixptr_vfield2D_d (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 2D vector-field double image.

Gan_Vector2 ** gan_image_get_pixarr_vfield2D_d (Gan_Image *img)
 Return the pixel array from a 2D vector-field double image.

Gan_Imagegan_image_set_gen_vfield2D_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield2D_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector2_f *pix_data, size_t pix_data_size, struct Gan_Vector2_f **row_data, size_t row_data_size)
Gan_Vector2_fgan_image_get_pixptr_vfield2D_f (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 2D vector-field float image.

Gan_Vector2_f ** gan_image_get_pixarr_vfield2D_f (Gan_Image *img)
 Return the pixel array from a 2D vector-field float image.

Gan_Imagegan_image_set_gen_vfield2D_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield2D_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector2_i *pix_data, size_t pix_data_size, struct Gan_Vector2_i **row_data, size_t row_data_size)
Gan_Vector2_igan_image_get_pixptr_vfield2D_i (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 2D vector-field int image.

Gan_Vector2_i ** gan_image_get_pixarr_vfield2D_i (Gan_Image *img)
 Return the pixel array from a 2D vector-field int image.

Gan_Imagegan_image_set_gen_vfield2D_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield2D_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector2_s *pix_data, size_t pix_data_size, struct Gan_Vector2_s **row_data, size_t row_data_size)
Gan_Vector2_sgan_image_get_pixptr_vfield2D_s (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 2D vector-field short image.

Gan_Vector2_s ** gan_image_get_pixarr_vfield2D_s (Gan_Image *img)
 Return the pixel array from a 2D vector-field short image.

Gan_Imagegan_image_set_gen_vfield3D_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield3D_d (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector3 *pix_data, size_t pix_data_size, struct Gan_Vector3 **row_data, size_t row_data_size)
Gan_Vector3gan_image_get_pixptr_vfield3D_d (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 3D vector-field double image.

Gan_Vector3 ** gan_image_get_pixarr_vfield3D_d (Gan_Image *img)
 Return the pixel array from a 3D vector-field double image.

Gan_Imagegan_image_set_gen_vfield3D_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield3D_f (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector3_f *pix_data, size_t pix_data_size, struct Gan_Vector3_f **row_data, size_t row_data_size)
Gan_Vector3_fgan_image_get_pixptr_vfield3D_f (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 3D vector-field float image.

Gan_Vector3_f ** gan_image_get_pixarr_vfield3D_f (Gan_Image *img)
 Return the pixel array from a 3D vector-field float image.

Gan_Imagegan_image_set_gen_vfield3D_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield3D_i (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector3_i *pix_data, size_t pix_data_size, struct Gan_Vector3_i **row_data, size_t row_data_size)
Gan_Vector3_igan_image_get_pixptr_vfield3D_i (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 3D vector-field int image.

Gan_Vector3_i ** gan_image_get_pixarr_vfield3D_i (Gan_Image *img)
 Return the pixel array from a 3D vector-field int image.

Gan_Imagegan_image_set_gen_vfield3D_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data)
Gan_Imagegan_image_form_gen_vfield3D_s (struct Gan_Image *img, unsigned long height, unsigned long width, unsigned long stride, Gan_Bool alloc_pix_data, struct Gan_Vector3_s *pix_data, size_t pix_data_size, struct Gan_Vector3_s **row_data, size_t row_data_size)
Gan_Vector3_sgan_image_get_pixptr_vfield3D_s (Gan_Image *img, unsigned row, unsigned col)
 Return a pointer to a pixel from a 3D vector-field short image.

Gan_Vector3_s ** gan_image_get_pixarr_vfield3D_s (Gan_Image *img)
 Return the pixel array from a 3D vector-field short image.


Function Documentation

Gan_Bool gan_image_fill_const Gan_Image   img,
Gan_Pixel   pixel
 

Fill an image with a constant value.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Fill image img with constant value pixel.

Gan_Bool gan_image_fill_const_window Gan_Image   img,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width,
Gan_Pixel   pixel
 

Fill a subwindow of an image.

Parameters:
img The image to fill
r0 The top row of the subwindow
c0 The left column of the subwindow
height The height of the subwindow
width The width of the subwindow
pixel The pixel value with which to fill the subwindow
Returns:
GAN_TRUE on success, or GAN_FALSE on failure.
Fills a subwindow of image img with value pixel, the subwindow being defined by the r0, c0, height and width parameters. A NULL pixel pointer indicates zero value.

Gan_Bool gan_image_fill_zero Gan_Image   img
 

Fills an image with zero pixels.

Parameters:
img The image to fill
Returns:
GAN_TRUE on success, or GAN_FALSE on failure.
Fills image img with zero pixels.

Gan_Image* gan_image_form_gen Gan_Image   img,
Gan_ImageFormat    format,
Gan_Type    type,
unsigned long    height,
unsigned long    width,
unsigned long    stride,
Gan_Bool    alloc_pix_data,
void *    pix_data,
size_t    pix_data_size,
void *    row_data,
size_t    row_data_size
 

Form image.

Forms and returns an image img with given format, type, dimensions height and width. If the provided pix_data and/or row_data pointers are NULL (in any combination), the pixel data array and/or the row start pointer array are dynamically allocated. If either are not NULL they must be big enough to hold the pixel/row pointer array data. If necessary use gan_image_data_size() to compute the necessary size of the pix_data array (the necessary size of row_data is height pointers).

The stride indicates the separation in memory between adjacent rows of the image, and is measured in bytes. Without any padding of the image it will correspond to width pixels, in which case you should use the gan_image_form_data() macro instead.

If you want to dynamically allocate the pixel data array and/or the row pointer array with sizes greater than that necessary for the given height and width, pass pix_data and/or row_data as NULL and set pix_data_size and/or row_data_size appropriately.

See also gan_image_alloc() and gan_image_form().

void gan_image_free_va Gan_Image   img,
...   
 

Free a NULL-terminated variable argument list of images.

Returns:
No value.
Free a NULL-terminated variable argument list of images, starting with image img.

Gan_Bool gan_image_get_active_subwindow Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, or GAN_FALSE on failure.
Computes image window subwin which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_b Gan_Image   image,
Gan_Alignment    alignment,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in binary image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all bits in the binary image which have the value one (true). The value of the c0 and width fields of subwin will be provided with precision indicated by the given alignment, one of word, byte or bit alignment, the last being the slowest to compute. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_gl_d Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_gl_f Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_gl_i Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_gl_s Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_gl_uc Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_gl_ui Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_gl_us Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Bool gan_image_get_active_subwindow_p Gan_Image   image,
Gan_ImageWindow   subwin
 

Computes bounding box of non-zero pixels in grey-level image.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
Computes image window which covers all pixels in given grey-level image which are non-zero. If image is zero everywhere the fields of the subwin structure will be set to zero.

Gan_Pixel gan_image_get_pix Gan_Image   img,
unsigned    row,
unsigned    col
 

Gets a pixel from an image.

Parameters:
img The image
row The row position of the pixel
col The column position of the pixel
Returns:
The pixel at the given position
Gets the pixel from image img at position row, col.
See also:
gan_image_set_pix().

Gan_Bool gan_image_get_pix_zero Gan_Image   img,
unsigned    row,
unsigned    col
 

Gets a pixel from an image and compares it with zero.

Parameters:
img The image
row The row position of the pixel
col The column position of the pixel
Returns:
GAN_TRUE if the pixel is zero, GAN_FALSE otherwise.
Gets a pixel from an image and compares it with zero.
See also:
gan_image_get_pix().

double** gan_image_get_pixarr_gl_d Gan_Image   img
 

Return the pixel array from a grey-level double image.

Returns the pixel array from the grey-level double image img.

float** gan_image_get_pixarr_gl_f Gan_Image   img
 

Return the pixel array from a grey-level float image.

Returns the pixel array from the grey-level float image img.

int** gan_image_get_pixarr_gl_i Gan_Image   img
 

Return the pixel array from a grey-level int image.

Returns the pixel array from the grey-level int image img.

short** gan_image_get_pixarr_gl_s Gan_Image   img
 

Return the pixel array from a grey-level short image.

Returns the pixel array from the grey-level short image img.

unsigned char** gan_image_get_pixarr_gl_uc Gan_Image   img
 

Return the pixel array from a grey-level unsigned char image.

Returns the pixel array from the grey-level unsigned char image img.

unsigned int** gan_image_get_pixarr_gl_ui Gan_Image   img
 

Return the pixel array from a grey-level unsigned int image.

Returns the pixel array from the grey-level unsigned int image img.

unsigned short** gan_image_get_pixarr_gl_us Gan_Image   img
 

Return the pixel array from a grey-level unsigned short image.

Returns the pixel array from the grey-level unsigned short image img.

struct Gan_GLAPixel_d** gan_image_get_pixarr_gla_d Gan_Image   img
 

Return the pixel array from a grey-level alpha double image.

Returns the pixel array for the grey-level alpha double image img.

struct Gan_GLAPixel_f** gan_image_get_pixarr_gla_f Gan_Image   img
 

Return the pixel array from a grey-level alpha float image.

Returns the pixel array for the grey-level alpha float image img.

struct Gan_GLAPixel_i** gan_image_get_pixarr_gla_i Gan_Image   img
 

Return the pixel array from a grey-level alpha int image.

Returns the pixel array for the grey-level alpha int image img.

struct Gan_GLAPixel_s** gan_image_get_pixarr_gla_s Gan_Image   img
 

Return the pixel array from a grey-level alpha short image.

Returns the pixel array for the grey-level alpha short image img.

struct Gan_GLAPixel_uc** gan_image_get_pixarr_gla_uc Gan_Image   img
 

Return the pixel array from a grey-level alpha unsigned char image.

Returns the pixel array for the grey-level alpha unsigned char image img.

struct Gan_GLAPixel_ui** gan_image_get_pixarr_gla_ui Gan_Image   img
 

Return the pixel array from a grey-level alpha unsigned int image.

Returns the pixel array for the grey-level alpha unsigned int image img.

struct Gan_GLAPixel_us** gan_image_get_pixarr_gla_us Gan_Image   img
 

Return the pixel array from a grey-level alpha unsigned short image.

Returns the pixel array for the grey-level alpha unsigned short image img.

void* ** gan_image_get_pixarr_p Gan_Image   img
 

Return the pixel array from a grey-level void * image.

Returns the pixel array from the grey-level void * image img.

struct Gan_RGBPixel_d** gan_image_get_pixarr_rgb_d Gan_Image   img
 

Return the pixel array from a RGB colour double image.

Returns the pixel array for the RGB colour double image img.

struct Gan_RGBPixel_f** gan_image_get_pixarr_rgb_f Gan_Image   img
 

Return the pixel array from a RGB colour float image.

Returns the pixel array for the RGB colour float image img.

struct Gan_RGBPixel_i** gan_image_get_pixarr_rgb_i Gan_Image   img
 

Return the pixel array from a RGB colour int image.

Returns the pixel array for the RGB colour int image img.

struct Gan_RGBPixel_s** gan_image_get_pixarr_rgb_s Gan_Image   img
 

Return the pixel array from a RGB colour short image.

Returns the pixel array for the RGB colour short image img.

struct Gan_RGBPixel_uc** gan_image_get_pixarr_rgb_uc Gan_Image   img
 

Return the pixel array from a RGB colour unsigned char image.

Returns the pixel array for the RGB colour unsigned char image img.

struct Gan_RGBPixel_ui** gan_image_get_pixarr_rgb_ui Gan_Image   img
 

Return the pixel array from a RGB colour unsigned int image.

Returns the pixel array for the RGB colour unsigned int image img.

struct Gan_RGBPixel_us** gan_image_get_pixarr_rgb_us Gan_Image   img
 

Return the pixel array from a RGB colour unsigned short image.

Returns the pixel array for the RGB colour unsigned short image img.

struct Gan_RGBAPixel_d** gan_image_get_pixarr_rgba_d Gan_Image   img
 

Return the pixel array from a RGB-colour alpha double image.

Returns the pixel array for the RGB-colour alpha double image img.

struct Gan_RGBAPixel_f** gan_image_get_pixarr_rgba_f Gan_Image   img
 

Return the pixel array from a RGB-colour alpha float image.

Returns the pixel array for the RGB-colour alpha float image img.

struct Gan_RGBAPixel_i** gan_image_get_pixarr_rgba_i Gan_Image   img
 

Return the pixel array from a RGB-colour alpha int image.

Returns the pixel array for the RGB-colour alpha int image img.

struct Gan_RGBAPixel_s** gan_image_get_pixarr_rgba_s Gan_Image   img
 

Return the pixel array from a RGB-colour alpha short image.

Returns the pixel array for the RGB-colour alpha short image img.

struct Gan_RGBAPixel_uc** gan_image_get_pixarr_rgba_uc Gan_Image   img
 

Return the pixel array from a RGB-colour alpha unsigned char image.

Returns the pixel array for the RGB-colour alpha unsigned char image img.

struct Gan_RGBAPixel_ui** gan_image_get_pixarr_rgba_ui Gan_Image   img
 

Return the pixel array from a RGB-colour alpha unsigned int image.

Returns the pixel array for the RGB-colour alpha unsigned int image img.

struct Gan_RGBAPixel_us** gan_image_get_pixarr_rgba_us Gan_Image   img
 

Return the pixel array from a RGB-colour alpha unsigned short image.

Returns the pixel array for the RGB-colour alpha unsigned short image img.

struct Gan_Vector2** gan_image_get_pixarr_vfield2D_d Gan_Image   img
 

Return the pixel array from a 2D vector-field double image.

Returns the pixel array for the 2D vector-field double image img.

struct Gan_Vector2_f** gan_image_get_pixarr_vfield2D_f Gan_Image   img
 

Return the pixel array from a 2D vector-field float image.

Returns the pixel array for the 2D vector-field float image img.

struct Gan_Vector2_i** gan_image_get_pixarr_vfield2D_i Gan_Image   img
 

Return the pixel array from a 2D vector-field int image.

Returns the pixel array for the 2D vector-field int image img.

struct Gan_Vector2_s** gan_image_get_pixarr_vfield2D_s Gan_Image   img
 

Return the pixel array from a 2D vector-field short image.

Returns the pixel array for the 2D vector-field short image img.

struct Gan_Vector3** gan_image_get_pixarr_vfield3D_d Gan_Image   img
 

Return the pixel array from a 3D vector-field double image.

Returns the pixel array for the 3D vector-field double image img.

struct Gan_Vector3_f** gan_image_get_pixarr_vfield3D_f Gan_Image   img
 

Return the pixel array from a 3D vector-field float image.

Returns the pixel array for the 3D vector-field float image img.

struct Gan_Vector3_i** gan_image_get_pixarr_vfield3D_i Gan_Image   img
 

Return the pixel array from a 3D vector-field int image.

Returns the pixel array for the 3D vector-field int image img.

struct Gan_Vector3_s** gan_image_get_pixarr_vfield3D_s Gan_Image   img
 

Return the pixel array from a 3D vector-field short image.

Returns the pixel array for the 3D vector-field short image img.

void* gan_image_get_pixptr Gan_Image   img,
unsigned    row,
unsigned    col
 

Gets a pointer to a pixel from an image.

Parameters:
img The image
row The row position of the pixel
col The column position of the pixel
Returns:
A pointer to the pixel at the given position
Gets the pixel pointer from image img at position row, col.
See also:
gan_image_get_pix().

double* gan_image_get_pixptr_gl_d Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level double image.

Returns the pointer to the pixel at position row, col in grey-level double image img.

float* gan_image_get_pixptr_gl_f Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level float image.

Returns the pointer to the pixel at position row, col in grey-level float image img.

int* gan_image_get_pixptr_gl_i Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level int image.

Returns the pointer to the pixel at position row, col in grey-level int image img.

short* gan_image_get_pixptr_gl_s Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level short image.

Returns the pointer to the pixel at position row, col in grey-level short image img.

unsigned char* gan_image_get_pixptr_gl_uc Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level unsigned char image.

Returns the pointer to the pixel at position row, col in grey-level unsigned char image img.

unsigned int* gan_image_get_pixptr_gl_ui Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level unsigned int image.

Returns the pointer to the pixel at position row, col in grey-level unsigned int image img.

unsigned short* gan_image_get_pixptr_gl_us Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level unsigned short image.

Returns the pointer to the pixel at position row, col in grey-level unsigned short image img.

struct Gan_GLAPixel_d* gan_image_get_pixptr_gla_d Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level alpha double image.

Returns the pointer to the pixel at position row, col in grey-level alpha double image img.

struct Gan_GLAPixel_f* gan_image_get_pixptr_gla_f Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level alpha float image.

Returns the pointer to the pixel at position row, col in grey-level alpha float image img.

struct Gan_GLAPixel_i* gan_image_get_pixptr_gla_i Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level alpha int image.

Returns the pointer to the pixel at position row, col in grey-level alpha int image img.

struct Gan_GLAPixel_s* gan_image_get_pixptr_gla_s Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level alpha short image.

Returns the pointer to the pixel at position row, col in grey-level alpha short image img.

struct Gan_GLAPixel_uc* gan_image_get_pixptr_gla_uc Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level alpha unsigned char image.

Returns the pointer to the pixel at position row, col in grey-level alpha unsigned char image img.

struct Gan_GLAPixel_ui* gan_image_get_pixptr_gla_ui Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level alpha unsigned int image.

Returns the pointer to the pixel at position row, col in grey-level alpha unsigned int image img.

struct Gan_GLAPixel_us* gan_image_get_pixptr_gla_us Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level alpha unsigned short image.

Returns the pointer to the pixel at position row, col in grey-level alpha unsigned short image img.

void* * gan_image_get_pixptr_p Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a grey-level void * image.

Returns the pointer to the pixel at position row, col in grey-level void * image img.

struct Gan_RGBPixel_d* gan_image_get_pixptr_rgb_d Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB colour double image.

Returns the pointer to the pixel at position row, col in RGB colour double image img.

struct Gan_RGBPixel_f* gan_image_get_pixptr_rgb_f Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB colour float image.

Returns the pointer to the pixel at position row, col in RGB colour float image img.

struct Gan_RGBPixel_i* gan_image_get_pixptr_rgb_i Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB colour int image.

Returns the pointer to the pixel at position row, col in RGB colour int image img.

struct Gan_RGBPixel_s* gan_image_get_pixptr_rgb_s Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB colour short image.

Returns the pointer to the pixel at position row, col in RGB colour short image img.

struct Gan_RGBPixel_uc* gan_image_get_pixptr_rgb_uc Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB colour unsigned char image.

Returns the pointer to the pixel at position row, col in RGB colour unsigned char image img.

struct Gan_RGBPixel_ui* gan_image_get_pixptr_rgb_ui Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB colour unsigned int image.

Returns the pointer to the pixel at position row, col in RGB colour unsigned int image img.

struct Gan_RGBPixel_us* gan_image_get_pixptr_rgb_us Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB colour unsigned short image.

Returns the pointer to the pixel at position row, col in RGB colour unsigned short image img.

struct Gan_RGBAPixel_d* gan_image_get_pixptr_rgba_d Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB-colour alpha double image.

Returns the pointer to the pixel at position row, col in RGB-colour alpha double image img.

struct Gan_RGBAPixel_f* gan_image_get_pixptr_rgba_f Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB-colour alpha float image.

Returns the pointer to the pixel at position row, col in RGB-colour alpha float image img.

struct Gan_RGBAPixel_i* gan_image_get_pixptr_rgba_i Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB-colour alpha int image.

Returns the pointer to the pixel at position row, col in RGB-colour alpha int image img.

struct Gan_RGBAPixel_s* gan_image_get_pixptr_rgba_s Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB-colour alpha short image.

Returns the pointer to the pixel at position row, col in RGB-colour alpha short image img.

struct Gan_RGBAPixel_uc* gan_image_get_pixptr_rgba_uc Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB-colour alpha unsigned char image.

Returns the pointer to the pixel at position row, col in RGB-colour alpha unsigned char image img.

struct Gan_RGBAPixel_ui* gan_image_get_pixptr_rgba_ui Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB-colour alpha unsigned int image.

Returns the pointer to the pixel at position row, col in RGB-colour alpha unsigned int image img.

struct Gan_RGBAPixel_us* gan_image_get_pixptr_rgba_us Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a RGB-colour alpha unsigned short image.

Returns the pointer to the pixel at position row, col in RGB-colour alpha unsigned short image img.

struct Gan_Vector2* gan_image_get_pixptr_vfield2D_d Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 2D vector-field double image.

Returns the pointer to the pixel at position row, col in 2D vector-field double image img.

struct Gan_Vector2_f* gan_image_get_pixptr_vfield2D_f Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 2D vector-field float image.

Returns the pointer to the pixel at position row, col in 2D vector-field float image img.

struct Gan_Vector2_i* gan_image_get_pixptr_vfield2D_i Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 2D vector-field int image.

Returns the pointer to the pixel at position row, col in 2D vector-field int image img.

struct Gan_Vector2_s* gan_image_get_pixptr_vfield2D_s Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 2D vector-field short image.

Returns the pointer to the pixel at position row, col in 2D vector-field short image img.

struct Gan_Vector3* gan_image_get_pixptr_vfield3D_d Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 3D vector-field double image.

Returns the pointer to the pixel at position row, col in 3D vector-field double image img.

struct Gan_Vector3_f* gan_image_get_pixptr_vfield3D_f Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 3D vector-field float image.

Returns the pointer to the pixel at position row, col in 3D vector-field float image img.

struct Gan_Vector3_i* gan_image_get_pixptr_vfield3D_i Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 3D vector-field int image.

Returns the pointer to the pixel at position row, col in 3D vector-field int image img.

struct Gan_Vector3_s* gan_image_get_pixptr_vfield3D_s Gan_Image   img,
unsigned    row,
unsigned    col
 

Return a pointer to a pixel from a 3D vector-field short image.

Returns the pointer to the pixel at position row, col in 3D vector-field short image img.

Gan_Bool gan_image_mask_window Gan_Image   image,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image to zero except in specified rectangular region.

Returns:
GAN_TRUE on success, or GAN_FALSE on failure.
Clear image to zero except in specified rectangular region.

Gan_Bool gan_image_mask_window_b Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear binary image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_gl_d Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_gl_f Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_gl_i Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_gl_s Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_gl_uc Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_gl_ui Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_gl_us Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Bool gan_image_mask_window_p Gan_Image   pImage,
unsigned    r0,
unsigned    c0,
unsigned    height,
unsigned    width
 

Clear image except in specified rectangular region.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.

size_t gan_image_min_stride Gan_ImageFormat    format,
Gan_Type    type,
unsigned long    width,
size_t    alignment
 

Returns the minimum size of a row of image pixels in bytes.

Parameters:
format The format of the image pixel
type The type of the image pixel
width The number of image pixels on a row
alignment The byte alignment of a row of the image or zero
Returns:
The number of bytes in a row.
Returns the minimum size of a row of image pixels in bytes, given the format, type and width of the image. The size is padded to a multiple of the alignment value, unless alignment is passed as zero, in which case no padding occurs.

size_t gan_image_pixel_size Gan_ImageFormat    format,
Gan_Type    type
 

Returns the size of an image pixel in bytes.

Parameters:
format The format of the image pixel
type The type of the image pixel
Returns:
The size of the image pixel.
Returns the size of an image pixel in bytes.

Gan_Bool gan_image_set_data_free_func Gan_Image   img,
void(*    data_free_func)(void *)
 

Sets the function to free the image data buffer.

Parameters:
img The image
data_free_func The free function
Returns:
GAN_TRUE on success, or GAN_FALSE on failure.
For images that have been created using a user-supplied data buffer, provide a function to use to free the user data buffer.

Gan_Image* gan_image_set_format_type_dims_gen Gan_Image   img,
Gan_ImageFormat    format,
Gan_Type    type,
unsigned long    height,
unsigned long    width,
unsigned long    stride,
Gan_Bool    alloc_pix_data
 

Sets the format, type, dimensions and stride of an image.

Parameters:
img Pointer to the image
format The format to set the image
type The type to set the image
height The height to set the image
width The width to set the image
stride The stride of the image in bytes
alloc_pix_data Whether or not to allocate the pixel data
Returns:
Pointer to the successfully modified image, or NULL on failure.
Sets the format, type, height, width and stride of an image.

Gan_Bool gan_image_set_pix Gan_Image   img,
unsigned    row,
unsigned    col,
Gan_Pixel   pix
 

Sets a pixel in an image.

Parameters:
img The image
row The row position of the pixel
col The column position of the pixel
pix The pixel to set
Returns:
GAN_TRUE on success, or GAN_FALSE on failure.
Sets the pixel an image img at position row, col to the given value pix.

See also:
gan_image_get_pix().

Gan_Bool gan_image_set_pix_zero Gan_Image   img,
unsigned    row,
unsigned    col
 

Sets a pixel in an image to zero.

Parameters:
img The image
row The row position of the pixel
col The column position of the pixel
Returns:
GAN_TRUE on success, or GAN_FALSE on failure.
Sets the pixel in image img at position row, col to zero.
See also:
gan_image_set_pix().


Generated on Mon Oct 13 16:14:48 2003 by doxygen1.3-rc1