imaqSetMaskOffset

NI Vision for LabWindows/CVI Function

imaqSetMaskOffset

Usage

int imaqSetMaskOffset(Image* image, Point offset);

Purpose

When the given image is used as a mask, sets the location in the source image at which the function places the (0,0) pixel of the mask 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 mask image whose offset the function sets.
offset Point The coordinates where the function applies the mask.

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