Data Structures
struct	peak_pixel_format_info
	peak Pixel format info More...

Enumerations
enum	peak_pixel_format { PEAK_PIXEL_FORMAT_INVALID , PEAK_PIXEL_FORMAT_BAYER_GR8 , PEAK_PIXEL_FORMAT_BAYER_GR10 , PEAK_PIXEL_FORMAT_BAYER_GR12 , PEAK_PIXEL_FORMAT_BAYER_RG8 , PEAK_PIXEL_FORMAT_BAYER_RG10 , PEAK_PIXEL_FORMAT_BAYER_RG12 , PEAK_PIXEL_FORMAT_BAYER_GB8 , PEAK_PIXEL_FORMAT_BAYER_GB10 , PEAK_PIXEL_FORMAT_BAYER_GB12 , PEAK_PIXEL_FORMAT_BAYER_BG8 , PEAK_PIXEL_FORMAT_BAYER_BG10 , PEAK_PIXEL_FORMAT_BAYER_BG12 , PEAK_PIXEL_FORMAT_MONO8 , PEAK_PIXEL_FORMAT_MONO10 , PEAK_PIXEL_FORMAT_MONO12 , PEAK_PIXEL_FORMAT_RGB8 , PEAK_PIXEL_FORMAT_RGB10 , PEAK_PIXEL_FORMAT_RGB12 , PEAK_PIXEL_FORMAT_BGR8 , PEAK_PIXEL_FORMAT_BGR10 , PEAK_PIXEL_FORMAT_BGR12 , PEAK_PIXEL_FORMAT_RGBA8 , PEAK_PIXEL_FORMAT_RGBA10 , PEAK_PIXEL_FORMAT_RGBA12 , PEAK_PIXEL_FORMAT_BGRA8 , PEAK_PIXEL_FORMAT_BGRA10 , PEAK_PIXEL_FORMAT_BGRA12 , PEAK_PIXEL_FORMAT_BAYER_GR10P , PEAK_PIXEL_FORMAT_BAYER_GR12P , PEAK_PIXEL_FORMAT_BAYER_RG10P , PEAK_PIXEL_FORMAT_BAYER_RG12P , PEAK_PIXEL_FORMAT_BAYER_GB10P , PEAK_PIXEL_FORMAT_BAYER_GB12P , PEAK_PIXEL_FORMAT_BAYER_BG10P , PEAK_PIXEL_FORMAT_BAYER_BG12P , PEAK_PIXEL_FORMAT_MONO10P , PEAK_PIXEL_FORMAT_MONO12P , PEAK_PIXEL_FORMAT_RGB10P32 , PEAK_PIXEL_FORMAT_BGR10P32 , PEAK_PIXEL_FORMAT_BAYER_GR10G40_IDS , PEAK_PIXEL_FORMAT_BAYER_RG10G40_IDS , PEAK_PIXEL_FORMAT_BAYER_GB10G40_IDS , PEAK_PIXEL_FORMAT_BAYER_BG10G40_IDS , PEAK_PIXEL_FORMAT_BAYER_GR12G24_IDS , PEAK_PIXEL_FORMAT_BAYER_RG12G24_IDS , PEAK_PIXEL_FORMAT_BAYER_GB12G24_IDS , PEAK_PIXEL_FORMAT_BAYER_BG12G24_IDS , PEAK_PIXEL_FORMAT_MONO10G40_IDS , PEAK_PIXEL_FORMAT_MONO12G24_IDS }
	peak Pixel format More...

Functions
peak_status	peak_PixelFormat_GetInfo (peak_pixel_format pixelFormat, peak_pixel_format_info *pixelFormatInfo)
	Query the pixel format info.

peak_access_status	peak_PixelFormat_GetAccessStatus (peak_camera_handle hCam)
	Query the pixel format access status.

peak_status	peak_PixelFormat_GetList (peak_camera_handle hCam, peak_pixel_format pixelFormatList, size_t pixelFormatCount)
	Get the list of currently selectable pixel formats.

peak_status	peak_PixelFormat_Set (peak_camera_handle hCam, peak_pixel_format pixelFormat)
	Set the pixel format.

peak_status	peak_PixelFormat_Get (peak_camera_handle hCam, peak_pixel_format *pixelFormat)
	Get the pixel format.

peak_status	peak_VideoWriter_Encoder_GetPixelFormatList (peak_video_encoder encoder, peak_pixel_format pixelFormatList, size_t pixelFormatCount)
	Get the list of currently selectable pixel formats.

Detailed Description

Pixel format related functions and types.

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

Enumeration Type Documentation

◆ peak_pixel_format

enum peak_pixel_format

peak Pixel format

