ImageGear for C and C++ on Windows v19.1 - Updated
IG_REC_orientation_mode_set
API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Image Processing Functions > IG_REC_orientation_mode_set

Specifies which image orientation mode will be used during forthcoming IG_REC_PID_IMGPREPROCESS processes.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_orientation_mode_set(
   enumIGRecImgRotate ImgRotate
);

Arguments:

Name Type Description
ImgRotate enumIGRecImgRotate Image orientation mode to be set. Possible values are: IG_REC_IMG_ROTATE_AUTO, IG_REC_IMG_ROTATE_NO, IG_REC_IMG_ROTATE_RIGHT, IG_REC_IMG_ROTATE_DOWN, and IG_REC_IMG_ROTATE_LEFT.

Return Value:

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

Supported Raster Image Formats:

This function does not process image pixels.

Example:

 
Copy Code
AT_ERRCOUNT ErrCount = 0;
ErrCount = IG_REC_orientation_mode_set(IG_REC_IMG_ROTATE_AUTO);

Remarks:

The Image orientation mode can be automatic, switched off, or programmable.

This function does not currently support mirroring of the image.

  1. The auto-orientation feature (IG_REC_IMG_ROTATE_AUTO) works only on good quality, machine printed images. It does not work with 9-pin dot-matrix texts.
  2. When any of the IG_REC_IMG_ROTATE_FLIPPED, IG_REC_IMG_ROTATE_RIGHT_FLIPPED, IG_REC_IMG_ROTATE_DOWN_FLIPPED and IG_REC_IMG_ROTATE_LEFT_FLIPPED (enumIGRecImgRotate) enum values is specified, the function returns with non-zero value and sets Value1 parameter of the error to IGE_REC_API_PARAMETER_ERR. These mirroring parameters are available only through the immediate image rotation function IG_REC_image_orient.