IG_IP_NR_ROI_control

This function will return to you the current setting of any of the non-rectangular ROI control settings.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_IP_NR_ROI_control_get( HIGEAR hIGear, AT_MODE nAttributeID, VOID FAR32* lpData );

Arguments:

Name	Type	Description
hIGear	HIGEAR	HIGEAR handle of image for which you would like to query ROI settings.
nAttributeID	AT_MODE	Set to an AT_MODE constant for the type of attribute you wish to query. See Remarks.
lpData	VOID FAR32*	This returns the current setting of nAttributeID.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

Image Processing, FlashPix

Example:

	Copy Code
AT_ERRCOUNT nErrcount; HIGEAR hIGear; BOOL bUseNonRect; AT_POINT ptReferencePoint; /* Find out whether the image rectangle for hIGear is set to be overridden by a non- rectangular ROI / nErrcount = IG_IP_NR_ROI_control_get (hIGear, IG_CONTROL_NR_ROI_STATE, &bUseNonRect); / Find out what the reference point for a mask HIGEAR is in the hIGear */ nErrcount = IG_IP_NR_ROI_control_get (hIGear, IG_CONTROL_NR_ROI_REFERENCE_POINT, &ptReferencePoint);

Copy Code

AT_ERRCOUNT      nErrcount;
HIGEAR  hIGear;
BOOL    bUseNonRect;
AT_POINT        ptReferencePoint;
/* Find out whether the image rectangle for hIGear is set to be overridden by a non-
rectangular ROI    */
nErrcount = IG_IP_NR_ROI_control_get (hIGear, IG_CONTROL_NR_ROI_STATE, &bUseNonRect);
/* Find out what the reference point for a mask HIGEAR is in the hIGear */
nErrcount = IG_IP_NR_ROI_control_get (hIGear, IG_CONTROL_NR_ROI_REFERENCE_POINT,
&ptReferencePoint);

Remarks:

Supply ImageGear with the HIGEAR handle of the image you are querying and the attribute (nAttributeID) whose setting you would like to query. The ROI settings currently available are:

IG_CONTROL_NR_ROI_DIB: Returns the DIB which is currently set to be used as the mask HIGEAR.
IG_CONTROL_NR_ROI_REFERENCE_POINT: Returns the reference point of the mask.
IG_CONTROL_NR_ROI_REFERENCE_POINT_LEFT: Returns left point of the mask.
IG_CONTROL_NR_ROI_REFERENCE_POINT_TOP: Returns top point of the mask.
IG_CONTROL_NR_ROI_CONDITION: Queries the "condition" of the mask HIGEAR: whether it is set to be active or not active for the next IP or Clipboard operation.
IG_CONTROL_NR_ROI_VALIDATE: Returns TRUE if the current ROI mask is valid.

To change these settings and for details on how these controls can be used, see the description for IG_IP_NR_ROI_control_set().