RtGVGetFramePixelDepth

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

Syntax

BOOL RtGVGetFramePixelDepth(
	HANDLE cameraHandle, 
	PUINT32 pPixelDepth
);

Parameters

cameraHandle

The handle of the camera being queried.

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 (ie. mono8 means a pixel depth of 8, whereas RGB16 means a pixel depth of 16).

Return Values

Returns TRUE if the function succeeds, FALSE if the function fails. Call GetLastError for extended error information.

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 of the cameras found on the network, along with each of their handles.

Requirements

Minimum Supported Version RTX64 4.1 Vision SDK

Header

RtGVApi.h

Library

RtGigEVision.lib

See Also:

RtGVEnumerateCameras

RtGVGetFrameNumberOfChannels

RtGVGetFramePixelFormat