Edit

Share via

IWICDevelopRaw::SetWhitePointRGB method (wincodec.h)

  • Article

Sets the white point RGB values.

Syntax

HRESULT SetWhitePointRGB(
  [in] UINT Red,
  [in] UINT Green,
  [in] UINT Blue
);

Parameters

[in] Red

Type: UINT

The red white point value.

[in] Green

Type: UINT

The green white point value.

[in] Blue

Type: UINT

The blue white point value.

Return value

Type: HRESULT

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

Remarks

Due to other white point setting methods (e.g. SetWhitePointKelvin), care must be taken by codec implementers to ensure proper interoperability. For instance, if the caller sets via a named white point then the codec implementer may wish to disable reading back the corresponding Kelvin temperature. In specific cases where the codec implementer wishes to deny a given action because of previous calls, WINCODEC_ERR_WRONGSTATE should be returned.

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