FFontImportOptionsData Struct Reference

#include <FontImportOptions.h>

Public Member Functions
	FFontImportOptionsData ()

Public Attributes
FString	FontName
float	Height
uint32	bEnableAntialiasing:1
uint32	bEnableBold:1
uint32	bEnableItalic:1
uint32	bEnableUnderline:1
uint32	bAlphaOnly:1
TEnumAsByte< enum EFontImportCharacterSet >	CharacterSet
FString	Chars
FString	UnicodeRange
FString	CharsFilePath
FString	CharsFileWildcard
uint32	bCreatePrintableOnly:1
uint32	bIncludeASCIIRange:1
FLinearColor	ForegroundColor
uint32	bEnableDropShadow:1
int32	TexturePageWidth
int32	TexturePageMaxHeight
int32	XPadding
int32	YPadding
int32	ExtendBoxTop
int32	ExtendBoxBottom
int32	ExtendBoxRight
int32	ExtendBoxLeft
uint32	bEnableLegacyMode:1
int32	Kerning
uint32	bUseDistanceFieldAlpha:1
int32	DistanceFieldScaleFactor
float	DistanceFieldScanRadiusScale

Detailed Description

Font import options

Constructor & Destructor Documentation

FFontImportOptionsData()

FFontImportOptionsData::FFontImportOptionsData ( )

inline

Default constructor.

Member Data Documentation

bAlphaOnly

uint32 FFontImportOptionsData::bAlphaOnly

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

bCreatePrintableOnly

uint32 FFontImportOptionsData::bCreatePrintableOnly

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

bEnableAntialiasing

uint32 FFontImportOptionsData::bEnableAntialiasing

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

bEnableBold

uint32 FFontImportOptionsData::bEnableBold

Whether the font should be generated in bold or not

bEnableDropShadow

uint32 FFontImportOptionsData::bEnableDropShadow

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

bEnableItalic

uint32 FFontImportOptionsData::bEnableItalic

Whether the font should be generated in italics or not

bEnableLegacyMode

uint32 FFontImportOptionsData::bEnableLegacyMode

Enables legacy font import mode. This results in lower quality antialiasing and larger glyph bounds, but may be useful when debugging problems

bEnableUnderline

uint32 FFontImportOptionsData::bEnableUnderline

Whether the font should be generated with an underline or not

bIncludeASCIIRange

uint32 FFontImportOptionsData::bIncludeASCIIRange

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

bUseDistanceFieldAlpha

uint32 FFontImportOptionsData::bUseDistanceFieldAlpha

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

CharacterSet

TEnumAsByte<enum EFontImportCharacterSet> FFontImportOptionsData::CharacterSet

Character set for this font

Chars

FString FFontImportOptionsData::Chars

Explicit list of characters to include in the font

CharsFilePath

FString FFontImportOptionsData::CharsFilePath

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

CharsFileWildcard

FString FFontImportOptionsData::CharsFileWildcard

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

DistanceFieldScaleFactor

int32 FFontImportOptionsData::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.

DistanceFieldScanRadiusScale

float FFontImportOptionsData::DistanceFieldScanRadiusScale

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

ExtendBoxBottom

int32 FFontImportOptionsData::ExtendBoxBottom

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

ExtendBoxLeft

int32 FFontImportOptionsData::ExtendBoxLeft

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

ExtendBoxRight

int32 FFontImportOptionsData::ExtendBoxRight

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

ExtendBoxTop

int32 FFontImportOptionsData::ExtendBoxTop

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

FontName

FString FFontImportOptionsData::FontName

Name of the typeface for the font to import

ForegroundColor

FLinearColor FFontImportOptionsData::ForegroundColor

Color of the foreground font pixels. Usually you should leave this white and instead use the UI Styles editor to change the color of the font on the fly

Height

float FFontImportOptionsData::Height

Height of font (point size)

Kerning

int32 FFontImportOptionsData::Kerning

The initial horizontal spacing adjustment between rendered characters. This setting will be copied directly into the generated Font object's properties.

TexturePageMaxHeight

int32 FFontImportOptionsData::TexturePageMaxHeight

The maximum vertical size of a texture page for this font in pixels. The actual height of a texture page may be less than this if the font can fit within a smaller sized texture page.

TexturePageWidth

int32 FFontImportOptionsData::TexturePageWidth

Horizontal size of each texture page for this font in pixels

UnicodeRange

FString FFontImportOptionsData::UnicodeRange

Range of Unicode character values to include in the font. You can specify ranges using hyphens and/or commas (e.g. '400-900')

XPadding

int32 FFontImportOptionsData::XPadding

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

YPadding

int32 FFontImportOptionsData::YPadding

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

---

The documentation for this struct was generated from the following file:

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