peak Frame info More...

Data Fields
peak_frame_type	type
	The type and format of the contents of the frame.

peak_buffer	buffer
	The memory buffer that stores the frame contents.

uint64_t	frameID
	The frame id. More...

uint64_t	timestamp_ns
	The timestamp in nanoseconds. More...

peak_roi	roi
	The ROI of the frame.

peak_pixel_format	pixelFormat
	The pixel format.

peak_bool	isComplete
	'Complete' flag More...

size_t	bytesExpected
	The number of bytes expected for a complete image. More...

size_t	bytesWritten
	The number of bytes actually written to the buffer. More...

uint32_t	processingTime_ms
	The host side processing time. More...

Detailed Description

peak Frame info

The frame info collects information on an acquired frame.

Field Documentation

size_t bytesExpected

The number of bytes expected for a complete image.

This value may be smaller than buffer.memorySize

if the buffer was announced via peak_Acquisition_Buffer_Announce and is larger than required.

size_t bytesWritten

The number of bytes actually written to the buffer.

This value may be smaller than buffer.memorySize

if the frame is incomplete (see isIncomplete), or
if the buffer was announced via peak_Acquisition_Buffer_Announce and is larger than required. See bytesExpected.

uint64_t frameID

The frame id.

The frame id is incremented with every acquired frame. It is reset to 0 on peak_Acquisition_Start.

The frame id may jump forwards from one delivered frame to another. A jump in the frame id indicates a Dropped Frame.

peak_bool isComplete

'Complete' flag

uint32_t processingTime_ms

The host side processing time.

The time in milliseconds that the host side pixel processing took in total.

uint64_t timestamp_ns

The timestamp in nanoseconds.

The point in camera time at which the image was exposed.

The documentation for this struct was generated from the following file: