Home > C: Programming > Function Descriptions > History back  Previous chapter  Next chapter  Print  

is_Saturation

uEye Camera Manual Version 3.80

is_Saturation

Windows_Logo

Linux_Logo

USB uEye XS

USB uEye XS

Syntax

INT is_Saturation (HIDS hCam, UINT nCommand,
void *pParam,
UINT nSizeOfParam)

Description

Using is_Saturation(), you can enhance or reduce the color saturation if supported by your uEye model.

Hinweis

This function is currently only supported by the USB uEye XS camera model.

Input Parameters

hCam

Camera handle

nCommand

 

SATURATION_CMD_GET_CAPABILITIES

Returns the function modes supported by the camera.

More details

pParam: Pointer to bit mask of type UINT
In the bit mask, the status flags from SATURATION_CAPABILITY_FLAGS are returned.

nSizeOfParam: 4

SATURATION_CMD_GET_VALUE

Returns the current color saturation setting.

More details

pParam: Pointer to variable of type UINT returning the current value.

nSizeOfParam: 4

SATURATION_CMD_GET_MIN_VALUE

Returns the minimum value for color saturation.

More details

pParam: Pointer to variable of type UINT returning the minimum value.

nSizeOfParam: 4

SATURATION_CMD_GET_MAX_VALUE

Returns the maximum value for color saturation.

More details

pParam: Pointer to variable of type UINT returning the maximum value.

nSizeOfParam: 4

SATURATION_CMD_GET_INCREMENT

Returns the increment for setting the color saturation.

More details

pParam: Pointer to variable of type UINT returning the increment.

nSizeOfParam: 4

SATURATION_CMD_GET_DEFAULT_VALUE

Returns the default value for color saturation.

More details

pParam: Pointer to variable of type UINT returning the default value.

nSizeOfParam: 4

SATURATION_CMD_SET_VALUE

Sets a value for color saturation.

More details

pParam: Pointer to variable of type UINT that passes the value to be set.

nSizeOfParam: 4

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.

Status Flags from SATURATION_CAPABILITY_FLAGS

SATURATION_CAP_INVALID

The camera does not support setting the color saturation

SATURATION_CAP_SATURATION_SUPPORTED

The camera supports setting the color saturation

Return Values

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

Related Functions

is_SetSaturation()

 


Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com