IDWriteFontFace2

<summary> The interface that represents an absolute reference to a font face. It contains font face type, appropriate file references and face identification data. Various font data such as metrics, names and glyph outlines is obtained from IDWriteFontFace. </summary>

Members

Functions

GetColorPaletteCount
UINT32 GetColorPaletteCount()

<summary> Returns the number of color palettes defined by the font. The return value is zero if the font has no color information. Color fonts must have at least one palette, with palette index zero being the default. </summary>

GetPaletteEntries
HRESULT GetPaletteEntries(UINT32 colorPaletteIndex, UINT32 firstEntryIndex, UINT32 entryCount, DWRITE_COLOR_F* paletteEntries)

<summary> Reads color values from the font's color palette. </summary> <param name="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.<param> <param name="firstEntryIndex">Zero-based index of the first palette entry to read.</param> <param name="entryCount">Number of palette entries to read.</param> <param name="paletteEntries">Array that receives the color values.<param> <returns> Standard HRESULT error code. The return value is E_INVALIDARG if firstEntryIndex + entryCount is greater than the actual number of palette entries as returned by GetPaletteEntryCount. The return value is DWRITE_E_NOCOLOR if the font does not have a palette with the specified palette index. </returns>

GetPaletteEntryCount
UINT32 GetPaletteEntryCount()

<summary> Returns the number of entries in each color palette. All color palettes in a font have the same number of palette entries. The return value is zero if the font has no color information. </summary>

GetRecommendedRenderingMode
HRESULT GetRecommendedRenderingMode(FLOAT fontEmSize, FLOAT dpiX, FLOAT dpiY, const(DWRITE_MATRIX)* transform, BOOL isSideways, DWRITE_OUTLINE_THRESHOLD outlineThreshold, DWRITE_MEASURING_MODE measuringMode, IDWriteRenderingParams renderingParams, DWRITE_RENDERING_MODE* renderingMode, DWRITE_GRID_FIT_MODE* gridFitMode)

<summary> Determines the recommended text rendering and grid-fit mode to be used based on the font, size, world transform, and measuring mode. </summary> <param name="fontEmSize">Logical font size in DIPs.</param> <param name="dpiX">Number of pixels per logical inch in the horizontal direction.</param> <param name="dpiY">Number of pixels per logical inch in the vertical direction.</param> <param name="transform">Specifies the world transform.</param> <param name="outlineThreshold">Specifies the quality of the graphics system's outline rendering, affects the size threshold above which outline rendering is used.</param> <param name="measuringMode">Specifies the method used to measure during text layout. For proper glyph spacing, the function returns a rendering mode that is compatible with the specified measuring mode.</param> <param name="renderingParams">Rendering parameters object. This parameter is necessary in case the rendering parameters object overrides the rendering mode.</param> <param name="renderingMode">Receives the recommended rendering mode.</param> <param name="gridFitMode">Receives the recommended grid-fit mode.</param> <remarks> This method should be used to determine the actual rendering mode in cases where the rendering mode of the rendering params object is DWRITE_RENDERING_MODE_DEFAULT, and the actual grid-fit mode when the rendering params object is DWRITE_GRID_FIT_MODE_DEFAULT. </remarks> <returns> Standard HRESULT error code. </returns>

IsColorFont
BOOL IsColorFont()

<summary> Returns TRUE if the font contains color information (COLR and CPAL tables), or FALSE if not. </summary>

Meta