GetGlyphs Method

GetGlyphs(string, int, FontFace, bool, bool, ScriptAnalysis, string, NumberSubstitution, FontFeature[][], int[], int, short[], ShapingTextProperties[], short[], ShapingGlyphProperties[])

Gets the glyphs (TODO doc)

Declaration

public int GetGlyphs(string textString, int textLength, FontFace fontFace, bool isSideways, bool isRightToLeft, ScriptAnalysis scriptAnalysis, string localeName, NumberSubstitution numberSubstitution, FontFeature[][] features, int[] featureRangeLengths, int maxGlyphCount, short[] clusterMap, ShapingTextProperties[] textProps, short[] glyphIndices, ShapingGlyphProperties[] glyphProps)

Public Function GetGlyphs(textString As String, textLength As Integer, fontFace As FontFace, isSideways As Boolean, isRightToLeft As Boolean, scriptAnalysis As ScriptAnalysis, localeName As String, numberSubstitution As NumberSubstitution, features As FontFeature()(), featureRangeLengths As Integer(), maxGlyphCount As Integer, clusterMap As Short(), textProps As ShapingTextProperties(), glyphIndices As Short(), glyphProps As ShapingGlyphProperties()) As Integer

Parameters

Type	Name	Description
string	textString	The text string.
int	textLength	Length of the text.
FontFace	fontFace	The font face.
bool	isSideways	if set to `true` [is sideways].
bool	isRightToLeft	if set to `true` [is right to left].
ScriptAnalysis	scriptAnalysis	The script analysis.
string	localeName	Name of the locale.
NumberSubstitution	numberSubstitution	The number substitution.
FontFeature[][]	features	The features.
int[]	featureRangeLengths	The feature range lengths.
int	maxGlyphCount	The max glyph count.
short[]	clusterMap	The cluster map.
ShapingTextProperties[]	textProps	The text props.
short[]	glyphIndices	The glyph indices.
ShapingGlyphProperties[]	glyphProps	The glyph props.

Returns

Type	Description
int

GetGlyphs(string, int, FontFace, Bool, Bool, ScriptAnalysis, string, NumberSubstitution, IntPtr, int[], int, int, short[], ShapingTextProperties[], short[], ShapingGlyphProperties[])

HRESULT IDWriteTextAnalyzer::GetGlyphs([In, Buffer] const wchar_t* textString,[In] unsigned int textLength,[In] IDWriteFontFace* fontFace,[In] BOOL isSideways,[In] BOOL isRightToLeft,[In] const DWRITE_SCRIPT_ANALYSIS* scriptAnalysis,[In, Optional] const wchar_t* localeName,[In, Optional] IDWriteNumberSubstitution* numberSubstitution,[In, Optional] const void** features,[In, Buffer, Optional] const unsigned int* featureRangeLengths,[In] unsigned int featureRanges,[In] unsigned int maxGlyphCount,[Out, Buffer] unsigned short* clusterMap,[Out, Buffer] DWRITE_SHAPING_TEXT_PROPERTIES* textProps,[Out, Buffer] unsigned short* glyphIndices,[Out, Buffer] DWRITE_SHAPING_GLYPH_PROPERTIES* glyphProps,[Out] unsigned int* actualGlyphCount)

Declaration

public int GetGlyphs(string textString, int textLength, FontFace fontFace, Bool isSideways, Bool isRightToLeft, ScriptAnalysis scriptAnalysis, string localeName, NumberSubstitution numberSubstitution, IntPtr features, int[] featureRangeLengths, int featureRanges, int maxGlyphCount, short[] clusterMap, ShapingTextProperties[] textProps, short[] glyphIndices, ShapingGlyphProperties[] glyphProps)

Public Function GetGlyphs(textString As String, textLength As Integer, fontFace As FontFace, isSideways As Bool, isRightToLeft As Bool, scriptAnalysis As ScriptAnalysis, localeName As String, numberSubstitution As NumberSubstitution, features As IntPtr, featureRangeLengths As Integer(), featureRanges As Integer, maxGlyphCount As Integer, clusterMap As Short(), textProps As ShapingTextProperties(), glyphIndices As Short(), glyphProps As ShapingGlyphProperties()) As Integer

Parameters

Type	Name	Description
string	textString
int	textLength
FontFace	fontFace
Bool	isSideways
Bool	isRightToLeft
ScriptAnalysis	scriptAnalysis
string	localeName
NumberSubstitution	numberSubstitution
IntPtr	features
int[]	featureRangeLengths
int	featureRanges
int	maxGlyphCount
short[]	clusterMap
ShapingTextProperties[]	textProps
short[]	glyphIndices
ShapingGlyphProperties[]	glyphProps

Returns

Type	Description
int

GetGlyphs(IntPtr, int, IntPtr, bool, bool, ScriptAnalysis, IntPtr, IntPtr, IntPtr, IntPtr, int, IntPtr, IntPtr, IntPtr, IntPtr, out int)

Declaration

public HResult GetGlyphs(IntPtr textString, int textLength, IntPtr fontFace, bool isSideways, bool isRightToLeft, ScriptAnalysis scriptAnalysis, IntPtr localeName, IntPtr numberSubstitution, IntPtr features, IntPtr featureRangeLengths, int maxGlyphCount, IntPtr clusterMap, IntPtr textProps, IntPtr glyphIndices, IntPtr glyphProps, out int actualGlyphCount)

Public Function GetGlyphs(textString As IntPtr, textLength As Integer, fontFace As IntPtr, isSideways As Boolean, isRightToLeft As Boolean, scriptAnalysis As ScriptAnalysis, localeName As IntPtr, numberSubstitution As IntPtr, features As IntPtr, featureRangeLengths As IntPtr, maxGlyphCount As Integer, clusterMap As IntPtr, textProps As IntPtr, glyphIndices As IntPtr, glyphProps As IntPtr, ByRef actualGlyphCount As Integer) As HResult

Parameters

Type	Name	Description
IntPtr	textString
int	textLength
IntPtr	fontFace
bool	isSideways
bool	isRightToLeft
ScriptAnalysis	scriptAnalysis
IntPtr	localeName
IntPtr	numberSubstitution
IntPtr	features
IntPtr	featureRangeLengths
int	maxGlyphCount
IntPtr	clusterMap
IntPtr	textProps
IntPtr	glyphIndices
IntPtr	glyphProps
int	actualGlyphCount

Returns

Type	Description
HResult