ID2D1DeviceContext::DrawGlyphRun method (d2d1_1.h)

Article
02/22/2024

Draws a series of glyphs to the device context.

Syntax

void DrawGlyphRun(
                 D2D1_POINT_2F                      baselineOrigin,
  [in]           const DWRITE_GLYPH_RUN             *glyphRun,
  [in, optional] const DWRITE_GLYPH_RUN_DESCRIPTION *glyphRunDescription,
  [in]           ID2D1Brush                         *foregroundBrush,
                 DWRITE_MEASURING_MODE              measuringMode
);

Parameters

baselineOrigin

Type: D2D1_POINT_2F

Origin of first glyph in the series.

[in] glyphRun

Type: const DWRITE_GLYPH_RUN*

The glyphs to render.

[in, optional] glyphRunDescription

Type: const DWRITE_GLYPH_RUN_DESCRIPTION*

Supplementary glyph series information.

[in] foregroundBrush

Type: ID2D1Brush*

The brush that defines the text color.

measuringMode

Type: DWRITE_MEASURING_MODE

The measuring mode of the glyph series, used to determine the advances and offsets. The default value is DWRITE_MEASURING_MODE_NATURAL.

Return value

None

Remarks

The glyphRunDescription is ignored when rendering, but can be useful for printing and serialization of rendering commands, such as to an XPS or SVG file. This extends ID2D1RenderTarget::DrawGlyphRun, which lacked the glyph run description.

Requirements

Requirement	Value
Minimum supported client	Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	d2d1_1.h
DLL	D2d1.dll