imaqClearOverlay
Usage
int imaqClearOverlay(Image* image, const char* group);
Purpose
Removes all overlay information associated with the image.
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL
Parameters
|
Name
|
Type
|
Description
|
|---|---|---|
| image | Image* | The image from which the function removes all overlay information. |
| group | const char* | Overlay group name to clear. Set this parameter to NULL to clear all overlays. |
Return Value
| Type |
Description |
|---|---|
| int | On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError(). |