From 9b4fd3f45b324c6d6f990572effd297329d214a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 2 Oct 2024 19:41:46 +0200 Subject: [PATCH] Doc++ --- src/Magnum/PixelFormat.h | 8 ++++---- src/Magnum/Test/PixelFormatTest.cpp | 3 +++ src/Magnum/Text/GlyphCacheGL.h | 5 +++-- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/src/Magnum/PixelFormat.h b/src/Magnum/PixelFormat.h index 209f05033..3a5b48243 100644 --- a/src/Magnum/PixelFormat.h +++ b/src/Magnum/PixelFormat.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Enum @ref Magnum::PixelFormat, @ref Magnum::CompressedPixelFormat, function @ref Magnum::pixelFormatSize(), @ref Magnum::pixelFormatChannelFormat(), @ref Magnum::pixelFormatChannelCount(), @ref Magnum::isPixelFormatNormalized(), @ref Magnum::isPixelFormatNormalized(), @ref Magnum::isPixelFormatIntegral(), @ref Magnum::isPixelFormatFloatingPoint(), @ref Magnum::isPixelFormatSrgb(), @ref Magnum::isPixelFormatDepthOrStencil(), @ref Magnum::pixelFormat(), @ref Magnum::isPixelFormatImplementationSpecific(), @ref Magnum::pixelFormatWrap(), @ref Magnum::pixelFormatUnwrap(), @ref Magnum::compressedPixelFormatBlockSize(), @ref Magnum::compressedPixelFormatBlockDataSize(), @ref Magnum::isCompressedPixelFormatImplementationSpecific(), @ref Magnum::compressedPixelFormatWrap(), @ref Magnum::compressedPixelFormatUnwrap() + * @brief Enum @ref Magnum::PixelFormat, @ref Magnum::CompressedPixelFormat, function @ref Magnum::pixelFormatSize(), @ref Magnum::pixelFormatChannelFormat(), @ref Magnum::pixelFormatChannelCount(), @ref Magnum::isPixelFormatNormalized(), @ref Magnum::isPixelFormatIntegral(), @ref Magnum::isPixelFormatFloatingPoint(), @ref Magnum::isPixelFormatSrgb(), @ref Magnum::isPixelFormatDepthOrStencil(), @ref Magnum::pixelFormat(), @ref Magnum::isPixelFormatImplementationSpecific(), @ref Magnum::pixelFormatWrap(), @ref Magnum::pixelFormatUnwrap(), @ref Magnum::compressedPixelFormatBlockSize(), @ref Magnum::compressedPixelFormatBlockDataSize(), @ref Magnum::isCompressedPixelFormatImplementationSpecific(), @ref Magnum::compressedPixelFormatWrap(), @ref Magnum::compressedPixelFormatUnwrap() */ #include @@ -886,9 +886,9 @@ MAGNUM_EXPORT bool isPixelFormatFloatingPoint(PixelFormat format); @m_since_latest Returns @cpp true @ce for `*Srgb` formats, @cpp false @ce otherwise. If this -function returns true, @ref isPixelFormatNormalized() also returns true. -Expects that the pixel format is *not* implementation-specific and not a -depth/stencil format. +function returns @cpp true @ce, @ref isPixelFormatNormalized() also returns +@cpp true @ce. Expects that the pixel format is *not* implementation-specific +and not a depth/stencil format. @see @ref isPixelFormatImplementationSpecific(), @ref pixelFormat(PixelFormat, UnsignedInt, bool) */ diff --git a/src/Magnum/Test/PixelFormatTest.cpp b/src/Magnum/Test/PixelFormatTest.cpp index 763a5b0b5..6fb99d6b1 100644 --- a/src/Magnum/Test/PixelFormatTest.cpp +++ b/src/Magnum/Test/PixelFormatTest.cpp @@ -426,6 +426,9 @@ void PixelFormatTest::isNormalizedIntegralFloatingPointDepthStencilImplementatio } void PixelFormatTest::isSrgb() { + /* Verification that it's never both Srgb and FloatingPoint is done in + mapping() above */ + CORRADE_VERIFY(isPixelFormatSrgb(PixelFormat::RG8Srgb)); CORRADE_VERIFY(!isPixelFormatSrgb(PixelFormat::RG8Snorm)); CORRADE_VERIFY(!isPixelFormatSrgb(PixelFormat::RGB16F)); diff --git a/src/Magnum/Text/GlyphCacheGL.h b/src/Magnum/Text/GlyphCacheGL.h index fa656be91..8860e8a5b 100644 --- a/src/Magnum/Text/GlyphCacheGL.h +++ b/src/Magnum/Text/GlyphCacheGL.h @@ -178,8 +178,9 @@ class MAGNUM_TEXT_EXPORT GlyphCacheGL: public AbstractGlyphCache { * * Meant to be only used by subclasses that advertise * @ref GlyphCacheFeature::ImageProcessing and reimplement - * @ref doSetImage() to take the differences between @p format, @p size - * and @p processedFormat, @p processedSize into account. + * @ref AbstractGlyphCache::doSetImage() to take the differences + * between @p format, @p size and @p processedFormat, @p processedSize + * into account. * @see @ref AbstractGlyphCache(PixelFormat, const Vector2i&, const Vector2i&) */ explicit GlyphCacheGL(PixelFormat format, const Vector2i& size, PixelFormat processedFormat, const Vector2i& processedSize, const Vector2i& padding = Vector2i{1});