FCharacterList

Manages a potentially large list of non-shaped characters Uses a directly indexed by TCHAR array until space runs out and then maps the rest to conserve memory Every character indexed by TCHAR could potentially cost a lot of memory of a lot of empty entries are created because characters being used are far apart

Windows
MacOS
Linux

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Fonts/FontCache.h

Include

#include "Fonts/FontCache.h"

Syntax

class FCharacterList

Remarks

Manages a potentially large list of non-shaped characters Uses a directly indexed by TCHAR array until space runs out and then maps the rest to conserve memory Every character indexed by TCHAR could potentially cost a lot of memory of a lot of empty entries are created because characters being used are far apart

Constructors

Name Description

Public function

FCharacterList

(
    const FSlateFontKey& InFontKey,
    FSlateFontCache& InFontCache
)

Functions

Name Description

Public function Const

int16

 

GetBaseline()

Returns the baseline for the font used by this character

Public function

FCharacterEn...

 

GetCharacter

(
    TCHAR Character,
    const EFontFallback MaxFontFallback
)

Gets data about how to render and measure a character Caching and atlasing it if needed

Public function

int8

 

GetKerning

(
    const FCharacterEntry& FirstCharac...,
    const FCharacterEntry& SecondChara...
)

Gets a kerning value for a pair of character entries

Public function

int8

 

GetKerning

(
    TCHAR FirstChar,
    TCHAR SecondChar,
    const EFontFallback MaxFontFallback
)

Gets a kerning value for a pair of characters

Public function Const

uint16

 

GetMaxHeight()

Public function Const

bool

 

IsStale()

Check to see if our cached data is potentially stale for our font

Public function Const

bool

 

IsValidIndex

(
    TCHAR Character
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss