imaqIsImageEmpty

Usage

int imaqIsImageEmpty(const Image* image, int* empty);

Purpose

Tests to see if the supplied image is empty. An empty image is an image that contains only pixels with a value equal to zero. Use this function in conjunction with imaqCompare() and imaqCompareConstant() to see if the compare operation cleared all of the pixels in an image.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL

Parameters

Name	Type	Description
image	const Image*	The image that the function checks for emptiness.
empty	int*	On return, this parameter equals TRUE if the image is empty and FALSE if the image contains pixels with values other than 0. 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().