imaqMergeOverlay

Usage

int imaqMergeOverlay(Image* dest, const Image* source, const RGBValue* palette, unsigned int numColors, const char* group);

Purpose

Makes a nondestructive overlay part of the image content. This process creates a destructive overlay. The VI then removes the nondestructive overlay. The resulting image is an RGB 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.
palette	const RGBValue*	An optional palette to associate with 8-bit images. If this parameter is not NULL, it must point to an array of 256 colors, which represent the color palette that the function associates with the image. If this parameter is NULL, the function associates a grayscale palette with the image.
numColors	unsigned int	The number of RGBValues in the palette array. If there are less than 256 entries in palette, the function maps all pixel values past the last element in palette to the associated grayscale value.
group	const char*	Overlay group name to merge. Set this parameter to NULL to merge 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().