From 5e9bce3823e461d2b8de9b25df2599f6e55a50d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 30 Aug 2018 15:25:55 +0200 Subject: [PATCH] DebugTools: doc++ --- src/Magnum/DebugTools/BufferData.h | 8 +++---- src/Magnum/DebugTools/ForceRenderer.h | 8 +++---- src/Magnum/DebugTools/ObjectRenderer.h | 8 +++---- src/Magnum/DebugTools/ResourceManager.h | 4 ++-- src/Magnum/DebugTools/ShapeRenderer.h | 10 ++++---- src/Magnum/DebugTools/TextureImage.h | 32 ++++++++++++------------- 6 files changed, 36 insertions(+), 34 deletions(-) diff --git a/src/Magnum/DebugTools/BufferData.h b/src/Magnum/DebugTools/BufferData.h index 5dbfa61d4..00a090e9d 100644 --- a/src/Magnum/DebugTools/BufferData.h +++ b/src/Magnum/DebugTools/BufferData.h @@ -50,8 +50,8 @@ Emulates @ref GL::Buffer::subData() call on platforms that don't support it (such as OpenGL ES) by using @ref GL::Buffer::map(). @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. @requires_gles30 Extension @gl_extension{EXT,map_buffer_range} in OpenGL ES 2.0. @@ -70,8 +70,8 @@ Emulates @ref GL::Buffer::data() call on platforms that don't support it (such as OpenGL ES) by using @ref GL::Buffer::map(). @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. @requires_gles30 Extension @gl_extension{EXT,map_buffer_range} in OpenGL ES 2.0. diff --git a/src/Magnum/DebugTools/ForceRenderer.h b/src/Magnum/DebugTools/ForceRenderer.h index e6519ba91..7cc9f9e5a 100644 --- a/src/Magnum/DebugTools/ForceRenderer.h +++ b/src/Magnum/DebugTools/ForceRenderer.h @@ -47,8 +47,8 @@ namespace Magnum { namespace DebugTools { See @ref ForceRenderer documentation 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. + @ref MAGNUM_TARGET_GL "TARGET_GL" and `WITH_SCENEGRAPH` enabled (done by + default). See @ref building-features for more information. */ class ForceRendererOptions { public: @@ -109,8 +109,8 @@ new DebugTools::ForceRenderer2D(object, {0.3f, 1.5f, -0.7f}, &force, "my", debug @endcode @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. + @ref MAGNUM_TARGET_GL "TARGET_GL" and `WITH_SCENEGRAPH` enabled (done by + default). See @ref building-features for more information. @see @ref ForceRenderer2D, @ref ForceRenderer3D, @ref ForceRendererOptions */ diff --git a/src/Magnum/DebugTools/ObjectRenderer.h b/src/Magnum/DebugTools/ObjectRenderer.h index 115dd4170..67d8ed84f 100644 --- a/src/Magnum/DebugTools/ObjectRenderer.h +++ b/src/Magnum/DebugTools/ObjectRenderer.h @@ -46,8 +46,8 @@ namespace Magnum { namespace DebugTools { See @ref ObjectRenderer documentation 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. + @ref MAGNUM_TARGET_GL "TARGET_GL" and `WITH_SCENEGRAPH` enabled (done by + default). See @ref building-features for more information. */ class ObjectRendererOptions { public: @@ -91,8 +91,8 @@ new DebugTools::ObjectRenderer2D(object, "my", debugDrawables); @endcode @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. + @ref MAGNUM_TARGET_GL "TARGET_GL" and `WITH_SCENEGRAPH` enabled (done by + default). See @ref building-features for more information. @see @ref ObjectRenderer2D, @ref ObjectRenderer3D, @ref ObjectRendererOptions */ diff --git a/src/Magnum/DebugTools/ResourceManager.h b/src/Magnum/DebugTools/ResourceManager.h index 765511104..e555ca7f7 100644 --- a/src/Magnum/DebugTools/ResourceManager.h +++ b/src/Magnum/DebugTools/ResourceManager.h @@ -71,8 +71,8 @@ Stores various data used by debug renderers. See @ref debug-tools 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. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ #ifdef MAGNUM_BUILD_DEPRECATED CORRADE_IGNORE_DEPRECATED_PUSH diff --git a/src/Magnum/DebugTools/ShapeRenderer.h b/src/Magnum/DebugTools/ShapeRenderer.h index dc348ecf0..8a8a2b852 100644 --- a/src/Magnum/DebugTools/ShapeRenderer.h +++ b/src/Magnum/DebugTools/ShapeRenderer.h @@ -82,8 +82,9 @@ namespace Implementation { See @ref ShapeRenderer documentation 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. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default) and + `WITH_SHAPES` enabled (disabled by default). See @ref building-features for + more information. */ class CORRADE_DEPRECATED("scheduled for removal, see the docs for alternatives") ShapeRendererOptions { public: @@ -177,8 +178,9 @@ new DebugTools::ShapeRenderer2D(shape, "red", debugDrawables); @endcode @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. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default) and + `WITH_SHAPES` enabled (disabled by default). See @ref building-features for + more information. @see @ref ShapeRenderer2D, @ref ShapeRenderer3D, @ref ShapeRendererOptions diff --git a/src/Magnum/DebugTools/TextureImage.h b/src/Magnum/DebugTools/TextureImage.h index 3ec10a5c6..191f83618 100644 --- a/src/Magnum/DebugTools/TextureImage.h +++ b/src/Magnum/DebugTools/TextureImage.h @@ -55,8 +55,8 @@ additional shader and the @glsl floatBitsToUint() @ce GLSL function and then reinterpreted back to @ref GL::PixelType::Float when read to client memory. @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D& image); @@ -70,8 +70,8 @@ Image2D image = DebugTools::textureSubImage(texture, 0, rect, {PixelFormat::RGBA @endcode @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT Image2D textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D&& image); @@ -87,8 +87,8 @@ marked as framebuffer readable are supported; their generic @ref Magnum::PixelFormat "PixelFormat" counterparts are supported as well. @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D& image); @@ -102,8 +102,8 @@ Image2D image = DebugTools::textureSubImage(texture, CubeMapCoordinate::Positive @endcode @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT Image2D textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D&& image); @@ -124,8 +124,8 @@ marked as framebuffer readable are supported; their generic @requires_webgl20 Pixel buffer objects are not available in WebGL 1.0. @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage); @@ -139,8 +139,8 @@ BufferImage2D image = DebugTools::textureSubImage(texture, 0, rect, {PixelFormat @endcode @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT GL::BufferImage2D textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage); @@ -158,8 +158,8 @@ marked as framebuffer readable are supported; their generic @requires_webgl20 Pixel buffer objects are not available in WebGL 1.0. @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage); @@ -173,8 +173,8 @@ BufferImage2D image = DebugTools::textureSubImage(texture, CubeMapCoordinate::Po @endcode @note This function is available only if Magnum is compiled with - @ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features - for more information. + @ref MAGNUM_TARGET_GL "TARGET_GL" enabled (done by default). See + @ref building-features for more information. */ MAGNUM_DEBUGTOOLS_EXPORT GL::BufferImage2D textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage); #endif