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

Light Theme

Dark Theme

FFontData

Payload data describing an individual font in a typeface.

Windows

MacOS

Linux

References

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

Syntax

struct FFontData

Remarks

Payload data describing an individual font in a typeface. Keep this lean as it's also used as a key!

Constructors

	Name	Description
	FFontData()	Default constructor
	FFontData ( const UObject*const InFontFace..., const int32 InSubFaceIndex )	Construct the raw data from a font face asset
	FFontData ( FString InFontFilename, const EFontHinting InHinting, const EFontLoadingPolicy InLoadingP..., const int32 InSubFaceIndex )	Construct the raw data from a filename and the font data attributes

Functions

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector )	Called by FStandaloneCompositeFont to prevent our objects from being GCd
void	ConditionalUpgradeBulkDataToFontFace ( UObject* InOuter, UClass* InFontFaceClass, const FName InFontFaceName )	Upgrade v2 bulk data to v3 font face.
void	ConditionalUpgradeFontDataToBulkData ( UObject* InOuter )	Upgrade v1 font data to v2 bulk data.
const UObjec...	GetFontFaceAsset()	Get the font face asset used by this data (if any).
FFontFaceDat...	GetFontFaceData()	Get the data buffer containing the data for the current font face.
const FStrin...	GetFontFilename()	Get the filename of the font to use.
EFontHinting	GetHinting()	Get the hinting algorithm to use with the font.
EFontLayoutM...	GetLayoutMethod()	Get the method to use when laying out the font?
EFontLoading...	GetLoadingPolicy()	Get the enum controlling how this font should be loaded at runtime.
int32	GetSubFaceIndex()	Get the index of the sub-face that should be used.
bool	HasFont()	Is this font data set to a font? (either by filename or by inline data)
bool	HasLegacyData()	True if this object contains any legacy data that needs to be upgraded PostLoad by calling the functions below (in order).
bool	Serialize ( FArchive& Ar )	Handle serialization for this struct.
void	SetSubFaceIndex ( const int32 InSubFaceIndex )	Set the index of the sub-face that should be used.

Operators

		Name	Description
	bool	operator!= ( const FFontData& Other )	Check to see whether this font data is not equal to the other font data
	bool	operator== ( const FFontData& Other )	Check to see whether this font data is equal to the other font data

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

Take our survey

Dismiss