Text namespace
Text rendering.
Font texture creation and text layouting.
This library is built if WITH_TEXT is enabled when building Magnum. To use this library with CMake, you need to request the Text component of the Magnum package and link to the Magnum::Text target:
find_package(Magnum REQUIRED Text) # ... target_link_libraries(your-app Magnum::Text)
See Downloading and building and Usage with CMake for more information.
Additional plugins are built separately, see particular *Font and *FontConverter class documentation, Downloading and building, Downloading and building plugins, Usage with CMake, Plugin usage with CMake and Loading and using plugins for more information.
Classes
- class AbstractFont
- Base for font plugins.
- class AbstractFontConverter
- Base for font converter plugins.
- class AbstractLayouter
- Base for text layouters.
- class AbstractRenderer
- Base for text renderers.
- class DistanceFieldGlyphCache
- Glyph cache with distance field rendering.
- class FreeTypeFont
- FreeType font plugin.
- class GlyphCache
- Glyph cache.
- class HarfBuzzFont
- HarfBuzz font plugin.
- class MagnumFont
- Simple bitmap font plugin.
- class MagnumFontConverter
- MagnumFont converter plugin.
-
template<UnsignedInt dimensions>class Renderer
- Text renderer.
- class StbTrueTypeFont
- TrueType font plugin using stb_freetype.
Enums
- enum class Alignment: UnsignedByte { LineLeft = Implementation::AlignmentLine|Implementation::AlignmentLeft, LineCenter = Implementation::AlignmentLine|Implementation::AlignmentCenter, LineRight = Implementation::AlignmentLine|Implementation::AlignmentRight, MiddleLeft = Implementation::AlignmentMiddle|Implementation::AlignmentLeft, MiddleCenter = Implementation::AlignmentMiddle|Implementation::AlignmentCenter, MiddleRight = Implementation::AlignmentMiddle|Implementation::AlignmentRight, TopLeft = Implementation::AlignmentTop|Implementation::AlignmentLeft, TopCenter = Implementation::AlignmentTop|Implementation::AlignmentCenter, TopRight = Implementation::AlignmentTop|Implementation::AlignmentRight, LineCenterIntegral = Implementation::AlignmentLine|Implementation::AlignmentCenter|Implementation::AlignmentIntegral, MiddleLeftIntegral = Implementation::AlignmentMiddle|Implementation::AlignmentLeft|Implementation::AlignmentIntegral, MiddleCenterIntegral = Implementation::AlignmentMiddle|Implementation::AlignmentCenter|Implementation::AlignmentIntegral, MiddleRightIntegral = Implementation::AlignmentMiddle|Implementation::AlignmentRight|Implementation::AlignmentIntegral }
- Text rendering alignment.
Typedefs
- using Renderer2D = Renderer<2>
- Two-dimensional text renderer.
- using Renderer3D = Renderer<3>
- Three-dimensional text renderer.
Enum documentation
enum class Magnum::
Text rendering alignment.
| Enumerators | |
|---|---|
| LineLeft |
Text start and line is at origin |
| LineCenter |
Text center and line is at origin |
| LineRight |
Text end and line is at origin |
| MiddleLeft |
Text start and vertical middle is at origin |
| MiddleCenter |
Text center and vertical middle is at origin |
| MiddleRight |
Text end and vertical middle is at origin |
| TopLeft |
Text start and top is at origin |
| TopCenter |
Text center and top is at origin |
| TopRight |
Text end and top is at origin |
| LineCenterIntegral |
Text center and line is at origin and alignment offset is integral |
| MiddleLeftIntegral |
Text start and vertical middle is at origin and alignment offset is integral |
| MiddleCenterIntegral |
Text center and vertical middle is at origin and alignment offset is integral |
| MiddleRightIntegral |
Text end and vertical middle is at origin and alignment offset is integral |