Auto white balance control

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. More...
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. More...
peak_status	peak_IPL_AutoWhiteBalance_ROI_Set (peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
	Set the host auto white balance ROI. More...
peak_status	peak_IPL_AutoWhiteBalance_ROI_Get (peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
	Get the host auto white balance ROI. More...
peak_status	peak_IPL_AutoWhiteBalance_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
	Set the host auto white balance control mode. More...
peak_status	peak_IPL_AutoWhiteBalance_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
	Get the host auto white balance control mode. More...

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.

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.

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.

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.

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.

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.

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_ROI_Offset_GetRange and peak_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_ROI_Offset_GetRange and peak_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.