FFontImportOptionsData Struct Reference

Font import options. More...

Public Member Functions
Functions
void	SetbAlphaOnly (bool Value)
	if true then forces PF_G8 and only maintains Alpha value and discards color
void	SetbEnableAntialiasing (bool Value)
	Whether the font should be antialiased or not. Usually you should leave this enabled.
void	SetbEnableBold (bool Value)
	Whether the font should be generated in bold or not.
void	SetbEnableItalic (bool Value)
	Whether the font should be generated in italics or not.
void	SetbEnableUnderline (bool Value)
	Whether the font should be generated with an underline or not.
FFontImportOptionsData &	opAssign (FFontImportOptionsData Other)
void	SetbCreatePrintableOnly (bool Value)
	Skips generation of glyphs for any characters that are not considered 'printable'.
void	SetbIncludeASCIIRange (bool Value)
	When specifying a range of characters and this is enabled, forces ASCII characters (0 thru 255) to be included as well.
void	SetbEnableDropShadow (bool Value)
	Enables a very simple, 1-pixel, black colored drop shadow for the generated font.
void	SetbEnableLegacyMode (bool Value)
	Enables legacy font import mode. This results in lower quality antialiasing and larger glyph bounds, but may be useful when debugging problems.
void	SetbUseDistanceFieldAlpha (bool Value)
	If true then the alpha channel of the font textures will store a distance field instead of a color mask.

Public Attributes
FontImportOptionsData
int	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.
float32	Height
	Height of font (point size).
EFontImportCharacterSet	CharacterSet
	Character set for this font.
FString	Chars
	Explicit list of characters to include in the font.
FString	UnicodeRange
	Range of Unicode character values to include in the font. You can specify ranges using hyphens and/or commas (e.g. '400-900').
FString	CharsFilePath
	Path on disk to a folder where files that contain a list of characters to include in the font.
FString	CharsFileWildcard
	File mask wildcard that specifies which files within the CharsFilePath to scan for characters in include in the font.
FLinearColor	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.
int	TexturePageWidth
	Horizontal size of each texture page for this font in pixels.
FString	FontName
	Name of the typeface for the font to import.
int	XPadding
	Horizontal padding between each font character on the texture page in pixels.
int	YPadding
	Vertical padding between each font character on the texture page in pixels.
int	ExtendBoxTop
	How much to extend the top of the UV coordinate rectangle for each character in pixels.
int	ExtendBoxBottom
	How much to extend the bottom of the UV coordinate rectangle for each character in pixels.
int	ExtendBoxRight
	How much to extend the right of the UV coordinate rectangle for each character in pixels.
int	ExtendBoxLeft
	How much to extend the left of the UV coordinate rectangle for each character in pixels.
int	Kerning
	The initial horizontal spacing adjustment between rendered characters. This setting will be copied directly into the generated Font object's properties.
int	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.
float32	DistanceFieldScanRadiusScale
	Shrinks or expands the scan radius used to determine the silhouette of the font edges.

Detailed Description

Font import options.

Member Function Documentation

opAssign()

FFontImportOptionsData & opAssign

(

FFontImportOptionsData

Other

)

SetbAlphaOnly()

void SetbAlphaOnly

(

bool

Value

)

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

SetbCreatePrintableOnly()

void SetbCreatePrintableOnly

(

bool

Value

)

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

SetbEnableAntialiasing()

void SetbEnableAntialiasing

(

bool

Value

)

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

SetbEnableBold()

void SetbEnableBold

(

bool

Value

)

Whether the font should be generated in bold or not.

SetbEnableDropShadow()

void SetbEnableDropShadow

(

bool

Value

)

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

SetbEnableItalic()

void SetbEnableItalic

(

bool

Value

)

Whether the font should be generated in italics or not.

SetbEnableLegacyMode()

void SetbEnableLegacyMode

(

bool

Value

)

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

SetbEnableUnderline()

void SetbEnableUnderline

(

bool

Value

)

Whether the font should be generated with an underline or not.

SetbIncludeASCIIRange()

void SetbIncludeASCIIRange

(

bool

Value

)

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

SetbUseDistanceFieldAlpha()

void SetbUseDistanceFieldAlpha

(

bool

Value

)

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

Member Data Documentation

CharacterSet

EFontImportCharacterSet CharacterSet

Character set for this font.

Chars

FString Chars

Explicit list of characters to include in the font.

CharsFilePath

FString CharsFilePath

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

CharsFileWildcard

FString CharsFileWildcard

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

DistanceFieldScaleFactor

int 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

float32 DistanceFieldScanRadiusScale

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

ExtendBoxBottom

int ExtendBoxBottom

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

ExtendBoxLeft

int ExtendBoxLeft

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

ExtendBoxRight

int ExtendBoxRight

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

ExtendBoxTop

int ExtendBoxTop

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

FontName

FString FontName

Name of the typeface for the font to import.

ForegroundColor

FLinearColor 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

float32 Height

Height of font (point size).

Kerning

int Kerning

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

TexturePageMaxHeight

int 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

int TexturePageWidth

Horizontal size of each texture page for this font in pixels.

UnicodeRange

FString 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

int XPadding

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

YPadding

int YPadding

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