IDWriteFontFace2::GetPaletteEntries method
Gets color values from the font's color palette.
Syntax
HRESULT GetPaletteEntries( UINT32 colorPaletteIndex, UINT32 firstEntryIndex, UINT32 entryCount, [out] DWRITE_COLOR_F *paletteEntries );
Parameters
- colorPaletteIndex
-
Zero-based index of the color palette. If the font does not have a palette with the specified index, the method returns DWRITE_E_NOCOLOR.
- firstEntryIndex
-
Zero-based index of the first palette entry to read.
- entryCount
-
Number of palette entries to read.
- paletteEntries [out]
-
Array that receives the color values.
Return value
This method can return one of these values.
| Return value | Description |
|---|---|
|
The sum of firstEntryIndex and entryCount is greater than the actual number of palette entries that's returned by the GetPaletteEntryCount method. |
|
The font doesn't have a palette with the specified palette index. |
Requirements
|
Minimum supported client |
Windows 8.1 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2012 R2 [desktop apps only] |
|
Minimum supported phone |
Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also