UFont Class Reference

A font object, for use by Slate, UMG, and Canvas. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Font
EFontCacheType	FontCacheType
	What kind of font caching should we use? This controls which options we see.
OfflineFont
float32	Leading
	@todo document
int	Kerning
	Default horizontal spacing between characters when rendering text with this font.
TArray< FFontCharacter >	Characters
	List of characters in the font. For a MultiFont, this will include all characters in all sub-fonts! Thus, the number of characters in this array isn't necessary the number of characters available in the font.
float32	EmScale
	Font metrics.
float32	Ascent
	@todo document
float32	Descent
	@todo document
FFontImportOptionsData	ImportOptions
	Options used when importing this font.
float32	ScalingFactor
	Scale to apply to the font.
RuntimeFont
FFontSdfSettings	SdfSettings
	Settings for rendering this font using the sdf pipeline.
int	LegacyFontSize
	The default size of the font used for legacy Canvas APIs that don't specify a font size.
FName	LegacyFontName
	The default font name to use for legacy Canvas APIs that don't specify a font name.
FCompositeFont	CompositeFont
	Embedded composite font data.
EFontRasterizationMode	FontRasterizationMode
	The preferred rasterization method for this font (enable / disable MSDF).
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Additional Inherited Members
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Detailed Description

A font object, for use by Slate, UMG, and Canvas.

A font can either be: Runtime cached - The font contains a series of TTF files that combine to form a composite font. The glyphs are cached on demand when required at runtime. Offline cached - The font contains a series of textures containing pre-baked cached glyphs and their associated texture coordinates.

Member Function Documentation

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

Ascent

float32 Ascent

@todo document

Characters

TArray<FFontCharacter> Characters

List of characters in the font. For a MultiFont, this will include all characters in all sub-fonts! Thus, the number of characters in this array isn't necessary the number of characters available in the font.

CompositeFont

FCompositeFont CompositeFont

Embedded composite font data.

Descent

float32 Descent

@todo document

EmScale

float32 EmScale

Font metrics.

FontCacheType

EFontCacheType FontCacheType

What kind of font caching should we use? This controls which options we see.

FontRasterizationMode

EFontRasterizationMode FontRasterizationMode

The preferred rasterization method for this font (enable / disable MSDF).

ImportOptions

FFontImportOptionsData ImportOptions

Options used when importing this font.

Kerning

int Kerning

Default horizontal spacing between characters when rendering text with this font.

Leading

float32 Leading

@todo document

LegacyFontName

FName LegacyFontName

The default font name to use for legacy Canvas APIs that don't specify a font name.

LegacyFontSize

int LegacyFontSize

The default size of the font used for legacy Canvas APIs that don't specify a font size.

ScalingFactor

float32 ScalingFactor

Scale to apply to the font.

SdfSettings

FFontSdfSettings SdfSettings

Settings for rendering this font using the sdf pipeline.