imaqCreateOverlayFromROI

Usage

Overlay* imaqCreateOverlayFromROI(const ROI* roi);

Purpose

Creates a window overlay from a region of interest (ROI). This function is obsolete. You should use imaqOverlayROI() instead. The new function overlays the ROI directly on to the image instead of returning an overlay.

Note  This function is obsolete. The replacement function is imaqOverlayROI(), which overlays the ROI directly on to the image instead of returning an overlay.

Parameters

Name	Type	Description
roi	const ROI*	The region of interest to convert into an overlay.

Return Value

Type	Description
Overlay*	On success, this function returns an overlay. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you are finished with the overlay, dispose of it by calling imaqDispose().