FFontImportOptionsData

Font import options

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/FontImportOptions.h

Include

#include "Engine/FontImportOptions.h"

Syntax

struct FFontImportOptionsData

Remarks

Font import options

Variables

Name Description

Public variable

uint32: 1

 

bAlphaOnly

If true then forces PF_G8 and only maintains Alpha value and discards color

Public variable

uint32: 1

 

bCreatePrintableOnly

Skips generation of glyphs for any characters that are not considered 'printable'

Public variable

uint32: 1

 

bEnableAntialiasing

Whether the font should be antialiased or not. Usually you should leave this enabled.

Public variable

uint32: 1

 

bEnableBold

Whether the font should be generated in bold or not

Public variable

uint32: 1

 

bEnableDropShadow

Enables a very simple, 1-pixel, black colored drop shadow for the generated font

Public variable

uint32: 1

 

bEnableItalic

Whether the font should be generated in italics or not

Public variable

uint32: 1

 

bEnableLegacyMode

Enables legacy font import mode.

Public variable

uint32: 1

 

bEnableUnderline

Whether the font should be generated with an underline or not

Public variable

uint32: 1

 

bIncludeASCIIRange

When specifying a range of characters and this is enabled, forces ASCII characters (0 thru 255) to be included as well

Public variable

uint32: 1

 

bUseDistanceFieldAlpha

If true then the alpha channel of the font textures will store a distance field instead of a color mask

Public variable

TEnumAsByte< en...

 

CharacterSet

Character set for this font

Public variable

FString

 

Chars

Explicit list of characters to include in the font

Public variable

FString

 

CharsFilePath

Path on disk to a folder where files that contain a list of characters to include in the font

Public variable

FString

 

CharsFileWildcard

File mask wildcard that specifies which files within the CharsFilePath to scan for characters in include in the font

Public variable

int32

 

DistanceFieldScaleFactor

Scale factor determines how big to scale the font bitmap during import when generating distance field values Note that higher values give better quality but importing will take much longer.

Public variable

float

 

DistanceFieldScanRadiusScale

Shrinks or expands the scan radius used to determine the silhouette of the font edges.

Public variable

int32

 

ExtendBoxBottom

How much to extend the bottom of the UV coordinate rectangle for each character in pixels

Public variable

int32

 

ExtendBoxLeft

How much to extend the left of the UV coordinate rectangle for each character in pixels

Public variable

int32

 

ExtendBoxRight

How much to extend the right of the UV coordinate rectangle for each character in pixels

Public variable

int32

 

ExtendBoxTop

How much to extend the top of the UV coordinate rectangle for each character in pixels

Public variable

FString

 

FontName

Name of the typeface for the font to import

Public variable

FLinearColor

 

ForegroundColor

Color of the foreground font pixels.

Public variable

float

 

Height

Height of font (point size)

Public variable

int32

 

Kerning

The initial horizontal spacing adjustment between rendered characters.

Public variable

int32

 

TexturePageMaxHeight

The maximum vertical size of a texture page for this font in pixels.

Public variable

int32

 

TexturePageWidth

Horizontal size of each texture page for this font in pixels

Public variable

FString

 

UnicodeRange

Range of Unicode character values to include in the font.

Public variable

int32

 

XPadding

Horizontal padding between each font character on the texture page in pixels

Public variable

int32

 

YPadding

Vertical padding between each font character on the texture page in pixels

Constructors

Name Description

Public function

FFontImportOptionsData()

Default constructor.

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