imaqCopyOverlay

Usage

int imaqCopyOverlay(Image* dest, const Image* source, const char* group);

Purpose

Copies overlay information existing in one image to another image. This overlay is added to the existing overlay information on the destination 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
dest	Image*	The destination image.
source	const Image*	The source image.
group	const char*	Overlay group name to copy. Set this parameter to NULL to copy 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().