The pixel format specifies the representation of a pixel in an image.

Enumerator
PEAK_PIXEL_FORMAT_INVALID	Invalid pixel format. Use this value for the initialization of variables of type peak_pixel_format.
PEAK_PIXEL_FORMAT_BAYER_GR8	BayerGR8.
PEAK_PIXEL_FORMAT_BAYER_GR10	BayerGR10.
PEAK_PIXEL_FORMAT_BAYER_GR12	BayerGR12.
PEAK_PIXEL_FORMAT_BAYER_RG8	BayerRG8.
PEAK_PIXEL_FORMAT_BAYER_RG10	BayerRG10.
PEAK_PIXEL_FORMAT_BAYER_RG12	BayerRG12.
PEAK_PIXEL_FORMAT_BAYER_GB8	BayerGB8.
PEAK_PIXEL_FORMAT_BAYER_GB10	BayerGB10.
PEAK_PIXEL_FORMAT_BAYER_GB12	BayerGB12.
PEAK_PIXEL_FORMAT_BAYER_BG8	BayerBG8.
PEAK_PIXEL_FORMAT_BAYER_BG10	BayerBG10.
PEAK_PIXEL_FORMAT_BAYER_BG12	BayerBG12.
PEAK_PIXEL_FORMAT_MONO8	Mono8.
PEAK_PIXEL_FORMAT_MONO10	Mono10.
PEAK_PIXEL_FORMAT_MONO12	Mono12.
PEAK_PIXEL_FORMAT_RGB8	RGB8.
PEAK_PIXEL_FORMAT_RGB10	RGB10.
PEAK_PIXEL_FORMAT_RGB12	RGB12.
PEAK_PIXEL_FORMAT_BGR8	BGR8.
PEAK_PIXEL_FORMAT_BGR10	BGR10.
PEAK_PIXEL_FORMAT_BGR12	BGR12.
PEAK_PIXEL_FORMAT_RGBA8	RGBa8.
PEAK_PIXEL_FORMAT_RGBA10	RGBa10.
PEAK_PIXEL_FORMAT_RGBA12	RGBa12.
PEAK_PIXEL_FORMAT_BGRA8	BGRa8.
PEAK_PIXEL_FORMAT_BGRA10	BGRa10.
PEAK_PIXEL_FORMAT_BGRA12	BGRa12.
PEAK_PIXEL_FORMAT_BAYER_GR10P	BayerGR10 packed.
PEAK_PIXEL_FORMAT_BAYER_GR12P	BayerGR12 packed.
PEAK_PIXEL_FORMAT_BAYER_RG10P	BayerRG10 packed.
PEAK_PIXEL_FORMAT_BAYER_RG12P	BayerRG12 packed.
PEAK_PIXEL_FORMAT_BAYER_GB10P	BayerGB10 packed.
PEAK_PIXEL_FORMAT_BAYER_GB12P	BayerGB12 packed.
PEAK_PIXEL_FORMAT_BAYER_BG10P	BayerBG10 packed.
PEAK_PIXEL_FORMAT_BAYER_BG12P	BayerBG12 packed.
PEAK_PIXEL_FORMAT_MONO10P	Mono10 packed.
PEAK_PIXEL_FORMAT_MONO12P	Mono12 packed.
PEAK_PIXEL_FORMAT_RGB10P32	RGB10 packed 32.
PEAK_PIXEL_FORMAT_BGR10P32	BGR10 packed 32.
PEAK_PIXEL_FORMAT_BAYER_GR10G40_IDS	BayerGR10 grouped 40. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_BAYER_RG10G40_IDS	BayerRG10 grouped 40. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_BAYER_GB10G40_IDS	BayerGB10 grouped 40. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_BAYER_BG10G40_IDS	BayerBG grouped 40. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_BAYER_GR12G24_IDS	BayerGR12 grouped 24. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_BAYER_RG12G24_IDS	BayerRG12 grouped 24. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_BAYER_GB12G24_IDS	BayerGB12 grouped 24. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_BAYER_BG12G24_IDS	BayerBG12 grouped 24. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_MONO10G40_IDS	Mono10 grouped 40. Note This pixel format is preliminary and its name and value may change in a future product version.
PEAK_PIXEL_FORMAT_MONO12G24_IDS	Mono12 grouped 24. Note This pixel format is preliminary and its name and value may change in a future product version.

Function Documentation

◆ peak_PixelFormat_Get()

peak_status peak_PixelFormat_Get	(	peak_camera_handle	hCam,
		peak_pixel_format *	pixelFormat
	)

Get the pixel format.

Reads the current pixel format.

Parameters

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

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The pixel format feature is not available for read access. Check the access status via peak_PixelFormat_GetAccessStatus.; 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_PixelFormat_GetAccessStatus()

