RtGVGetFramePixelFormat

RtGVGetFramePixelFormat gets the currently configured pixel format on a camera.

Syntax

BOOL RtGVGetFramePixelFormat(
	HANDLE cameraHandle, 
	PGVSP_PIXEL_TYPE pPixelFormat
);

Parameters

cameraHandle

The handle of the camera being queried.

pPixelFormat

Pointer to a GVSP_PIXEL_TYPE that receives the pixel format currently configured on the camera specified by cameraHandle.

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

RtGVGetFramePixelDepth

RtGVStartReceiveStream

GVSP_PIXEL_TYPE