Magnum::Text::StbTrueTypeFont class

#include <MagnumPlugins/StbTrueTypeFont/StbTrueTypeFont.h>

Usage

This plugin depends on the Text library and is built if MAGNUM_WITH_STBTRUETYPEFONT is enabled when building Magnum Plugins and depends on the Text library. To use as a dynamic plugin, load "StbTrueTypeFont" via Corrade::PluginManager::Manager.

Additionally, if you're using Magnum as a CMake subproject, bundle the magnum-plugins repository and do the following:

set(MAGNUM_WITH_STBTRUETYPEFONT ON CACHE BOOL "" FORCE)
add_subdirectory(magnum-plugins EXCLUDE_FROM_ALL)

# So the dynamically loaded plugin gets built implicitly
add_dependencies(your-app MagnumPlugins::StbTrueTypeFont)

To use as a static plugin or as a dependency of another plugin with CMake, put FindMagnumPlugins.cmake into your modules/ directory, request the StbTrueTypeFont component of the MagnumPlugins package and link to the MagnumPlugins::StbTrueTypeFont target:

find_package(MagnumPlugins REQUIRED StbTrueTypeFont)

# ...
target_link_libraries(your-app PRIVATE MagnumPlugins::StbTrueTypeFont)

See Downloading and building plugins, Plugin usage with CMake, Loading and using plugins and File format support for more information.

Behavior and limitations

The fillGlyphCache() function expects a PixelFormat::R8Unorm glyph cache. If the format doesn't match or the glyphs can't fit, it prints a message to Error and returns false.

The stb_truetype library doesn't provide any advanced shaping capabilities, thus AbstractShaper::setScript(), setLanguage() and setDirection() are a no-op and return false. You're encouraged to use the HarfBuzzFont plugin if you need these. The stb_truetype doesn't implement support for glyph name mapping, you're encouraged to use the FreeTypeFont plugin if you need to query names or look up glyphs by name.

Hinting is not implemented in stb_truetype. Compared to FreeTypeFont or HarfBuzzFont you get larger glyphs with a more blurry look.

While stb_truetype provides access to font kerning tables, the plugin doesn't use them at the moment. The feature list passed to AbstractShaper::shape() is ignored.

Base classes

class AbstractFont

Base for font plugins.

Constructors, destructors, conversion operators

StbTrueTypeFont() deprecated in Git master explicit

Default constructor.

StbTrueTypeFont(PluginManager::AbstractManager& manager, const Containers::StringView& plugin) explicit

Plugin manager constructor.

Function documentation