From ffb641ed9c7f2c58f129f53b47900614e5fa1641 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 2 Jul 2025 19:56:17 +0200 Subject: [PATCH] GL: doc++ --- src/Magnum/GL/PixelFormat.h | 8 +++++--- src/Magnum/GL/Texture.h | 8 ++++++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/src/Magnum/GL/PixelFormat.h b/src/Magnum/GL/PixelFormat.h index 8c58635e7..ad527ac2d 100644 --- a/src/Magnum/GL/PixelFormat.h +++ b/src/Magnum/GL/PixelFormat.h @@ -27,7 +27,7 @@ */ /** @file - * @brief Enum @ref Magnum::GL::PixelFormat, @ref Magnum::GL::PixelType, @ref Magnum::GL::CompressedPixelFormat, function @ref Magnum::GL::hasPixelFormat(), @ref Magnum::GL::pixelFormat(), @ref Magnum::GL::pixelType(), @ref Magnum::GL::pixelFormatSize(), @ref Magnum::GL::genericPixelFormat(), @ref Magnum::GL::hasCompressedPixelFormat(), @ref Magnum::GL::compressedPixelFormat(), @ref Magnum::GL::genericCompressedPixelFormat() + * @brief Enum @ref Magnum::GL::PixelFormat, @ref Magnum::GL::PixelType, @ref Magnum::GL::CompressedPixelFormat, function @ref Magnum::GL::hasPixelFormat(), @ref Magnum::GL::pixelFormat(), @ref Magnum::GL::pixelType(), @ref Magnum::GL::pixelFormatSize(), @ref Magnum::GL::genericPixelFormat(), @ref Magnum::GL::hasCompressedPixelFormat(), @ref Magnum::GL::compressedPixelFormat(), @ref Magnum::GL::compressedPixelFormatBlockSize(), @ref Magnum::GL::compressedPixelFormatBlockDataSize(), @ref Magnum::GL::genericCompressedPixelFormat() */ #include @@ -2169,7 +2169,8 @@ Expects that @p format is not one of the generic @relativeref{CompressedPixelFormat,RGBA} formats for which properties are unspecified. For 2D formats the Z dimension is always 1. @see @ref compressedPixelFormatBlockDataSize(), - @ref Magnum::compressedPixelFormatBlockSize(), @ref pixelFormatSize() + @ref Magnum::compressedPixelFormatBlockSize(), + @ref Texture::compressedBlockSize(), @ref pixelFormatSize() */ MAGNUM_GL_EXPORT Vector3i compressedPixelFormatBlockSize(CompressedPixelFormat format); @@ -2183,7 +2184,8 @@ Expects that @p format is not one of the generic @relativeref{CompressedPixelFormat,RGBA} formats for which properties are unspecified. @see @ref compressedPixelFormatBlockSize(), - @ref Magnum::compressedPixelFormatBlockDataSize(), @ref pixelFormatSize() + @ref Magnum::compressedPixelFormatBlockDataSize(), + @ref Texture::compressedBlockDataSize(), @ref pixelFormatSize() */ MAGNUM_GL_EXPORT UnsignedInt compressedPixelFormatBlockDataSize(CompressedPixelFormat format); diff --git a/src/Magnum/GL/Texture.h b/src/Magnum/GL/Texture.h index fb3f46a90..82a52be97 100644 --- a/src/Magnum/GL/Texture.h +++ b/src/Magnum/GL/Texture.h @@ -134,7 +134,9 @@ Texture: public AbstractTexture { * pixels). For uncompressed formats returns zero vector. * @see @ref compressedBlockDataSize(), @fn_gl_keyword{GetInternalformat} * with @def_gl_keyword{TEXTURE_COMPRESSED_BLOCK_WIDTH}, - * @def_gl_keyword{TEXTURE_COMPRESSED_BLOCK_HEIGHT} + * @def_gl_keyword{TEXTURE_COMPRESSED_BLOCK_HEIGHT}, + * @ref compressedPixelFormatBlockSize(), + * @ref Magnum::compressedPixelFormatBlockSize() * @requires_gl43 Extension @gl_extension{ARB,internalformat_query2} * @requires_gl Compressed texture queries are not available in OpenGL * ES. @@ -149,7 +151,9 @@ Texture: public AbstractTexture { * If @p format is compressed, returns compressed block data size (in * bytes). For uncompressed formats returns zero. * @see @ref compressedBlockSize(), @fn_gl_keyword{GetInternalformat} - * with @def_gl_keyword{TEXTURE_COMPRESSED_BLOCK_SIZE} + * with @def_gl_keyword{TEXTURE_COMPRESSED_BLOCK_SIZE}, + * @ref compressedPixelFormatBlockDataSize(), + * @ref Magnum::compressedPixelFormatBlockDataSize() * @requires_gl43 Extension @gl_extension{ARB,internalformat_query2} * @requires_gl Compressed texture queries are not available in OpenGL * ES.