imaqOverlayBitmap
Usage
int imaqOverlayBitmap(Image* image, Point destLoc, const RGBValue* bitmap, unsigned int numCols, unsigned int numRows, const char* group);
Purpose
Overlays a bitmap 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 bitmap. |
| destLoc | Point | The coordinates of the pixel in the image where the function copies the top-left pixel of the bitmap. |
| bitmap | const RGBValue* | The two-dimensional array of bitmap values to overlay on the image. This parameter is required and cannot be NULL. |
| numCols | unsigned int | The number of columns in the bitmap array. |
| numRows | unsigned int | The number of rows in the bitmap array. |
| group | const 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(). |