imaqSetupRing

NI Vision for LabWindows/CVI Function

imaqSetupRing

Usage

int imaqSetupRing(SESSION_ID sessionID, Image** images, int numImages, int skipCount, Rect rect);

Purpose

Configures a ring acquisition. A ring acquisition acquires images continuously and loops them into a buffer list. To start the acquisition, call imaqStartAcquisition(). To stop the acquisition, call imaqStopAcquisition(). To get an image from the ring, call imaqExtractFromRing() or imaqCopyFromRing(). Do not modify or dispose of the images in the ring until you end the acquisition with imaqStopAcquisition().

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL

Parameters

Name

Type

Description

sessionID SESSION_ID A valid session ID.
images Image** An array of images. Each element in the array must be a pointer to a valid image.
numImages int The number of images in the images array.
skipCount int The number of frames to skip between each acquired image. A skipCount of 0 acquires images continuously without skipping frames between acquired images.
rect Rect The area to acquire. Set this parameter to IMAQ_NO_RECT to acquire the entire acquisition window.

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