imaqOverlayOval
Usage
int imaqOverlayOval(Image* image, Rect boundingBox, const RGBValue* color, DrawMode drawMode, char* group);
Purpose
Overlays an oval onto an 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, IMAQ_IMAGE_RGB_U64
Parameters
|
Name
|
Type
|
Description
|
|---|---|---|
| image | Image* | The image on which to overlay the oval. |
| boundingBox | Rect | The coordinate location of the bounding rectangle of the oval. |
| color | const RGBValue* | The color of the oval. The alpha color channel is not supported. Setting the color to transparent has the same effect as selecting black. This parameter is required and cannot be NULL. |
| drawMode | DrawMode | The mode by which to draw the overlay. Valid options are IMAQ_DRAW_VALUE and IMAQ_PAINT_VALUE. |
| group | char* | The group to which you want to add the overlay. Set this parameter to NULL to add the overlay to the default group. |
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(). |