UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FontCache.h File Reference
#include "CoreMinimal.h"
#include "SlateGlobals.h"
#include "Fonts/ShapedTextFwd.h"
#include "UObject/ObjectMacros.h"
#include "Fonts/SlateFontInfo.h"
#include "Fonts/FontRasterizationMode.h"
#include "Fonts/FontSdfSettings.h"
#include "Textures/TextureAtlas.h"
#include "Fonts/FontTypes.h"
#include "FontCache.generated.h"

Go to the source code of this file.

Classes

struct  FShapedGlyphFontAtlasData
 
struct  FSdfGlyphFontAtlasData
 
struct  FSdfGlyphFontAtlasData::FMetrics
 
struct  FShapedGlyphEntry
 
struct  FShapedGlyphEntryKey
 
struct  FSdfGlyphEntryKey
 
struct  FSdfGlyphTaskKey
 
class  FShapedGlyphSequence
 
struct  FShapedGlyphSequence::FSourceTextRange
 
struct  FShapedGlyphSequence::FGlyphOffsetResult
 
struct  FCharacterEntry
 
class  FCharacterList
 
class  FSlateFontCache
 

Enumerations

enum class  EFontCacheAtlasDataType : uint8 { Regular = 0 , Outline , Num }
 
enum class  ETextShapingMethod : uint8 { Auto = 0 , KerningOnly , FullShaping }
 

Functions

SLATECORE_API bool IsSlateSdfTextFeatureEnabled ()
 
SLATECORE_API ETextShapingMethod GetDefaultTextShapingMethod ()
 

Enumeration Type Documentation

◆ EFontCacheAtlasDataType

Enumerator
Regular 

Data was cached for a regular non-outline font

Outline 

Data was cached for a outline (stroked) font

Num 

Must be last

◆ ETextShapingMethod

enum class ETextShapingMethod : uint8
strong

Methods that can be used to shape text.

Note
If you change this enum, make sure and update CVarDefaultTextShapingMethod and GetDefaultTextShapingMethod.
Enumerator
Auto 

Automatically picks the fastest possible shaping method (either KerningOnly or FullShaping) based on the reading direction of the text. Left-to-right text uses the KerningOnly method, and right-to-left text uses the FullShaping method.

KerningOnly 

Provides fake shaping using only kerning data. This can be faster than full shaping, but won't render complex right-to-left or bi-directional glyphs (such as Arabic) correctly. This can be useful as an optimization when you know your text block will only show simple glyphs (such as numbers).

FullShaping 

Provides full text shaping, allowing accurate rendering of complex right-to-left or bi-directional glyphs (such as Arabic). This mode will perform ligature replacement for all languages (such as the combined "fi" glyph in English).

Function Documentation

◆ GetDefaultTextShapingMethod()

SLATECORE_API ETextShapingMethod GetDefaultTextShapingMethod ( )

Get the default shaping method (from the "Slate.DefaultTextShapingMethod" CVar)

◆ IsSlateSdfTextFeatureEnabled()

SLATECORE_API bool IsSlateSdfTextFeatureEnabled ( )

Controls whether the signed distance field rendering mode feature for text is enabled.