ID2D1DeviceContext7::DrawGlyphRunWithColorSupport method (d2d1_3.h)

Important

Some information relates to a prerelease product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Draws a glyph run, using color representations of glyphs if available in the font. We recommended that you render color glyphs by using this method.

Syntax

void DrawGlyphRunWithColorSupport(
  D2D1_POINT_2F                       baselineOrigin,
  const DWRITE_GLYPH_RUN              *glyphRun,
  const DWRITE_GLYPH_RUN_DESCRIPTION  *glyphRunDescription,
  ID2D1Brush                          *foregroundBrush,
  ID2D1SvgGlyphStyle                  *svgGlyphStyle,
  UINT32                              colorPaletteIndex,
  DWRITE_MEASURING_MODE               measuringMode,
  D2D1_COLOR_BITMAP_GLYPH_SNAP_OPTION bitmapSnapOption
);

Parameters

baselineOrigin

Type: D2D1_POINT_2F

The baseline.

glyphRun

Type: _In_ CONST DWRITE_GLYPH_RUN *

The glyph run to draw.

glyphRunDescription

Type: _In_opt_ CONST DWRITE_GLYPH_RUN_DESCRIPTION *

A description of the glyph run to draw.

foregroundBrush

Type: _In_opt_ ID2D1Brush *

Foreground brush for the text.

svgGlyphStyle

Type: _In_opt_ ID2D1SvgGlyphStyle *

The glyph style.

colorPaletteIndex

Type: UINT32

Zero-based index of the font-defined color palette to use.

measuringMode

Type: DWRITE_MEASURING_MODE = DWRITE_MEASURING_MODE_NATURAL

Specifies measuring mode for positioning glyphs in the run.

bitmapSnapOption

Type: D2D1_COLOR_BITMAP_GLYPH_SNAP_OPTION = D2D1_COLOR_BITMAP_GLYPH_SNAP_OPTION_DEFAULT

Snap options.

Return value

None

Requirements

Requirement	Value
Header	d2d1_3.h