IG_IP_flip

---

Group: Image Processing

Declaration:

AT_ERRCOUNT ACCUAPI IG_IP_flip (HIGEAR hIGear, AT_MODE nDirection ); 

Arguments:

hIGear	HIGEAR handle of image to flip
nDirection	IG_FLIP_HORIZONTAL or IG_FLIP_VERTICAL, telling whether to flip horizontally or vertically

Description:

Flips the image referenced by hIGear either horizontally or vertically. Flipping horizontally exchanges the right-most pixel column of the image bitmap with the left-most. Flipping vertically exchanges the topmost pixel row (raster) of the image bitmap with the bottom-most. The dimensions of the image do not change.

NOTE: If you want to turn the image upside-down (not the same as a vertical flip), use function IG_IP_rotate_multiple_90(), with rotation mode set to IG_ROTATE_180.

There is the global control parameter IP.ALPHA_PROCESSING_ENABLE telling whether this function should check and process associated alpha images. If this parameter is TRUE (default), the function checks HIGEAR for the presence of associated alpha images and apply the same operation on them. If this parameter is FALSE, only the main HIGEAR image is processed (backward compatible behavior).

Bits Per Pixel: 1, 4, 8, 9-16-bit gray level, 24, 32

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Example:

HIGEAR		 hIGear;    /* Handle of image to flip    */ 

AT_ERRCOUNT		 nErrcount;    /* Will hold ret'd count of errors  */ 

	/* Flip such that top row becomes bottom row, etc.:  */ 

nErrcount = IG_IP_flip ( hIGear, IG_FLIP_VERTICAL ); 

Sample: IMG_PROC, TIMING, ART