Home > C: Programming > Function Descriptions > | History back Previous chapter Next chapter Print |
is_ColorTemperature |
uEye Camera Manual Version 3.80
is_ColorTemperature
USB 2.0 GigE |
USB 2.0 GigE |
Syntax
INT is_ColorTemperature (HIDS hCam, UINT nCommand,
void *pParam, UINT nSizeOfParam)
Description
Using is_ColorTemperature() you can fix a setting (in kelvins) for the color temperature of an image when you are using a color camera. The function will use the sensor's hardware gain controls for the setting, as far as possible. In addition, you can choose between different color spaces. A specific color temperature will result in slightly differing RGB values, depending on the selected color space.
The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the nSizeOfParam input parameter.
|
|
Input Parameters
hCam |
Camera handle |
|
nCommand |
|
|
Setting the color space |
||
COLOR_TEMPERATURE_CMD_GET_SUPPORTED_RGB_COLOR_MODELS |
Returns the supported color spaces.
|
|
COLOR_TEMPERATURE_CMD_SET_RGB_COLOR_MODEL |
Sets a color space.
|
|
COLOR_TEMPERATURE_CMD_GET_RGB_COLOR_MODEL |
Returns the set color space.
|
|
COLOR_TEMPERATURE_CMD_GET_RGB_COLOR_MODEL_DEFAULT |
Returns the default color space.
|
|
Setting the color temperature |
||
COLOR_TEMPERATURE_CMD_SET_TEMPERATURE |
Sets a color temperature.
|
|
COLOR_TEMPERATURE_CMD_GET_TEMPERATURE |
Returns the set color temperature.
|
|
COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_MIN |
Returns the minimum value for the color temperature.
|
|
COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_MAX |
Returns the maximum value for the color temperature.
|
|
COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_INC |
Returns the increment for setting the color temperature.
|
|
COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_DEFAULT |
Returns the default value for the color temperature.
|
|
pParam |
Pointer to a function parameter; which function parameter is referred to here depends on nCommand. |
|
nSizeOfParam |
Size (in bytes) of the memory area to which pParam refers. |
RGB_COLOR_MODEL_SRGB_D50 |
sRGB (standard RGB) color space with a white point of 5000 kelvins (warm light) |
RGB_COLOR_MODEL_SRGB_D65 |
sRGB (standard RGB) color space with a white point of 6500 kelvins (mid daylight) |
RGB_COLOR_MODEL_CIE_RGB_E |
CIE-RGB color space with standard illumination E |
RGB_COLOR_MODEL_ECI_RGB_D50 |
ECI-RGB color space with a white point of 5000 kelvins (warm light) |
RGB_COLOR_MODEL_ADOBE_RGB_D65 |
Adobe RGB color space with a white point of 6500 kelvins (mid daylight). The Adobe RGB color space is larger than the sRGB color space, but not all devices can render it. |
Return Values
IS_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |
IS_INVALID_PARAMETER |
One of the parameters passed is invalid |
IS_NOT_SUPPORTED |
This function is not supported by the current camera |
Related Functions