Browse Source

Text: document failure state of AbstractFont::createGlyphCache() as well.

It's not used by (the currently only implementation in) MagnumFont, but
such behavior makes sense, so have it pinned down in docs.
pull/638/head
Vladimír Vondruš 2 years ago
parent
commit
e86c2a7426
  1. 5
      src/Magnum/Text/AbstractFont.h

5
src/Magnum/Text/AbstractFont.h

@ -516,6 +516,11 @@ class MAGNUM_TEXT_EXPORT AbstractFont: public PluginManager::AbstractPlugin {
* Available only if @ref FontFeature::PreparedGlyphCache is supported.
* Other fonts support only partial glyph cache filling, see
* @ref fillGlyphCache(). Expects that a font is opened.
*
* On success returns an instance of a newly created glyph cache. On
* failure, for example if a file containing glyph cache data cannot be
* open, prints a message to @relativeref{Magnum,Error} and returns
* @cpp nullptr @ce.
*/
Containers::Pointer<AbstractGlyphCache> createGlyphCache();

Loading…
Cancel
Save