Edit

Share via

IWICPalette::IsGrayscale method (wincodec.h)

  • Article

Retrieves a value that describes whether a palette is grayscale.

Syntax

HRESULT IsGrayscale(
  [out] BOOL *pfIsGrayscale
);

Parameters

[out] pfIsGrayscale

Type: BOOL*

A pointer to a variable that receives a boolean value that indicates whether the palette is grayscale. TRUE indicates that the palette is grayscale; otherwise FALSE.

Return value

Type: HRESULT

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

Remarks

A palette is considered grayscale only if, for every entry, the alpha value is 0xFF and the red, green and blue values match.

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