IDWriteFactory2::CreateGlyphRunAnalysis method

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

Syntax

virtual HRESULT CreateGlyphRunAnalysis(
  [in]           const DWRITE_GLYPH_RUN           *glyphRun,
  [in, optional] const DWRITE_MATRIX              *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
) = 0;

Parameters

glyphRun [in]

Type: const DWRITE_GLYPH_RUN*

Structure specifying the properties of the glyph run.

transform [in, optional]

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.

glyphRunAnalysis [out]

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

See also

IDWriteFactory2