Is_Setgainboost - THORLABS DCU223x Operation Manual And Sdk

4.3.85 is_SetGainBoost

USB 2.0
USB 3.0
Syntax
INT is_SetGainBoost (HIDS hCam, INT mode)
Description
In some cameras, is_SetGainBoost() enables an additional analog hardware gain boost feature on the
sensor.
Input parameters
hCam
mode
IS_GET_GAINBOOST
IS_SET_GAINBOOST_ON
IS_SET_GAINBOOST_OFF
IS_GET_SUPPORTED_GAINBOOST
Return values
Current setting when used together with
IS_GET_GAINBOOST
Current setting when used together with
IS_GET_SUPPORTED_GAINBOOST
IS_INVALID_CAMERA_HANDLE
IS_INVALID_MODE
IS_NO_SUCCESS
IS_SUCCESS
Related functions
is_SetHardwareGain()
is_SetHWGainFactor()
is_SetAutoParameter()
© 2013 Thorlabs GmbH
USB 2.0
USB 3.0
333
335
303
Camera handle
Returns the current state of the gain boost function.
Enables the gain boost function.
Disables the gain boost function.
Indicates whether the camera supports a gain boost
feature or not.
Returns IS_SET_GAINBOOST_ON if the function is
enabled, otherwise it returns
IS_SET_GAINBOOST_OFF.
Returns IS_SET_GAINBOOST_ON if the function is
supported, otherwise it returns
IS_SET_GAINBOOST_OFF.
Invalid camera handle
Camera is in standby mode, function not allowed
General error message
Function executed successfully
4 Programming (SDK)
331