Functions
peak_status	peak_IPL_AutoWhiteBalance_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
	Set the host auto white balance ROI mode.

peak_status	peak_IPL_AutoWhiteBalance_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
	Get the host auto white balance ROI mode.

peak_status	peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position minAutoWhiteBalanceROIOffset, peak_position maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
	Get the current range of valid host auto white balance ROI offsets.

peak_status	peak_IPL_AutoWhiteBalance_ROI_Size_GetRange (peak_camera_handle hCam, peak_size minAutoWhiteBalanceROISize, peak_size maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
	Get the current range of valid host auto white balance ROI sizes.

peak_status	peak_IPL_AutoWhiteBalance_ROI_Set (peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
	Set the host auto white balance ROI.

peak_status	peak_IPL_AutoWhiteBalance_ROI_Get (peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
	Get the host auto white balance ROI.

peak_status	peak_IPL_AutoWhiteBalance_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
	Set the host auto white balance control mode.

peak_status	peak_IPL_AutoWhiteBalance_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
	Get the host auto white balance control mode.

peak_status	peak_IPL_AutoWhiteBalance_SkipFrames_Set (peak_camera_handle hCam, uint32_t skipFrames)
	Set the skip frames for the auto white balance controller.

peak_status	peak_IPL_AutoWhiteBalance_SkipFrames_Get (peak_camera_handle hCam, uint32_t *skipFrames)
	Get the skip frames for the auto white balance controller.

peak_status	peak_IPL_AutoWhiteBalance_SkipFrames_GetRange (peak_camera_handle hCam, uint32_t skipFramesMin, uint32_t skipFramesMax, uint32_t *skipFramesInc)
	Get the skip frames range for the auto white balance controller.

Detailed Description

Auto white balance control related functions and types.

This feature is applied in the host.
There is also a camera implementation. See Auto white balance control.

Auto white balance

Depending on the light source, light can have different color temperatures so that the images may have a color cast. At low color temperatures (e.g. light from incandescent lamps), the white content shifts towards a red hue. At high color temperatures (e.g. light from fluorescent lamps), the white content shifts a blue hue.

The white balance control feature uses the RGB gain settings of the camera to correct the white level. This is achieved by adjusting the gain controls until the red or blue channel matches the average brightness of the green channel.

Function Documentation

◆ peak_IPL_AutoWhiteBalance_Mode_Get()

peak_status peak_IPL_AutoWhiteBalance_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	autoWhiteBalanceMode )

Get the host auto white balance control mode.

Reads the current host auto white balance control mode.

Parameters

[in]	hCam	The camera handle.
[out]	autoWhiteBalanceMode	The current auto white balance control mode.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoWhiteBalanceMode 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_Mode_Set()

peak_status peak_IPL_AutoWhiteBalance_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_mode	autoWhiteBalanceMode )

Set the host auto white balance control mode.

Writes the desired host auto white balance control mode.

Parameters

[in]	hCam	The camera handle.
[in]	autoWhiteBalanceMode	The auto white balance control mode to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoWhiteBalanceMode is an invalid auto feature mode. Check peak_auto_feature_mode.; 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_ROI_Get()

peak_status peak_IPL_AutoWhiteBalance_ROI_Get	(	peak_camera_handle	hCam,
		peak_roi *	autoWhiteBalanceROI )

Get the host auto white balance ROI.

Reads the current host auto white balance ROI.

Parameters

[in]	hCam	The camera handle.
[out]	autoWhiteBalanceROI	The auto white balance ROI.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoWhiteBalanceROI 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_ROI_Mode_Get()

peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode *	autoWhiteBalanceROIMode )

Get the host auto white balance ROI mode.

Reads the current host auto white balance ROI mode.

Parameters

[in]	hCam	The camera handle.
[out]	autoWhiteBalanceROIMode	The current auto white balance ROI mode.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoWhiteBalanceROIMode 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_ROI_Mode_Set()

peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode	autoWhiteBalanceROIMode )

Set the host auto white balance ROI mode.

Writes the desired host auto white balance ROI mode.

Parameters

[in]	hCam	The camera handle.
[in]	autoWhiteBalanceROIMode	The auto white balance ROI mode to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER autoWhiteBalanceROIMode is an invalid auto feature ROI mode. Check peak_auto_feature_roi_mode.; 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange()

peak_status peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange	(	peak_camera_handle	hCam,
		peak_position *	minAutoWhiteBalanceROIOffset,
		peak_position *	maxAutoWhiteBalanceROIOffset,
		peak_position *	incAutoWhiteBalanceROIOffset )

Get the current range of valid host auto white balance ROI offsets.

Queries the current range of valid values for the host auto white balance ROI offset.

