Saturation

Description

Returns or sets the row value of the color saturation


Syntax

[VB]
objActiveDcam.Saturation [= Value]

[C/C++]
HRESULT get_Saturation( long *pSaturation );
HRESULT put_Saturation( long Saturation );


Data Type [VB]

Long

Parameters [C/C++]

pSaturation [out,retval]

Pointer to the current saturation value

Saturation [in]

The saturation value to be set

Return Values

S_OK

Success

E_FAIL

The saturation control is not available for the selected camera

E_INVALIDARG

The value is out of range

Example

The following VB example demonstrates the use of a scroll control for real-time adjustment of the camera's saturation.

Private Sub Form_Load()
ActiveDcam1.Acquire=True
HScroll1.Value = ActiveDcam1.Saturation
HScroll1.Min = ActiveDcam1.GetSaturationMin
HScroll1.Max = ActiveDcam1.GetSaturationMax
End Sub

Private Sub HScroll1_Scroll()
ActiveDcam1.Saturation = HScroll1.Value
End Sub

Remarks

This property changes the color depth of the video. The valid property range is reported by the GetSaturationMin and GetSaturationMax methods. Note that the property is available only if the currently selected camera is a color one and supports software saturation control.