Struct VmbFrame

Struct Documentation

struct VmbFrame

Frame delivered by the camera.

In

void *buffer

Comprises image and potentially chunk data.

VmbUint32_t bufferSize

The size of the data buffer.

void *context[4]

4 void pointers that can be employed by the user (e.g. for storing handles)

Out

VmbFrameStatus_t receiveStatus

The resulting status of the receive operation.

VmbUint64_t frameID

Unique ID of this frame in this stream.

VmbUint64_t timestamp

The timestamp set by the camera.

VmbUint8_t *imageData

The start of the image data, if present, or null.

VmbFrameFlags_t receiveFlags

Flags indicating which additional frame information is available.

VmbPixelFormat_t pixelFormat

Pixel format of the image.

VmbImageDimension_t width

Width of an image.

VmbImageDimension_t height

Height of an image.

VmbImageDimension_t offsetX

Horizontal offset of an image.

VmbImageDimension_t offsetY

Vertical offset of an image.

VmbPayloadType_t payloadType

The type of payload.

VmbBool_t chunkDataPresent

True if the transport layer reported chunk data to be present in the buffer.