IVideoProcAmp::put_Saturation method (vidcap.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The put_Saturation method sets the camera's saturation setting.

Syntax

HRESULT put_Saturation(
  [in] long Value,
  [in] long Flags
);

Parameters

[in] Value

Specifies the saturation setting. Larger values indicate greater saturation. The value zero indicates grayscale.

[in] Flags

Zero or more flags. See VideoProcAmpFlags. If the VideoProcAmp_Flags_Auto flag is used, the Value parameter is ignored and the camera sets the default value.

Return value

Returns an HRESULT value.

Requirements

See also

Error and Success Codes

IVideoProcAmp Interface