imaqSetOverlayProperties

NI Vision for LabWindows/CVI Function

imaqSetOverlayProperties

Usage

int imaqSetOverlayProperties(Image* image, const char* group, TransformBehaviors* transformBehaviors);

Purpose

Sets the transformation behavior information for a specified overlay group.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, 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 for which you want to set the overlay properties.
group const char* Specifies an overlay group name within the image. Set this parameter to NULL to specify all groups.
transformBehaviors TransformBehaviors* Specifies the current overlay behavior when an image is transformed.

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().