IDWriteFactory3::CreateGlyphRunAnalysis method
Creates a glyph-run-analysis object that encapsulates info that DirectWrite uses to render a glyph run.
Syntax
virtual HRESULT CreateGlyphRunAnalysis( [in] DWRITE_GLYPH_RUN *const glyphRun, [in, optional] DWRITE_MATRIX *const transform, DWRITE_RENDERING_MODE1 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: DWRITE_GLYPH_RUN
A DWRITE_GLYPH_RUN structure that contains the properties of the glyph run.
- transform [in, optional]
-
Type: DWRITE_MATRIX
A DWRITE_MATRIX structure that describes the optional transform to be applied to glyphs and their positions.
- renderingMode
-
Type: DWRITE_RENDERING_MODE1
A DWRITE_RENDERING_MODE1-typed value that specifies the rendering mode, which must be one of the raster rendering modes (that is, not default and not outline).
- measuringMode
-
Type: DWRITE_MEASURING_MODE
A DWRITE_MEASURING_MODE-typed value that specifies the measuring method for glyphs in the run. This method uses this value with the other properties to determine the rendering mode.
- gridFitMode
-
Type: DWRITE_GRID_FIT_MODE
A DWRITE_GRID_FIT_MODE-typed value that specifies how to grid-fit glyph outlines. This value must be non-default.
- antialiasMode
-
Type: DWRITE_TEXT_ANTIALIAS_MODE
A DWRITE_TEXT_ANTIALIAS_MODE-typed value that specifies the type of antialiasing to use for text when the rendering mode calls for antialiasing.
- baselineOriginX
-
Type: FLOAT
The horizontal position of the baseline origin, in DIPs, relative to the upper-left corner of the DIB.
- baselineOriginY
-
Type: FLOAT
The vertical position of the baseline origin, in DIPs, relative to the upper-left corner of the DIB.
- glyphRunAnalysis [out]
-
Type: IDWriteGlyphRunAnalysis**
A pointer to a memory block that receives a pointer to a IDWriteGlyphRunAnalysis interface for the newly created glyph-run-analysis object.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Requirements
|
Minimum supported client |
Windows 10 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2016 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also