Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Fonts > FShapedGlyphSequence

Light Theme

Dark Theme

FShapedGlyphSequence

Information for rendering a shaped text sequence

Windows

MacOS

Linux

References

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

Syntax

class FShapedGlyphSequence

Remarks

Information for rendering a shaped text sequence

Constructors

	Name	Description
	FShapedGlyphSequence()
	FShapedGlyphSequence ( TArray< FShapedGlyphEntry > InGlyph..., const int16 InTextBaseline, const uint16 InMaxTextHeight, const UObject* InFontMaterial, const FFontOutlineSettings& InOutl..., const FSourceTextRange& InSourceTe... )

Destructors

	Name	Description
	~FShapedGlyphSequence()

Functions

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector )
uint32	GetAllocatedSize()	Get the amount of memory allocated to this sequence
const UObjec...	GetFontMaterial()	Get the material to use when rendering these glyphs
const FFontO...	GetFontOutlineSettings()	Get the font outline settings to use when rendering these glyphs
TOptional< F...	GetGlyphAtOffset ( FSlateFontCache& InFontCache, const int32 InStartIndex, const int32 InEndIndex, const int32 InHorizontalOffset, const int32 InStartOffset, const bool InIncludeKerningWithPrec... )	Get the information for the glyph at the specified position in pixels along the string horizontally @note The indices used here are relative to the start of the text we were shaped from, even if we were only shaped from a sub-section of that text
FGlyphOffset...	GetGlyphAtOffset ( FSlateFontCache& InFontCache, const int32 InHorizontalOffset, const int32 InStartOffset )	Get the information for the glyph at the specified position in pixels along the string horizontally
const TArray...	GetGlyphsToRender()	Get the array of glyphs in this sequence.
TOptional< i...	GetKerning ( const int32 InIndex )	Get the kerning value between the given entry and the next entry in the sequence @note The index used here is relative to the start of the text we were shaped from, even if we were only shaped from a sub-section of that text
uint16	GetMaxTextHeight()	Get the maximum height of any glyph in the font we're using
TOptional< i...	GetMeasuredWidth ( const int32 InStartIndex, const int32 InEndIndex, const bool InIncludeKerningWithPrec... )	Get the measured width of the specified range of this shaped text @note The indices used here are relative to the start of the text we were shaped from, even if we were only shaped from a sub-section of that text
int32	GetMeasuredWidth()	Get the measured width of the entire shaped text
FShapedGlyph...	GetSubSequence ( const int32 InStartIndex, const int32 InEndIndex )	Get a sub-sequence of the specified range @note The indices used here are relative to the start of the text we were shaped from, even if we were only shaped from a sub-section of that text
int16	GetTextBaseline()	Get the baseline to use when drawing the glyphs in this sequence
bool	IsDirty()	Check to see whether this glyph sequence is dirty (ie, contains glyphs with invalid font pointers)

Classes

	Name	Description
	FGlyphOffsetResult	Return data used by GetGlyphAtOffset
	FSourceTextRange

Enums

	Name	Description
	EEnumerateGlyphsResult	Enumerate all of the glyphs within the given source index range (enumerates either visually or logically) @note The indices used here are relative to the start of the text we were shaped from, even if we were only shaped from a sub-section of that text

Typedefs

Name	Description
FForEachShapedGlyphEntryCallback

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss