Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IWICDevelopRaw::SetWhitePointKelvin method

Sets the white point Kelvin value.

Syntax


HRESULT SetWhitePointKelvin(
  [in] UINT WhitePointKelvin
);

Parameters

WhitePointKelvin [in]

Type: UINT

The white point Kelvin value. Acceptable Kelvin values are 1,500 through 30,000.

Return value

Type: HRESULT

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

Remarks

Codec implementers should faithfully adjust the color temperature within the range supported natively by the raw image. For values outside the native support range, the codec implementer should provide a best effort representation of the image at that color temperature.

Codec implementers should return WINCODEC_ERR_VALUEOUTOFRANGE if the value is out of defined acceptable range.

Codec implementers must ensure proper interoperability with other white point setting methods such as SetWhitePointRGB. For example, if the caller sets the white point via SetNamedWhitePoint then the codec implementer may want to disable reading back the correspoinding Kelvin temperature. In specific cases where the codec implementer wants to deny a given action because of previous calls, WINCODEC_ERR_WRONGSTATE should be returned.

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

 

 

Show:
© 2017 Microsoft