FSlateFontCache::ShapeBidirectionalText

Performs text shaping on the given string using the given font info.

Choose your operating system:

Windows

macOS

Linux

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Fonts/FontCache.h
Include	#include "Fonts/FontCache.h"
Source	/Engine/Source/Runtime/SlateCore/Private/Fonts/FontCache.cpp

Syntax

FShapedGlyphSequenceRef ShapeBidirectionalText
(
    const FString & InText,
    const FSlateFontInfo & InFontInfo,
    const float InFontScale,
    const TextBiDi::ETextDirection InBaseDirection,
    const ETextShapingMethod InTextShapingMethod
) const

Remarks

Performs text shaping on the given string using the given font info. Returns you the shaped text sequence to use for text rendering via FSlateDrawElement::MakeShapedText. When using the version which takes a start point and length, the text outside of the given range won't be shaped, but will provide context information to allow the shaping to function correctly. ShapeBidirectionalText is used when you have text that may contain a mixture of LTR and RTL text runs.

Parameters

Parameter	Description
InText	The string to shape
InTextStart	The start position of the text to shape
InTextLen	The length of the text to shape
InFontInfo	Information about the font that the string is drawn with
InFontScale	The scale to apply to the font
InBaseDirection	The overall reading direction of the text (see TextBiDi::ComputeBaseDirection). This will affect where some characters (such as brackets and quotes) are placed within the resultant shaped text
InTextShapingMethod	The text shaping method to use