Table of Contents

Class ResourceImporterImageFont

Imports a bitmap font where all glyphs have the same width and height.

Inheritance
ResourceImporterImageFont

Remarks

This image-based workflow can be easier to use than ResourceImporterBMFont, but it requires all glyphs to have the same width and height, glyph advances and drawing offsets can be customized. This makes ResourceImporterImageFont most suited to fixed-width fonts.

See also ResourceImporterDynamicFont.

See Also

Bitmap fonts - Using fonts

Properties

ascent

Font ascent (number of pixels above the baseline). If set to 0, half of the character height is used.

var ascent : int = 0

Property Value

int

character_margin

Margin applied around every imported glyph. If your font image contains guides (in the form of lines between glyphs) or if spacing between characters appears incorrect, try adjusting character_margin.

var character_margin : Rect2i = Rect2i(0, 0, 0, 0)

Property Value

Rect2i

character_ranges

The character ranges to import from the font image. This is an array that maps each position on the image (in tile coordinates, not pixels). The font atlas is traversed from left to right and top to bottom. Characters can be specified with decimal numbers (127), hexadecimal numbers (0x007f, or U+007f) or between single quotes ('~'). Ranges can be specified with a hyphen between characters.

For example, 0-127 represents the full ASCII range. It can also be written as 0x0000-0x007f (or U+0000-U+007f). As another example, ' '-'~' is equivalent to 32-127 and represents the range of printable (visible) ASCII characters.

For any range, the character advance and offset can be customized by appending three space-separated integer values (additional advance, x offset, y offset) to the end. For example 'a'-'b' 4 5 2 sets the advance to char_width + 4 and offset to Vector2(5, 2) for both a and b characters.

Make sure character_ranges doesn't exceed the number of columns * rows defined. Otherwise, the font will fail to import.

var character_ranges : PackedStringArray = PackedStringArray()

Property Value

PackedStringArray

columns

Number of columns in the font image. See also rows.

var columns : int = 1

Property Value

int

compress

If true, uses lossless compression for the resulting font.

var compress : bool = true

Property Value

bool

descent

Font descent (number of pixels below the baseline). If set to 0, half of the character height is used.

var descent : int = 0

Property Value

int

fallbacks

List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts at the beginning of the array are attempted first.

var fallbacks : Array = []

Property Value

Array

image_margin

Margin to cut on the sides of the entire image. This can be used to cut parts of the image that contain attribution information or similar.

var image_margin : Rect2i = Rect2i(0, 0, 0, 0)

Property Value

Rect2i

kerning_pairs

Kerning pairs for the font. Kerning pair adjust the spacing between two characters.

Each string consist of three space separated values: "from" string, "to" string and integer offset. Each combination form the two string for a kerning pair, e.g, ab cd -3 will create kerning pairs ac, ad, bc, and bd with offset -3. \uXXXX escape sequences can be used to add Unicode characters.

var kerning_pairs : PackedStringArray = PackedStringArray()

Property Value

PackedStringArray

rows

Number of rows in the font image. See also columns.

var rows : int = 1

Property Value

int

scaling_mode

Font scaling mode.

var scaling_mode : int = 2

Property Value

int