Cyotek.Drawing.BitmapFont Version 2 Released
A new version of our BMFont parsing library has been released.
Updated 10Jun2015: Code is now available on GitHub, any updates can be found there
While writing some bitmap font processing for an OpenGL project, I settled on using AngelCode's BMFont utility to generate both the textures and the font definition. However, this means I then needed to write a parser in order to use this in my OpenGL solution.
This library is a generic parser for the BMFont format - it doesn't include any rendering functionality or exotic references and should be usable in any version of .NET from 2.0 upwards. BMFont can generate fonts in three formats - binary, text and XML. The library currently supports text and XML, I may add binary support at another time; but currently I'm happy using the text format.
Note: This library only provides parsing functionality for loading BMFont data. It is up to you to provide functionality used to load textures and render characters
There are four main classes used to describe a font:
BitmapFont- the main class representing the font and its attributes
Character- representing a single character
Kerning- represents the kerning between a pair of characters
Page- represents a texture page
There is also a support class,
Padding, as I didn't want to
System.Windows.Forms in order to use its own and
Rectangle instead would be confusing. You can replace
System.Windows.Forms version if you want.
BitmapFontLoader class is a static class that
will handle the loading of your fonts.
To load a font, call
will attempt to auto detect the file type and load a font.
Alternatively, if you already know the file type in advance,
then call the variations
Each of these functions returns a new
BitmapFont object on
BitmapFont class returns all the information specified in
the font file, such as the attributes used to create the font.
Most of these not directly used and are there only for if your
application needs to know how the font was generated (for
example if the textures are packed or not). The main things you
would be interested in are:
Characters- this property contains all the characters defined in the font.
Kernings- this property contains all kerning definitions. However, mostly you should use the
GetKerningmethod to get the kerning for a pair of characters.
Pages-this property contains the filenames of the textures used by the font. You'll need to manually load the relevant textures.
LineHeight- this property returns the line height. When rending text across multiple lines, use this property for incrementing the vertical coordinate - don't just use the largest character height or you'll end up with inconsistent line heights.
Character class describes a single character. Your
rendering functionality will probably need to use all of the
properties it contains:
Bounds- the location and size of the character in the source texture.
TexturePage- the index of the page containing the source texture.
Offset- an offset to use when rendering the character so it lines up correctly with other characters.
XAdvance- the value to increment the horizontal coordinate by. Don't forgot to combine this value with the result of a call to
The sample project which accompanies this article shows a very basic way of rending using GDI; however this is just for demonstration purposes and you should probably come up with something more efficient in a real application!
Also included in the download for this article is a simple Windows Forms application for viewing a bitmap font.
Note: All of the fonts I have created and tested were unpacked. The font viewer does not support packed textures, and while it will still load the font, it will not draw glyphs properly as it isn't able to do any of the magic with channels that the packed texture requires. In addition, as .NET doesn't support the TGA format by default, neither does this sample project.
Unlike my other articles, I haven't really gone into the source code or pointed out how it works, however it should all be simple to understand and use (despite having virtually no documentation) - please let me know if you think otherwise!
As mentioned above, I'm currently not using packed textures. The font parser will give you all the information you need regarding channels for extracting the information, but could probably be nicer done, such as using enums instead of magic ints - I may address this in a future update, along side implementing the binary file format.
Ideally the best way to use this code would be to inherit or
BitmapFont class. Therefore it would probably be
better directly embedding the source code into your application,
change the namespaces to match your own solution, then build
I haven't tested with many fancy fonts - it's probable that the
MeasureFont method doesn't handle cases of fonts with have a
larger draw area than their basic box size.
Updates to this project will be posted to either CodePlex or GitHub - this article will be updated once the code is up.
Like what you're reading? Perhaps you like to buy us a coffee?