RTGV_FRAME Structure

RTGV_FRAME is a structure that contains frames grabbed from the camera.

Syntax

typedef struct _RTGV_FRAME{
    DWORD         size;
    UINT32        pixelDepth;
    UINT32        pixelFormat;
    UINT32        numberOfChannels;
    UINT32        CvArrayType;
    UINT32        offsetX;
    UINT32        offsetY;
    UINT32        width;
    UINT32        height;
    UINT32        paddingX;
    UINT32        paddingY;
    UINT64        frameSize;
    LARGE_INTEGER cameraTimeStamp; 
    UINT64        offsetToImageData;
    PVOID         pCustomMetaData;
    PCHAR         imageData; 
} RTGV_FRAME, *PRTGV_FRAME;

Members

size

The size of this structure (in bytes).  Client code must set this member to sizeof(RTGV_FRAME) before passing this structure to any function. This is used to identify the version of this structure if it is extended.

pixelDepth

The pixel depth (bits-per-channel) of the frame.

pixelFormat

The pixel format of the frame (i.e. RGB24, Mono8, etc.)

numberOfChannels

The number of channels for the frame (i.e. 3 for RGB, 1 for Mono, etc.)

CvArrayType

The array type of the frame.

offsetX

The X offset of the frame from the frame origin.

offsetY

The Y offset of the frame from the frame origin.

width

The width of the frame.

height

The height of the frame.

paddingX

Horizontal padding, in bytes, transmitted at the end of each line to facilitate frame alignment in buffers.

paddingY

Vertical padding, in bytes, transmitted at the end of each frame to facilitate frame alignment in buffers.

frameSize

The size of the frame in bytes.

cameraTimeStamp

The timestamp of the frame, from the camera.

offsetToImageData

The offset to the image data, for sharing between different virtual address spaces.

pCustomMetaData

A pointer to custom metadata.

imageData

A pointer to the image data.  This value should be equal to the pointer to the RTGV_FRAME plus offsetToImageData.

Requirements