Pixel format

Functions
peak_status	peak_IPL_PixelFormat_GetList (peak_camera_handle hCam, peak_pixel_format inputPixelFormat, peak_pixel_format *outputPixelFormatList, size_t *outputPixelFormatCount)
	Get a list of supported output pixel formats for a specific input pixelformat. More...
peak_status	peak_IPL_PixelFormat_Set (peak_camera_handle hCam, peak_pixel_format pixelFormat)
	Set the output pixel format for host processing. More...
peak_status	peak_IPL_PixelFormat_Get (peak_camera_handle hCam, peak_pixel_format *pixelFormat)
	Get the output pixel format of the host processing. More...

Detailed Description

Pixel format related functions and types.

This feature is applied in the host.
There is also a camera implementation. See Pixel format.

Function Documentation

peak_IPL_PixelFormat_Get()

peak_status peak_IPL_PixelFormat_Get	(	peak_camera_handle	hCam,
		peak_pixel_format *	pixelFormat
	)

Get the output pixel format of the host processing.

Reads the current output pixel format of the host processing.

Parameters

[in]	hCam	The camera handle.
[out]	pixelFormat	The pixel format.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER pixelFormat is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_IPL_PixelFormat_GetList()

peak_status peak_IPL_PixelFormat_GetList	(	peak_camera_handle	hCam,
		peak_pixel_format	inputPixelFormat,
		peak_pixel_format *	outputPixelFormatList,
		size_t *	outputPixelFormatCount
	)

Get a list of supported output pixel formats for a specific input pixelformat.

Pixelformats can only be converted to specific other pixelformats. Queries a list which pixelformats a specific input pixelformat can be converted to.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	inputPixelFormat	The input pixelformat, which is to be converted
[out]	outputPixelFormatList	Pointer to a user allocated array buffer to receive the list of pixelformats, to which to inputPixelFormat can be converted. If this parameter is NULL, outputPixelFormatCount will contain the number of possible output pixelformats. The required size of outputPixelFormatList in bytes is outputPixelFormatCount x sizeof(peak_pixel_format).
[in,out]	outputPixelFormatCount	outputPixelFormatList equal NULL: out: minimal number of pixelformats outputPixelFormatList must be large enough to hold outputPixelFormatList unequal NULL: in: number of pixelformats hotpixelList can hold out: number of pixelformats filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_BUFFER_TOO_SMALL outputPixelFormatList is not NULL and the value of *outputPixelFormatCount is too small to receive the expected amount of data.

PEAK_STATUS_INVALID_PARAMETER inputPixelFormat is an invalid pixel format or outputPixelFormatCount is an invalid pointer. Check peak_pixel_format.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_IPL_PixelFormat_Set()

peak_status peak_IPL_PixelFormat_Set	(	peak_camera_handle	hCam,
		peak_pixel_format	pixelFormat
	)

Set the output pixel format for host processing.

Writes the desired output pixel format that input frames are to be converted to with the host image processing pipeline. Frames can only be converted to specific output pixel formats, depending on the frame's pixelformat. Use peak_IPL_PixelFormat_GetList check which pixelformat can be converted.

Note

Frames can only be converted to non-packed and non-grouped pixelformats, except PEAK_PIXEL_FORMAT_RGB10P32 and PEAK_PIXEL_FORMAT_BGR10P32.

Parameters

[in]	hCam	The camera handle.
[in]	pixelFormat	The pixel format to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE pixelFormat is out of range. Check the range of valid values via peak_IPL_PixelFormat_GetList.

PEAK_STATUS_INVALID_PARAMETER pixelFormat is an invalid pixel format. Check peak_pixel_format.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.