Browse Source

Doc++

pull/168/head
Vladimír Vondruš 3 years ago
parent
commit
68f6d75ee3
  1. 2
      doc/changelog.dox
  2. 10
      src/Magnum/Text/AbstractFont.h
  3. 4
      src/Magnum/Text/DistanceFieldGlyphCache.h
  4. 8
      src/Magnum/Text/GlyphCache.h
  5. 3
      src/MagnumPlugins/MagnumFont/MagnumFont.h

2
doc/changelog.dox

@ -383,7 +383,7 @@ See also:
@ref GL::Framebuffer instead of a @ref GL::Texture as an output for an
easier ability to download the resulting image on OpenGL ES platforms;
the @ref magnum-distancefieldconverter "magnum-distancefieldconverter"
utility thus now compiles works and on OpenGL ES 3+ as well
utility thus now compiles and works on OpenGL ES 3+ as well
@subsubsection changelog-latest-new-trade Trade library

10
src/Magnum/Text/AbstractFont.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Text::AbstractFont, @ref Magnum::Text::AbstractLayouter, enum @ref Magnum::Text::FontFeature, enum set @ref Magnum::Text::FontFeatures
* @brief Class @ref Magnum::Text::AbstractFont, enum @ref Magnum::Text::FontFeature, enum set @ref Magnum::Text::FontFeatures
*/
#include <Corrade/PluginManager/AbstractPlugin.h>
@ -176,9 +176,9 @@ code reuse.
@section Text-AbstractFont-data-dependency Data dependency
The @ref AbstractLayouter instances returned from @ref layout() have a code and
data dependency on the dynamic plugin module --- since their implementation is
in the plugin module itself, the plugin can't be unloaded until the returned
The @ref AbstractShaper instances returned from @ref createShaper() have a code
and data dependency on the dynamic plugin module --- since their implementation
is in the plugin module itself, the plugin can't be unloaded until the returned
instance is destroyed.
@section Text-AbstractFont-subclassing Subclassing
@ -186,7 +186,7 @@ instance is destroyed.
The plugin needs to implement the @ref doFeatures(), @ref doClose(),
@ref doCreateShaper() functions, either @ref doCreateGlyphCache() or
@ref doFillGlyphCache() and one or more of `doOpen*()` functions. See also
@ref AbstractLayouter for more information.
@ref AbstractShaper for more information.
In order to support @ref FontFeature::FileCallback, the font needs to properly
use the callbacks to both load the top-level file in @ref doOpenFile() and also

4
src/Magnum/Text/DistanceFieldGlyphCache.h

@ -68,6 +68,10 @@ channels.
@snippet MagnumText-gl.cpp DistanceFieldGlyphCache-usage
See the @ref Renderer class for information about text rendering. The
@ref AbstractGlyphCache base class has more information about general glyph
cache usage.
@note This class is available only if Magnum is compiled with
@ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features
for more information.

8
src/Magnum/Text/GlyphCache.h

@ -49,11 +49,9 @@ Create the @ref GlyphCache object with sufficient size and then call
@snippet MagnumText-gl.cpp GlyphCache-usage
See the @ref Renderer class for information about text rendering.
This class supports @ref GlyphCacheFeature::ImageDownload (and thus calling
@ref image()) only on desktop OpenGL, due to using @ref GL::Texture::image(),
which is not available on @ref MAGNUM_TARGET_GLES "OpenGL ES" platforms.
See the @ref Renderer class for information about text rendering. The
@ref AbstractGlyphCache base class has more information about general glyph
cache usage.
@todo Some way for Font to negotiate or check internal texture format
@todo Default glyph 0 with rect 0 0 0 0 will result in negative dimensions when

3
src/MagnumPlugins/MagnumFont/MagnumFont.h

@ -157,7 +157,8 @@ need to instantiate a manager for them and register it with
@snippet plugins.cpp MagnumFont-importer-register
See @ref building, @ref cmake and @ref plugins for more information.
See @ref building, @ref cmake, @ref plugins and @ref file-formats for more
information.
*/
class MAGNUM_MAGNUMFONT_EXPORT MagnumFont: public AbstractFont {
public:

Loading…
Cancel
Save