IWICDevelopRaw::SetSaturation method (wincodec.h)

Article
02/22/2024

Sets the saturation value of the raw image.

Syntax

HRESULT SetSaturation(
  [in] double Saturation
);

Parameters

[in] Saturation

Type: double

The saturation value of the raw image. The value range for saturation is 0.0 through 1.0. A value of 0.0 represents an image with a fully de-saturated image, while a value of 1.0 represents the highest amount of saturation that can be applied.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The codec implementer must determine what the upper range value represents and must determine how to map the value to their image processing routines.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	wincodec.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll

Share via