1. Epic GamesDeveloper
  3. FSlateFontCache

FSlateFontCache

Font caching implementation Caches characters into textures as needed

Unreal Engine C++ API Reference > Runtime > SlateCore > Fonts

Inheritance Hierarchy

References

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

Syntax

class FSlateFontCache :  
    public ISlateAtlasProvider ,  
    public FSlateFlushableAtlasCache

Remarks

Font caching implementation Caches characters into textures as needed

Constructors

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool

CanLoadCodepoint ( const FFontData& InFontData,
const UTF32CHAR InCodepoint,
EFontFallback MaxFallbackLevel
)

 Whether or not the specified character, within the specified font, can be loaded with the specified maximum font fallback level
Public function bool Flush the cache if needed
Public function void

FlushCompositeFont ( const FCompositeFont& InCompositeFont
)

 Flush the given composite font out of the cache
Public function void Clears just the cached font data, but leaves the atlases alone
Public function void

FlushObject ( const UObject*const InObject
)

 Flush the given object out of the cache
Public function Const TArray< FString > Get the available sub-face data from the given font.
Public function Const TArray< FString >

GetAvailableFontSubFaces ( const FString& InFilename
)

  
Public function Const int16

GetBaseline ( const FSlateFontInfo& InFontInfo,
float FontScale
)

 Returns the baseline for the specified font.
Public function FCharacterList &

GetCharacterList ( const FSlateFontInfo& InFontInfo,
float FontScale,
const FFontOutlineSettings& InOutlineSettings
)

 Gets information for how to draw all non-shaped characters in the specified string.
Public function Const const FFontData &

GetDefaultFontData ( const FSlateFontInfo& InFontInfo
)

 Returns the font to use from the default typeface
Public function Const const TSet< FName > &

GetFontAttributes ( const FFontData& InFontData
)

 Returns the font attributes for the specified font.
Public function Const SIZE_T

GetFontDataAssetResidentMemory ( const UObject* FontDataAsset
)

 Gets the allocated font face data for a font data asset
Public function Const const FFontData &

GetFontDataForCodepoint ( const FSlateFontInfo& InFontInfo,
const UTF32CHAR InCodepoint,
float& OutScalingFactor
)

 Returns the font to use from the typeface associated with the given codepoint
Public function ISlateFontTexture * Get the texture resource for a font atlas at a given index
Public function Const int8

GetKerning ( const FFontData& InFontData,
const float InSize,
TCHAR First,
TCHAR Second,
float Scale
)

 Calculates the kerning amount for a pair of characters
Public function Const uint16

GetMaxCharacterHeight ( const FSlateFontInfo& InFontInfo,
float FontScale
)

 Returns the height of the largest character in the font.
Public function FShapedGlyphSequenceRef

GetOverflowEllipsisText ( const FSlateFontInfo& InFontInfo,
const float InFontScale
)

 Gets the overflow glyph sequence for a given font.
Public function FSdfGlyphFontAtlasData

GetSdfGlyphFontAtlasData ( const FShapedGlyphEntry& InShapedGlyph,
const FFontOutlineSettings& InOutlineSettings
)

 Get the atlas information and the scaled metrics of a given shaped sdf glyph.
Public function FShapedGlyphFontAtlasData

GetShapedGlyphFontAtlasData ( const FShapedGlyphEntry& InShapedGlyph,
const FFontOutlineSettings& InOutlineSettings
)

 Get the atlas information for the given shaped glyph. This information will be cached if required
Public function Const void

GetStrikeMetrics ( const FSlateFontInfo& InFontInfo,
const float FontScale,
int16& OutStrikeLinePos,
int16& OutStrikeLineThickness
)

 Get the strike metrics for the specified font.
Public function Const void

GetUnderlineMetrics ( const FSlateFontInfo& InFontInfo,
const float FontScale,
int16& OutUnderlinePos,
int16& OutUnderlineThickness
)

 Get the underline metrics for the specified font.
Public function Const bool

HasKerning ( const FFontData& InFontData
)

  
Public function FOnReleaseFontResources & Event called after releasing the rendering resources in ReleaseResources
Public function void Releases rendering resources
Public function Const FShapedGlyphSequenceRef

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

 Performs text shaping on the given string using the given font info.
Public function Const FShapedGlyphSequenceRef

ShapeBidirectionalText ( const TCHAR* InText,
const int32 InTextStart,
const int32 InTextLen,
const FSlateFontInfo& InFontInfo,
const float InFontScale,
const TextBiDi::ETextDirection InBaseDirection,
const ETextShapingMethod InTextShapingMethod
)

  
Public function FShapedGlyphSequenceRef

ShapeOverflowEllipsisText ( const FSlateFontInfo& InFontInfo,
const float InFontScale
)

 Performs text shaping on the overflow glyph sequence for a given font.
Public function Const FShapedGlyphSequenceRef

ShapeUnidirectionalText ( const FString& InText,
const FSlateFontInfo& InFontInfo,
const float InFontScale,
const TextBiDi::ETextDirection InTextDirection,
const ETextShapingMethod InTextShapingMethod
)

 Performs text shaping on the given range of the string using the given font info.
Public function Const FShapedGlyphSequenceRef

ShapeUnidirectionalText ( const TCHAR* InText,
const int32 InTextStart,
const int32 InTextLen,
const FSlateFontInfo& InFontInfo,
const float InFontScale,
const TextBiDi::ETextDirection InTextDirection,
const ETextShapingMethod InTextShapingMethod
)

  
Public function void Updates the texture used for rendering

Overridden from ISlateAtlasProvider

  Type Name Description
Public function Virtual Const FSlateShaderResource *

GetAtlasPageResource ( const int32 InIndex
)

 Get the page resource for the given index (verify with GetNumAtlasPages)
Public function Virtual Const FAtlasSlotInfo

GetAtlasSlotInfoAtPosition ( FIntPoint InPosition,
int32 AtlasIndex
)

 Finds a currently occupied slot at a position specified in atlas coordinates where 0,0 is the top left and the size of the atlas is bottom right
Public function Virtual Const int32 ISlateAtlasProvider
Public function Virtual Const bool Does the page resources for the given index only contain alpha information? This affects how the atlas visualizer will sample them (verify with GetNumAtlasPages)

Overridden from FSlateFlushableAtlasCache

  Type Name Description
Public function Virtual void

RequestFlushCache ( const FString& FlushReason
)

 Issues a request to clear all cached data from the cache

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page