imaqGetMaskOffset

NI Vision for LabWindows/CVI Function

imaqGetMaskOffset

Usage

int imaqGetMaskOffset(const Image* image, Point* offset);

Purpose

Retrieves the point in the source image at which the function places the (0,0) pixel of the mask image, as set by imaqSetMaskOffset().

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 const Image* The mask image that the function retrieves the offset for.
offset Point* On return, the coordinates where the function applies the mask. This parameter is required and cannot be NULL.

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