imaqGetBytesPerPixel

NI Vision for LabWindows/CVI Function

imaqGetBytesPerPixel

Usage

int imaqGetBytesPerPixel(const Image* image, int* byteCount);

Purpose

Returns the number of bytes that a single pixel occupies in the given 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 const Image* The image whose bytes per pixel the function queries.
byteCount int* On return, the number of bytes per pixel. 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().