RtgvGetFramePixelDepth

RtgvGetFramePixelDepth returns the number of bits-per-pixel currently configured on a camera.

Syntax

BOOL RtgvGetFramePixelDepth(
    [in]    HANDLE cameraHandle, 
    [out]   PUINT32 pPixelDepth
);

Parameters

[in] cameraHandle

The handle of the camera being queried.

[out] pPixelDepth

A pointer to an unsigned integer that receives the pixel depth of the camera (bits-per-channel).  This is dependent on the currently configured pixel format on the camera (i.e. mono8 means a pixel depth of 8, whereas RGB16 means a pixel depth of 16).

Return Values

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Remarks

This function will fail if it is called before RtgvInitialize and RtgvInitCameraControl.

To find the camera to query, call RtgvInitialize and then call RtgvEnumerateCameras to get an RTGV_CAMERA_INFO array describing each camera found on the network, along with its handles.

Requirements