Gamma

Functions
peak_status	peak_IPL_Gamma_GetRange (peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
	Get the current range of valid host gamma values. More...
peak_status	peak_IPL_Gamma_Set (peak_camera_handle hCam, double gamma)
	Set the host gamma value. More...
peak_status	peak_IPL_Gamma_Get (peak_camera_handle hCam, double *gamma)
	Get the host gamma value. More...

Detailed Description

Gamma related functions and types.

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

Function Documentation

peak_IPL_Gamma_Get()

peak_status peak_IPL_Gamma_Get	(	peak_camera_handle	hCam,
		double *	gamma
	)

Get the host gamma value.

Reads the current host gamma value.

Parameters

[in]	hCam	The camera handle.
[out]	gamma	The gamma value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER gamma 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_Gamma_GetRange()

peak_status peak_IPL_Gamma_GetRange	(	peak_camera_handle	hCam,
		double *	minGamma,
		double *	maxGamma,
		double *	incGamma
	)

Get the current range of valid host gamma values.

Queries the current range of valid values for the host gamma feature.

Parameters

[in]	hCam	The camera handle.
[out]	minGamma	The minimum gamma value.
[out]	maxGamma	The maximum gamma value.
[out]	incGamma	The increment gamma value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minGamma, maxGamma and incGamma 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_Gamma_Set()

peak_status peak_IPL_Gamma_Set	(	peak_camera_handle	hCam,
		double	gamma
	)

Set the host gamma value.

Writes the desired host gamma value.

Parameters

[in]	hCam	The camera handle.
[in]	gamma	The gamma value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE gamma value is out of range. Check the range of valid values via peak_IPL_Gamma_GetRange.

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.