In special the current setting of the image ROI and the current setting of the host auto white balance ROI size has an impact on the range of valid host auto white balance ROI offset values.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoWhiteBalanceROIOffset	The minimum auto white balance ROI offset values.
[out]	maxAutoWhiteBalanceROIOffset	The maximum auto white balance ROI offset values.
[out]	incAutoWhiteBalanceROIOffset	The auto white balance ROI offset values increments.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER At least one of minAutoWhiteBalanceROIOffset, maxAutoWhiteBalanceROIOffset and incAutoWhiteBalanceROIOffset 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_ROI_Set()

peak_status peak_IPL_AutoWhiteBalance_ROI_Set	(	peak_camera_handle	hCam,
		peak_roi	autoWhiteBalanceROI )

Set the host auto white balance ROI.

Writes the desired host auto white balance ROI.

Note: Setting the auto white balance ROI is only possible if PEAK_AUTO_FEATURE_ROI_MODE_MANUAL is set for the auto white balance ROI mode.; The range of valid ROIs for the auto white balance feature is the range of valid image ROIs. It can be queried via peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange and peak_IPL_AutoWhiteBalance_ROI_Size_GetRange.

Parameters

[in]	hCam	The camera handle.
[in]	autoWhiteBalanceROI	The auto white balance ROI to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE autoWhiteBalanceROI value is out of range. Check the range of valid values via peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange and peak_IPL_AutoWhiteBalance_ROI_Size_GetRange.; PEAK_STATUS_ACCESS_DENIED The auto white balance ROI mode is not set to PEAK_AUTO_FEATURE_ROI_MODE_MANUAL. Check the auto white balance ROI mode via peak_IPL_AutoWhiteBalance_ROI_Mode_Get.; 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_ROI_Size_GetRange()

peak_status peak_IPL_AutoWhiteBalance_ROI_Size_GetRange	(	peak_camera_handle	hCam,
		peak_size *	minAutoWhiteBalanceROISize,
		peak_size *	maxAutoWhiteBalanceROISize,
		peak_size *	incAutoWhiteBalanceROISize )

Get the current range of valid host auto white balance ROI sizes.

Queries the current range of valid values for the host auto white balance ROI dimensions.

In special the current setting of the image ROI and the current setting of the host auto brightness ROI offset has an impact on the range of valid host auto brightness ROI size values.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoWhiteBalanceROISize	The minimum auto white balance ROI size values.
[out]	maxAutoWhiteBalanceROISize	The maximum auto white balance ROI size values.
[out]	incAutoWhiteBalanceROISize	The auto white balance ROI size values increments.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER At least one of minAutoWhiteBalanceROISize, maxAutoWhiteBalanceROISize, and incAutoWhiteBalanceROISize 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.

Since: 1.0

◆ peak_IPL_AutoWhiteBalance_SkipFrames_Get()

peak_status peak_IPL_AutoWhiteBalance_SkipFrames_Get	(	peak_camera_handle	hCam,
		uint32_t *	skipFrames )

Get the skip frames for the auto white balance controller.

Parameters

[in]	hCam	The camera handle.
[out]	skipFrames	Number of frames to skip.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER skipFrames 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.

Since: 1.7

◆ peak_IPL_AutoWhiteBalance_SkipFrames_GetRange()

peak_status peak_IPL_AutoWhiteBalance_SkipFrames_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	skipFramesMin,
		uint32_t *	skipFramesMax,
		uint32_t *	skipFramesInc )

Get the skip frames range for the auto white balance controller.

Parameters

[in]	hCam	The camera handle.
[out]	skipFramesMin	The minimum value for the skip frames auto white balance feature.
[out]	skipFramesMax	The maximum value for the skip frames auto white balance feature.
[out]	skipFramesInc	The increment value for the skip frames auto white balance feature.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_PARAMETER At least one of skipFramesMin, skipFramesMax and skipFramesInc 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.

Since: 1.7

◆ peak_IPL_AutoWhiteBalance_SkipFrames_Set()

peak_status peak_IPL_AutoWhiteBalance_SkipFrames_Set	(	peak_camera_handle	hCam,
		uint32_t	skipFrames )

Set the skip frames for the auto white balance controller.

Parameters

[in]	hCam	The camera handle.
[in]	skipFrames	Number of frames to skip.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; 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.

Since: 1.7

Functions

Detailed Description

Auto white balance

Function Documentation

◆ peak_IPL_AutoWhiteBalance_Mode_Get()

◆ peak_IPL_AutoWhiteBalance_Mode_Set()

◆ peak_IPL_AutoWhiteBalance_ROI_Get()

◆ peak_IPL_AutoWhiteBalance_ROI_Mode_Get()

◆ peak_IPL_AutoWhiteBalance_ROI_Mode_Set()

◆ peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange()

◆ peak_IPL_AutoWhiteBalance_ROI_Set()

◆ peak_IPL_AutoWhiteBalance_ROI_Size_GetRange()

◆ peak_IPL_AutoWhiteBalance_SkipFrames_Get()

◆ peak_IPL_AutoWhiteBalance_SkipFrames_GetRange()

◆ peak_IPL_AutoWhiteBalance_SkipFrames_Set()