Auto white balance control

Functions
peak_access_status	peak_AutoWhiteBalance_GetAccessStatus (peak_camera_handle hCam)
	Query the auto white balance access status.
peak_access_status	peak_AutoWhiteBalance_ROI_GetAccessStatus (peak_camera_handle hCam)
	Query the auto white balance ROI access status.
peak_status	peak_AutoWhiteBalance_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
	Set the auto white balance ROI mode.
peak_status	peak_AutoWhiteBalance_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
	Get the auto white balance ROI mode.
peak_status	peak_AutoWhiteBalance_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position *minAutoWhiteBalanceROIOffset, peak_position *maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
	Get the current range of valid auto white balance ROI offsets.
peak_status	peak_AutoWhiteBalance_ROI_Size_GetRange (peak_camera_handle hCam, peak_size *minAutoWhiteBalanceROISize, peak_size *maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
	Get the current range of valid auto white balance ROI sizes.
peak_status	peak_AutoWhiteBalance_ROI_Set (peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
	Set the auto white balance ROI.
peak_status	peak_AutoWhiteBalance_ROI_Get (peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
	Get the auto white balance ROI.
peak_status	peak_AutoWhiteBalance_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
	Set the auto white balance control mode.
peak_status	peak_AutoWhiteBalance_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
	Get the auto white balance control mode.
peak_status	peak_AutoWhiteBalance_Mode_GetList (peak_camera_handle hCam, peak_auto_feature_mode *modeList, size_t *modeListSize)
	Get the list of currently selectable auto white balance control modes.

Detailed Description

Auto white balance control related functions and types.

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

Function Documentation

peak_AutoWhiteBalance_GetAccessStatus()

peak_access_status peak_AutoWhiteBalance_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the auto white balance access status.

Provides the current access status for the auto white balance feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The auto white balance feature is readable and writable.

PEAK_ACCESS_READONLY The auto white balance feature is readable only.

PEAK_ACCESS_GFA_LOCK The auto white balance feature is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The auto white balance feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The auto white balance 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.

Since

1.0

peak_AutoWhiteBalance_Mode_Get()

peak_status peak_AutoWhiteBalance_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	autoWhiteBalanceMode )

Get the auto white balance control mode.

Reads the current 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_ACCESS_DENIED The auto white balance control feature is not available for read access. Check the access status via peak_AutoWhiteBalance_GetAccessStatus.

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

peak_status peak_AutoWhiteBalance_Mode_GetList	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	modeList,
		size_t *	modeListSize )

Get the list of currently selectable auto white balance control modes.

Queries the list of currently selectable auto white balance control modes.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	modeList	Pointer to a user allocated array buffer to receive the auto white balance mode list. If this parameter is NULL, modeListSize will contain the current number of auto white balance modes. The required size of modeList in bytes is modeListSize x sizeof(peak_auto_feature_mode).
[in,out]	modeListSize	modeList equal NULL: out: minimal number of auto white balance control modes modeList must be large enough to hold modeList unequal NULL: in: number of auto white balance control modes modeList can hold out: number of auto white balance control modes filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_ACCESS_DENIED The auto white balance modes property is not accessible. Check the access status of the auto white balance feature via peak_AutoWhiteBalance_GetAccessStatus or check the last error for more information via peak_Library_GetLastError.

PEAK_STATUS_INVALID_PARAMETER modeListSize 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.12

peak_AutoWhiteBalance_Mode_Set()

peak_status peak_AutoWhiteBalance_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_mode	autoWhiteBalanceMode )

Set the auto white balance control mode.

Writes the desired 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_ACCESS_DENIED The auto white balance control feature is not available for write access. Check the access status via peak_AutoWhiteBalance_GetAccessStatus.

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

peak_status peak_AutoWhiteBalance_ROI_Get	(	peak_camera_handle	hCam,
		peak_roi *	autoWhiteBalanceROI )

Get the auto white balance ROI.

Reads the current 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_ACCESS_DENIED The auto white balance feature is not available for read access. Check the access status via peak_AutoWhiteBalance_GetAccessStatus.

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

peak_access_status peak_AutoWhiteBalance_ROI_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the auto white balance ROI access status.

Provides the current access status for the auto white balance ROI feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The auto white balance ROI feature is readable and writable.

PEAK_ACCESS_READONLY The auto white balance ROI feature is readable only.

PEAK_ACCESS_GFA_LOCK The auto white balance ROI feature is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The auto white balance ROI feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The auto white balance ROI 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.

Since

1.0

peak_AutoWhiteBalance_ROI_Mode_Get()

peak_status peak_AutoWhiteBalance_ROI_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode *	autoWhiteBalanceROIMode )

Get the auto white balance ROI mode.

Reads the current 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_ACCESS_DENIED The auto white balance control feature is not available for read access. Check the access status via peak_AutoWhiteBalance_GetAccessStatus.

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

peak_status peak_AutoWhiteBalance_ROI_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode	autoWhiteBalanceROIMode )

Set the auto white balance ROI mode.

Writes the desired 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_ACCESS_DENIED The auto white balance feature is not available for write access. Check the access status via peak_AutoWhiteBalance_GetAccessStatus.

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

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

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

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

The range of valid auto white balance ROI offset values may depend on the camera configuration and the camera status.
In special the current setting of the image ROI and the current setting of the auto white balance ROI size has an impact on the range of valid 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_ACCESS_DENIED The auto white balance feature is not accessible. Check the access status via peak_AutoWhiteBalance_GetAccessStatus.

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

peak_status peak_AutoWhiteBalance_ROI_Set	(	peak_camera_handle	hCam,
		peak_roi	autoWhiteBalanceROI )

Set the auto white balance ROI.

Writes the desired 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.

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_AutoWhiteBalance_ROI_Offset_GetRange and peak_AutoWhiteBalance_ROI_Size_GetRange.

PEAK_STATUS_ACCESS_DENIED The auto white balance feature is not available for write access or the auto white balance ROI mode is not set to PEAK_AUTO_FEATURE_ROI_MODE_MANUAL. Check the access status via peak_AutoWhiteBalance_GetAccessStatus. Check the auto white balance ROI mode via peak_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_AutoWhiteBalance_ROI_Size_GetRange()

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

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

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

The range of valid auto white balance ROI size values may depend on the camera configuration and the camera status.
In special the current setting of the image ROI and the current setting of the auto white balance ROI offset has an impact on the range of valid auto white balance 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_ACCESS_DENIED The auto white balance feature is not accessible. Check the access status via peak_AutoWhiteBalance_GetAccessStatus.

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