Bruxton Logo

SIDXAcquisitionGetSize

Syntax

C/C++

int SIDXAcquisitionGetSize(void* camera, int roi_index, int* bytes, int* pixels_x, int* pixels_y);

Visual Basic

Function SIDXAcquisitionGetSize (ByVal camera As Long, ByVal roi_index As Long, bytes As Long, pixels_x As Long, pixels_y As Long) As Long

IGOR Pro

SIDXAcquisitionGetSize camera, roi_index, bytes, pixels_x, pixels_y, status

ITT IDL

status = SIDXAcquisitionGetSize(camera, roi_index, bytes, pixels_x, pixels_y)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
roi_index
The index of the ROI, starting from 0. When the full frame is selected, it is considered as one ROI.
bytes
A variable to receive the memory size, in bytes, required for storing a single image. The image can be full frame, if the full frame is selected, or an ROI.
pixels_x
A variable to receive the number of pixels in x dimension.
pixels_y
A variable to receive the number of pixels in y dimension.

The return value is non-zero if the function failed, zero if it succeeded.

Discussion

Use this function to obtain the size of the image being acquired. With this information, the user can allocate memory for display. Call this function after SIDXAcquisitionBegin... calls.