diff --git a/src/Magnum/Text/Direction.h b/src/Magnum/Text/Direction.h index bc2e3ae5f..e51269976 100644 --- a/src/Magnum/Text/Direction.h +++ b/src/Magnum/Text/Direction.h @@ -99,9 +99,11 @@ MAGNUM_TEXT_EXPORT Debug& operator<<(Debug& debug, ShapeDirection value); @brief Direction a text is laid out in @m_since_latest -@see @ref ShapeDirection +@see @ref RendererCore::setLayoutDirection(), + @ref RendererCore::layoutDirection(), @ref ShapeDirection */ enum class LayoutDirection: UnsignedByte { + /** Unspecified */ Unspecified = 0, /** Horizontal text with lines advancing from top to bottom */ diff --git a/src/Magnum/Text/Feature.h b/src/Magnum/Text/Feature.h index 80e0df2b1..62145432b 100644 --- a/src/Magnum/Text/Feature.h +++ b/src/Magnum/Text/Feature.h @@ -179,7 +179,7 @@ enum class Feature: UnsignedInt { * `blwm`, [Below-base Mark Positioning](https://learn.microsoft.com/typography/opentype/spec/features_ae#blwm). * Intended for South-Asian scripts. * @m_keywords{blwm} - */ + */ BelowBaseMarkPositioning = Utility::Endianness::fourCC('b', 'l', 'w', 'm'), /** diff --git a/src/Magnum/Text/Renderer.h b/src/Magnum/Text/Renderer.h index c70c62c95..8cf18eeac 100644 --- a/src/Magnum/Text/Renderer.h +++ b/src/Magnum/Text/Renderer.h @@ -541,7 +541,10 @@ class MAGNUM_TEXT_EXPORT RendererCore { * Splits @p text into individual lines and shapes each with given * @p shaper. Places and aligns the text according to @ref cursor(), * @ref alignment() and @ref layoutDirection(), continuing from the - * state left after the previous @ref add(), if any. + * state left after the previous @ref add(), if any. Expects that + * @p shaper font is present in @ref glyphCache(), either added + * explicitly via @ref AbstractGlyphCache::addFont() or through + * @ref AbstractFont::fillGlyphCache(). * * After calling this function, @ref isRendering() returns * @cpp true @ce, @ref renderingGlyphCount() and @ref renderingRunCount() @@ -565,6 +568,7 @@ class MAGNUM_TEXT_EXPORT RendererCore { * overload to pass a string as a whole. * * The function uses @ref AbstractShaper::shape(), + * @ref AbstractGlyphCache::glyphIdsInto(), * @ref renderLineGlyphPositionsInto(), @ref alignRenderedLine() and * @ref glyphQuadBounds() internally, see their documentation for more * information. @@ -1211,13 +1215,18 @@ class MAGNUM_TEXT_EXPORT Renderer: public RendererCore { * @brief Set index type * @return Reference to self (for method chaining) * - * Sets the smallest possible index type to be used. Initially + * Expects that rendering is currently not in progress. Sets the + * smallest possible index type to be used. Initially * @ref MeshIndexType::UnsignedByte, a larger type is automatically * switched to once @ref glyphCapacity() exceeds @cpp 64 @ce and * @cpp 16384 @ce glyphs. Set to a larger type if you want it to be * used even if the glyph capacity is smaller. Setting it back to a * smaller type afterwards uses the type only if the glyph capacity * allows it. + * + * Note that the @ref RendererGL subclass changes the default index + * type to @ref MeshIndexType::UnsignedShort, as use of 8-bit indices + * is discouraged on contemporary GPUs. */ Renderer& setIndexType(MeshIndexType atLeast); diff --git a/src/Magnum/TextureTools/Atlas.h b/src/Magnum/TextureTools/Atlas.h index 6b86a13be..9d9f724fa 100644 --- a/src/Magnum/TextureTools/Atlas.h +++ b/src/Magnum/TextureTools/Atlas.h @@ -364,7 +364,7 @@ class MAGNUM_TEXTURETOOLS_EXPORT AtlasLandfill { * * The @p sizes, @p offsets and @p rotations views are expected to have * the same size. The @p sizes are all expected to be not larger than - * @ref size() after appying padding and then a rotation based on + * @ref size() after applying padding and then a rotation based on * @ref AtlasLandfillFlag::RotatePortrait or * @relativeref{AtlasLandfillFlag,RotateLandscape} being set. If * neither @relativeref{AtlasLandfillFlag,RotatePortrait} nor