From 58e88c177b7e93ca031705711e860387f3d40699 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 20 Oct 2023 16:39:47 +0200 Subject: [PATCH] Text: document that Renderer is only available on GL builds. Still need to rename it, along with the glyph caches. --- src/Magnum/Text/Renderer.h | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/src/Magnum/Text/Renderer.h b/src/Magnum/Text/Renderer.h index 4447d908e..4827a5134 100644 --- a/src/Magnum/Text/Renderer.h +++ b/src/Magnum/Text/Renderer.h @@ -55,6 +55,11 @@ namespace Magnum { namespace Text { Not meant to be used directly, see the @ref Renderer class for more information. + +@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. + @see @ref Renderer2D, @ref Renderer3D */ class MAGNUM_TEXT_EXPORT AbstractRenderer { @@ -276,6 +281,10 @@ available in ES 2.0, at least @gl_extension{OES,mapbuffer} must be supported for asynchronous buffer updates. There is no similar extension in WebGL, thus plain (and slow) buffer updates are used there. +@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. + @see @ref Renderer2D, @ref Renderer3D, @ref AbstractFont, @ref Shaders::VectorGL, @ref Shaders::DistanceFieldVectorGL */ @@ -314,10 +323,22 @@ template class MAGNUM_TEXT_EXPORT Renderer: public Abstr #endif }; -/** @brief Two-dimensional text renderer */ +/** +@brief Two-dimensional text renderer + +@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. +*/ typedef Renderer<2> Renderer2D; -/** @brief Three-dimensional text renderer */ +/** +@brief Three-dimensional text renderer + +@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. +*/ typedef Renderer<3> Renderer3D; }}