imaqOverlayPoints

Usage

int imaqOverlayPoints(Image* image, const Point* points, int numPoints, const RGBValue* colors, int numColors, PointSymbol symbol, const UserPointSymbol* userSymbol, const char* group);

Purpose

Overlays a series of points 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 points.
points	const Point*	An array describing the coordinate location of each point to overlay. This parameter is required and cannot be NULL.
numPoints	int	The number of points in the array.
colors	const RGBValue*	An array describing the color of each point to overlay. If the array of colors is smaller then the array of points, the function assigns the final color in the array to each point that does not have a corresponding color. 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.
numColors	int	The number of RGBValues in the array.
symbol	PointSymbol	The symbol the function uses to represent each point the function overlays.
userSymbol	const UserPointSymbol*	If symbol is IMAQ_POINT_AS_USER_DEFINED, this parameter defines the symbol. Otherwise, the function ignores this parameter and you should set it to NULL.
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().