Frame

Modules
	Frame info

Typedefs
typedef struct peak_frame *	peak_frame_handle
	peak Frame handle

Functions
peak_status	peak_Frame_Release (peak_camera_handle hCam, peak_frame_handle hFrame)
	Release a frame.

Detailed Description

Frame related functions and types.

Typedef Documentation

peak_frame_handle

typedef struct peak_frame* peak_frame_handle

peak Frame handle

A frame represents an image or other types of bulk data received from a camera. It collects all information on the received data.

See also

peak_frame_info.

The frame handle represents a frame which is delivered to the user.
The frame handle is provided by peak_Acquisition_WaitForFrame and must be released by peak_Frame_Release.
The frame handle is required by the peak_Frame_Xxx functions to query information on the received frame.

As long as a frame is in the hands of the user (i.e. delivered) the implementation will not store any data to the associated buffer.
As soon as the frame is released via peak_Frame_Release new data can be stored in the associated buffer.

Note

peak_Acquisition_Start will be rejected as long as there are unreleased frame handles.

The value for an invalid frame handle is PEAK_INVALID_HANDLE.

Function Documentation

peak_Frame_Release()

peak_status peak_Frame_Release	(	peak_camera_handle	hCam,
		peak_frame_handle	hFrame
	)

Release a frame.

Releases a frame that was previously received from peak_Acquisition_WaitForFrame or from Xxx.

The buffer that is bound to the specified frame is unlocked, so that ist can receive new image data.

Parameters

[in]	hCam	The camera handle.
[in]	hFrame	Handle to the frame to release.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hCam and/or hFrame are invalid handles.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Note

The frame handle is no longer valid after the function has returned.

peak_Acquisition_Start will be rejected as long as there are unreleased frame handles for frames that were received from peak_Acquisition_WaitForFrame.