1. Epic GamesDeveloper
  3. UFontFace

UFontFace

A font face asset contains the raw payload data for a source TTF/OTF file as used by FreeType.

API > API/Runtime > API/Runtime/Engine

A font face asset contains the raw payload data for a source TTF/OTF file as used by FreeType. During cook this asset type generates a ".ufont" file containing the raw payload data (unless loaded "Inline").

   
Name UFontFace
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Engine/FontFace.h
Include Path #include "Engine/FontFace.h"

Syntax

UCLASS (HideCategories=Object, AutoExpandCategories=FontFace, MinimalAPI, BlueprintType)  
class UFontFace :  
    public UObject ,  
    public IFontFaceInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UFontFace()

 Default constructor Engine/FontFace.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AscendOverriddenValue int32 The typographic ascender of the face, expressed in font units. Engine/FontFace.h
  • EditAnywhere
  • Category=FontFace
  • AdvancedDisplay
  • Meta=(EditCondition=bIsAscendOverridden, EditConditionHides, ClampMin="-100", ClampMax="100")
bEnableDistanceFieldRendering bool Enables distance field rendering for this face (otherwise only Bitmap rendering is used) Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
bIsAscendOverridden bool Activate this option to use the specified ascend value instead of the value from the font. Engine/FontFace.h
  • EditAnywhere
  • Category=FontFace
  • AdvancedDisplay
bIsDescendOverridden bool Activate this option to use the specified descend value instead of the value from the font. Engine/FontFace.h
  • EditAnywhere
  • Category=FontFace
  • AdvancedDisplay
DescendOverriddenValue int32 The typographic ascender of the face, expressed in font units. Engine/FontFace.h
  • EditAnywhere
  • Category=FontFace
  • AdvancedDisplay
  • Meta=(EditCondition=bIsDescendOverridden, EditConditionHides, ClampMin="-100", ClampMax="100")
FontFaceData FFontFaceDataRef The data associated with the font face. Engine/FontFace.h  
Hinting EFontHinting The hinting algorithm to use with the font face. Engine/FontFace.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=FontFace
LayoutMethod EFontLayoutMethod Which method should we use when laying out the font? Try changing this if you notice clipping or height issues with your font. Engine/FontFace.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=FontFace
  • AdvancedDisplay
LoadingPolicy EFontLoadingPolicy Enum controlling how this font face should be loaded at runtime. Engine/FontFace.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=FontFace
MaxDistanceFieldPpem int32 Single-channel distance field px/em resolution "high" quality value Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
  • Meta=(ClampMin=8, ClampMax=256, DisplayName="High Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides)
MaxMultiDistanceFieldPpem int32 Multi-channel distance field px/em resolution "high" quality value Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
  • Meta=(ClampMin=8, ClampMax=256, DisplayName="High Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides)
MidDistanceFieldPpem int32 Single-channel distance field px/em resolution "medium" quality value Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
  • Meta=(ClampMin=8, ClampMax=256, DisplayName="Medium Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides)
MidMultiDistanceFieldPpem int32 Multi-channel distance field px/em resolution "medium" quality value Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
  • Meta=(ClampMin=8, ClampMax=256, DisplayName="Medium Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides)
MinDistanceFieldPpem int32 Single-channel distance field px/em resolution "low" quality value Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
  • Meta=(ClampMin=8, ClampMax=256, DisplayName="Low Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides)
MinMultiDistanceFieldPpem int32 Multi-channel distance field px/em resolution "low" quality value Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
  • Meta=(ClampMin=8, ClampMax=256, DisplayName="Low Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides)
PlatformRasterizationModeOverrides TOptional< FFontFacePlatformRasterizationOverrides > If set, allows to override distance field modes set in device profiles Engine/FontFace.h
  • EditAnywhere
  • Category=DistanceFieldMode
  • Meta=(ClampMin=8, ClampMax=256, DisplayName="Override Platform Rasterization Mode", EditCondition="bEnableDistanceFieldRendering", EditConditionHides)
SourceFilename FString The filename of the font face we were created from. Engine/FontFace.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=FontFace
StrikeBrushHeightPercentage int32 The percentage of the font height to draw the strike brush at. 0% is the bottom, 100% is the top. Engine/FontFace.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=FontFace
  • AdvancedDisplay
  • Meta=(ClampMin="0", ClampMax="100", ForceUnits="%")
SubFaces TArray< FString > Transient cache of the sub-faces available within this face Engine/FontFace.h
  • VisibleAnywhere
  • Transient
  • Category=FontFace
  • AdvancedDisplay

Protected

Name Type Remarks Include Path Unreal Specifiers
DeviceRasterizationSettings FFontRasterizationSettings Cached rasterization settings for the active device profile Engine/FontFace.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CacheSubFaces()

   Engine/FontFace.h  

virtual int32 GetAscendOverriddenValue()

   Engine/FontFace.h  

virtual int32 GetDescendOverriddenValue()

   Engine/FontFace.h  

virtual FFontFaceDataConstRef GetFontFaceData()

   Engine/FontFace.h  

virtual const FString & GetFontFilename()

   Engine/FontFace.h  

virtual EFontHinting GetHinting()

   Engine/FontFace.h  

virtual EFontLayoutMethod GetLayoutMethod()

   Engine/FontFace.h  

virtual EFontLoadingPolicy GetLoadingPolicy()

   Engine/FontFace.h  

virtual FFontRasterizationSettings GetRasterizationSettings()

   Engine/FontFace.h  

virtual int32 GetStrikeBrushHeightPercentage()

   Engine/FontFace.h  

virtual void InitializeFromBulkData ( const FString& InFilename,
const EFontHinting InHinting,
const void* InBulkDataPtr,
const int32 InBulkDataSizeBytes
)

   Engine/FontFace.h  

virtual bool IsAscendOverridden()

   Engine/FontFace.h  

virtual bool IsDescendOverridden()

   Engine/FontFace.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Engine/FontFace.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   Engine/FontFace.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Engine/FontFace.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Engine/FontFace.h  

virtual void PostEditUndo()

   Engine/FontFace.h  

virtual void PostLoad()

   Engine/FontFace.h  

virtual void Serialize ( FArchive& Ar
)

   Engine/FontFace.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
FontFaceData_DEPRECATED TArray< uint8 > The data associated with the font face. Engine/FontFace.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page