1. Epic GamesDeveloper
  3. FSlateFontInfo

FSlateFontInfo

A representation of a font in Slate.

API > API/Runtime > API/Runtime/SlateCore

A representation of a font in Slate.

   
Name FSlateFontInfo
Type struct
Header File /Engine/Source/Runtime/SlateCore/Public/Fonts/SlateFontInfo.h
Include Path #include "Fonts/SlateFontInfo.h"

Syntax

USTRUCT (BlueprintType ,  
        Meta=(HasNativeMake="/Script/SlateRHIRenderer.SlateFontBlueprintLibrary.MakeSlateFontInfo"))  
struct FSlateFontInfo

Constructors

Name Remarks Include Path Unreal Specifiers

FSlateFontInfo ( TSharedPtr< const FCompositeFont > InCompositeFont,
const float InSize,
const FName& InTypefaceFontName,
const FFontOutlineSettings& InOutlineSettings
)

 Creates and initializes a new instance with the specified font, size, and emphasis. Fonts/SlateFontInfo.h  

FSlateFontInfo ( const WIDECHAR* InFontName,
float InSize,
EFontHinting InHinting
)

 Creates and initializes a new instance with the specified font name and size. Fonts/SlateFontInfo.h  

FSlateFontInfo ( const ANSICHAR* InFontName,
float InSize,
EFontHinting InHinting
)

 Creates and initializes a new instance with the specified font name and size. Fonts/SlateFontInfo.h  

FSlateFontInfo ( const FName& InFontName,
float InSize,
EFontHinting InHinting
)

 Creates and initializes a new instance with the specified font name and size. Fonts/SlateFontInfo.h  
Default constructor. Fonts/SlateFontInfo.h  

FSlateFontInfo ( const UObject* InFontObject,
const float InSize,
const FName& InTypefaceFontName,
const FFontOutlineSettings& InOutlineSettings
)

 Creates and initializes a new instance with the specified font, size, and emphasis. Fonts/SlateFontInfo.h  

FSlateFontInfo ( const FString& InFontName,
float InSize,
EFontHinting InHinting,
const FFontOutlineSettings& InOutlineSettings
)

 Creates and initializes a new instance with the specified font name and size. Fonts/SlateFontInfo.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSlateFontInfo()

 Dtor. Must be inline Fonts/SlateFontInfo.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bForceMonospaced bool Enable pseudo-monospaced font. Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(DisplayName="Monospacing")
bMaterialIsStencil bool When enabled, whole quads are filled by the material without automatically stenciling the text - this needs to be done within the material (using Font Signed Distance node). Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
CompositeFont TSharedPtr< const FCompositeFont > The composite font data to use (valid when used with a Slate style set in C++) Fonts/SlateFontInfo.h  
FontFallback EFontFallback The font fallback level. Fonts/SlateFontInfo.h  
FontMaterial TObjectPtr< UObject > The material to use when rendering Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(AllowedClasses="/Script/Engine.MaterialInterface")
FontObject TObjectPtr< const UObject > The font object (valid when used from UMG or a Slate widget style asset) Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(AllowedClasses="/Script/Engine.Font", DisplayName="Font Family")
LetterSpacing int32 The uniform spacing (or tracking) between all characters in the text. Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(ClampMin=1000, ClampMax=10000)
MonospacedWidth float The uniform width to apply to all characters when bForceMonospaced is enabled, proportional of the font Size. Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(ClampMin=0, EditCondition="bForceMonospaced==true", EditConditionHides)
OutlineSettings FFontOutlineSettings Settings for applying an outline to a font Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
Size float The font size is a measure in point values. Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(ClampMin=1, ClampMax=1000)
SkewAmount float A skew amount to apply to the text. Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(ClampMin=5, ClampMax=5)
TypefaceFontName FName The name of the font to use from the default typeface (None will use the first entry) Fonts/SlateFontInfo.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SlateStyleRules
  • Meta=(DisplayName="Typeface", EditCondition="FontObject")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

   Fonts/SlateFontInfo.h  

float GetClampSize()

 Get the font size clamp for the font renderer (on 16bits) Fonts/SlateFontInfo.h  

float GetClampSkew()

 Get the skew amount clamp for the text shaper Fonts/SlateFontInfo.h  
Get the composite font pointer associated with this font info (either directly or via a UFont) Fonts/SlateFontInfo.h  

bool HasValidFont()

 Check to see whether this font info has a valid composite font pointer set (either directly or via a UFont) Fonts/SlateFontInfo.h  

bool IsIdenticalTo ( const FSlateFontInfo& Other
) const

   Fonts/SlateFontInfo.h  

bool IsLegacyIdenticalTo ( const FSlateFontInfo& Other
) const

 We need to verify equality without taking into account some more recently added UPROPERTY.. Fonts/SlateFontInfo.h  

void PostSerialize ( const FArchive& Ar
)

 Used to upgrade legacy font into so that it uses composite fonts Fonts/SlateFontInfo.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FSlateFontInfo& Other
) const

   Fonts/SlateFontInfo.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page