Main Page   Modules   Compound List   File List   Compound Members   File Members  

image_defs.h File Reference

#include <stdlib.h>
#include <gandalf/image/pixel.h>
#include <gandalf/common/misc_defs.h>

Go to the source code of this file.

Compounds

struct  Gan_Image
 structure definition for image More...

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


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_alloc (Gan_ImageFormat format, Gan_Type type, unsigned long height, unsigned long width)
 Macro: Allocate and return a new image.

Gan_Imagegan_image_form (Gan_Image *img, Gan_ImageFormat format, Gan_Type type, unsigned long height, unsigned long width)
 Macro: Forms and returns a new image.

Gan_Imagegan_image_alloc_data (Gan_ImageFormat format, Gan_Type type, unsigned long height, unsigned long width, void *pix_data, size_t pix_data_size, void *row_data, size_t row_data_size)
 Macro: Allocate image.

Gan_Imagegan_image_form_data (Gan_Image *img, Gan_ImageFormat format, Gan_Type type, unsigned long height, unsigned long width, void *pix_data, size_t pix_data_size, void *row_data, size_t row_data_size)
 Macro: Form image.

void gan_image_free (Gan_Image *img)
 Macro: Free an image.

Gan_Imagegan_image_copy_q (Gan_Image *img_s, Gan_Image *img_d)
 Macro: Copy an image.

Gan_Imagegan_image_copy_s (Gan_Image *img)
 Macro: Copy an image.

Gan_Imagegan_image_set_format_type_dims (Gan_Image *img, Gan_ImageFormat format, Gan_Type type, unsigned long height, unsigned long width)
 Macro: Set format, type and dimensions of image.

Gan_Imagegan_image_set_format_type (Gan_Image *img, Gan_ImageFormat format, Gan_Type type)
 Macro: Set format and type of image.

Gan_Imagegan_image_set_type (Gan_Image *img, Gan_Type type)
 Macro: Set type of image.

Gan_Imagegan_image_set_dims (Gan_Image *img, unsigned long height, unsigned long width)
 Macro: Set height and width of image.

Gan_Bool gan_image_test_format (Gan_Image *img, Gan_ImageFormat format)
 Macro: Test image format.

Gan_Bool gan_image_test_type (Gan_Image *img, Gan_Type type)
 Macro: Test image type.

Gan_Bool gan_image_test_dims (Gan_Image *img1, Gan_Image *img2)
 Macro: Test image dimensions.

Gan_Bool gan_image_fill_zero_window (Gan_Image *img, unsigned r0, unsigned c0, unsigned height, unsigned width)
 Macro: Fill window of image with zero.

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.


Detailed Description

Module: Image definitions and general functions

Part of: Gandalf Library

Revision: Last edited: Author:

Copyright: (c) 2000 Imagineer Software Limited


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