peak_access_status peak_PixelFormat_GetAccessStatus ( peak_camera_handle hCam )

Query the pixel format access status.

Provides the current access status for the pixel format feature.

This function implements the Access Status Query principle.

Parameters

[in] hCam The camera handle.

Returns: PEAK_ACCESS_READWRITE The pixel format feature is readable and writeable.; PEAK_ACCESS_READONLY The pixel format feature is readable only.; PEAK_ACCESS_GFA_LOCK The pixel format feature is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The pixel format feature is not accessible.; PEAK_ACCESS_NOT_SUPPORTED The pixel format feature is not supported.; PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

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_PixelFormat_GetInfo()

peak_status peak_PixelFormat_GetInfo	(	peak_pixel_format	pixelFormat,
		peak_pixel_format_info *	pixelFormatInfo
	)

Query the pixel format info.

Provides the pixel format information on the specified pixel format.

Parameters

[in]	pixelFormat	The pixel format of interest.
[out]	pixelFormatInfo	The pixel format info.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER pixelFormat is an invalid pixel format or pixelFormatInfo is an invalid pointer. Check peak_pixel_format.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_PixelFormat_GetList()

peak_status peak_PixelFormat_GetList	(	peak_camera_handle	hCam,
		peak_pixel_format *	pixelFormatList,
		size_t *	pixelFormatCount
	)

Get the list of currently selectable pixel formats.

Queries the list of currently selectable pixel formats.

The list of selectable pixel formats may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	pixelFormatList	Pointer to a user allocated array buffer to receive the pixel format list. If this parameter is NULL, `pixelFormatCount` will contain the current number of pixel formats. The required size of `pixelFormatList` in bytes is `pixelFormatCount` x sizeof(peak_pixel_format).
[in,out]	pixelFormatCount	`pixelFormatList` equal NULL: out: minimal number of pixel formats `pixelFormatList` must be large enough to hold `pixelFormatList` unequal NULL: in: number of pixel formats `pixelFormatList` can hold out: number of pixel formats filled by the function

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_BUFFER_TOO_SMALL pixelFormatList is not NULL and the value of *pixelFormatCount is too small to receive the expected amount of data.; PEAK_STATUS_ACCESS_DENIED The pixel format feature is not accessible. Check the access status of the pixel format feature via peak_PixelFormat_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER pixelFormatCount 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.

Note: Consider that the pixel format list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

◆ peak_PixelFormat_Set()

peak_status peak_PixelFormat_Set	(	peak_camera_handle	hCam,
		peak_pixel_format	pixelFormat
	)

Set the pixel format.

Writes the desired pixel format.

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_PixelFormat_GetList.; PEAK_STATUS_ACCESS_DENIED The pixel format feature is not available for write access. Check the access status via peak_PixelFormat_GetAccessStatus.; 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_VideoWriter_Encoder_GetPixelFormatList()

peak_status peak_VideoWriter_Encoder_GetPixelFormatList	(	peak_video_encoder	encoder,
		peak_pixel_format *	pixelFormatList,
		size_t *	pixelFormatCount
	)

Get the list of currently selectable pixel formats.

Queries the list of currently selectable pixel formats.

The list of selectable pixel formats may depend on the given encoder.

This function implements the Two Staged Data Query principle.

Parameters

[in]	encoder	Encoder
[out]	pixelFormatList	Pointer to a user allocated array buffer to receive the pixel format list. If this parameter is NULL, `pixelFormatCount` will contain the current number of pixel formats. The required size of `pixelFormatList` in bytes is `pixelFormatCount` x sizeof(peak_pixel_format).
[in,out]	pixelFormatCount	`pixelFormatList` equal NULL: out: minimal number of pixel formats `pixelFormatList` must be large enough to hold `pixelFormatList` unequal NULL: in: number of pixel formats `pixelFormatList` can hold out: number of pixel formats filled by the function

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_BUFFER_TOO_SMALL pixelFormatList is not NULL and the value of *pixelFormatCount is too small to receive the expected amount of data.; PEAK_STATUS_ACCESS_DENIED The pixel format feature is not accessible. Check the access status of the pixel format feature via peak_PixelFormat_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER encoder is an invalid encoder or pixelFormatCount is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Note: Consider that the pixel format list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ peak_pixel_format

Function Documentation

◆ peak_PixelFormat_Get()

◆ peak_PixelFormat_GetAccessStatus()

◆ peak_PixelFormat_GetInfo()

◆ peak_PixelFormat_GetList()

◆ peak_PixelFormat_Set()

◆ peak_VideoWriter_Encoder_GetPixelFormatList()