Skip to content

Latest commit

 

History

History
183 lines (118 loc) · 6.08 KB

nf-dwrite-idwritetextanalyzer-getglyphs.md

File metadata and controls

183 lines (118 loc) · 6.08 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dwrite.IDWriteTextAnalyzer.GetGlyphs
IDWriteTextAnalyzer::GetGlyphs (dwrite.h)
Parses the input text string and maps it to the set of glyphs and associated glyph data according to the font and the writing system's rendering rules.
GetGlyphs
GetGlyphs method [Direct Write]
GetGlyphs method [Direct Write]
IDWriteTextAnalyzer interface
IDWriteTextAnalyzer interface [Direct Write]
GetGlyphs method
IDWriteTextAnalyzer.GetGlyphs
IDWriteTextAnalyzer::GetGlyphs
directwrite.IDWriteTextAnalyzer_GetGlyphs
dwrite/IDWriteTextAnalyzer::GetGlyphs
directwrite\IDWriteTextAnalyzer_GetGlyphs.htm
DirectWrite
9bc373b6-9161-4ffc-a942-50d97d6509c3
12/05/2018
GetGlyphs, GetGlyphs method [Direct Write], GetGlyphs method [Direct Write],IDWriteTextAnalyzer interface, IDWriteTextAnalyzer interface [Direct Write],GetGlyphs method, IDWriteTextAnalyzer.GetGlyphs, IDWriteTextAnalyzer::GetGlyphs, directwrite.IDWriteTextAnalyzer_GetGlyphs, dwrite/IDWriteTextAnalyzer::GetGlyphs
dwrite.h
Windows
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Dwrite.lib
Dwrite.dll
Windows
19H1
IDWriteTextAnalyzer::GetGlyphs
dwrite/IDWriteTextAnalyzer::GetGlyphs
c++
APIRef
kbSyntax
COM
dwrite.dll
IDWriteTextAnalyzer.GetGlyphs

IDWriteTextAnalyzer::GetGlyphs

-description

Parses the input text string and maps it to the set of glyphs and associated glyph data according to the font and the writing system's rendering rules.

-parameters

-param textString [in]

Type: const WCHAR*

An array of characters to convert to glyphs.

-param textLength

Type: UINT32

The length of textString.

-param fontFace

Type: IDWriteFontFace*

The font face that is the source of the output glyphs.

-param isSideways

Type: BOOL

A Boolean flag set to TRUE if the text is intended to be drawn vertically.

-param isRightToLeft

Type: BOOL

A Boolean flag set to TRUE for right-to-left text.

-param scriptAnalysis [in]

Type: const DWRITE_SCRIPT_ANALYSIS*

A pointer to a Script analysis result from an AnalyzeScript call.

-param localeName [in, optional]

Type: const WCHAR*

The locale to use when selecting glyphs. For example the same character may map to different glyphs for ja-jp versus zh-chs. If this is NULL, then the default mapping based on the script is used.

-param numberSubstitution [optional]

Type: IDWriteNumberSubstitution*

A pointer to an optional number substitution which selects the appropriate glyphs for digits and related numeric characters, depending on the results obtained from AnalyzeNumberSubstitution. Passing NULL indicates that no substitution is needed and that the digits should receive nominal glyphs.

-param features [in, optional]

Type: const DWRITE_TYPOGRAPHIC_FEATURES**

An array of pointers to the sets of typographic features to use in each feature range.

-param featureRangeLengths [in, optional]

Type: const UINT32*

The length of each feature range, in characters.
The sum of all lengths should be equal to textLength.

-param featureRanges

Type: UINT32

The number of feature ranges.

-param maxGlyphCount

Type: UINT32

The maximum number of glyphs that can be returned.

-param clusterMap [out]

Type: UINT16*

When this method returns, contains the mapping from character ranges to glyph ranges.

-param textProps [out]

Type: DWRITE_SHAPING_TEXT_PROPERTIES*

When this method returns, contains a pointer to an array of structures that contains shaping properties for each character.

-param glyphIndices [out]

Type: UINT16*

The output glyph indices.

-param glyphProps [out]

Type: DWRITE_SHAPING_GLYPH_PROPERTIES*

When this method returns, contains a pointer to an array of structures that contain shaping properties for each output glyph.

-param actualGlyphCount [out]

Type: UINT32*

When this method returns, contains the actual number of glyphs returned if the call succeeds.

-returns

Type: HRESULT

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

-remarks

Note that the mapping from characters to glyphs is, in general, many-to-many. The recommended estimate for the per-glyph output buffers is (3 * textLength / 2 + 16). This is not guaranteed to be sufficient.

The value of the actualGlyphCount parameter is only valid if the call succeeds. In the event that maxGlyphCount is not big enough, HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) will be returned. The application should allocate a larger buffer and try again.

-see-also

IDWriteTextAnalyzer