Edit

IDWriteFactory2::CreateGlyphRunAnalysis method (dwrite_2.h)

  • Article

Creates a glyph run analysis object, which encapsulates information used to render a glyph run.

Syntax

HRESULT CreateGlyphRunAnalysis(
  [in]           DWRITE_GLYPH_RUN const     *glyphRun,
  [in, optional] DWRITE_MATRIX const        *transform,
                 DWRITE_RENDERING_MODE      renderingMode,
                 DWRITE_MEASURING_MODE      measuringMode,
                 DWRITE_GRID_FIT_MODE       gridFitMode,
                 DWRITE_TEXT_ANTIALIAS_MODE antialiasMode,
                 FLOAT                      baselineOriginX,
                 FLOAT                      baselineOriginY,
  [out]          IDWriteGlyphRunAnalysis    **glyphRunAnalysis
);

Parameters

[in] glyphRun

Type: const DWRITE_GLYPH_RUN*

Structure specifying the properties of the glyph run.

[in, optional] transform

Type: const DWRITE_MATRIX*

Optional transform applied to the glyphs and their positions. This transform is applied after the scaling specified by the emSize and pixelsPerDip.

renderingMode

Type: DWRITE_RENDERING_MODE

Specifies the rendering mode, which must be one of the raster rendering modes (i.e., not default and not outline).

measuringMode

Type: DWRITE_MEASURING_MODE

Specifies the method to measure glyphs.

gridFitMode

Type: DWRITE_GRID_FIT_MODE

How to grid-fit glyph outlines. This must be non-default.

antialiasMode

Type: DWRITE_TEXT_ANTIALIAS_MODE

Specifies the antialias mode.

baselineOriginX

Type: FLOAT

Horizontal position of the baseline origin, in DIPs.

baselineOriginY

Type: FLOAT

Vertical position of the baseline origin, in DIPs.

[out] glyphRunAnalysis

Type: IDWriteGlyphRunAnalysis**

Receives a pointer to the newly created object.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 R2 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite_2.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteFactory2