Browse Source

GL: doc++

pull/680/head
Vladimír Vondruš 10 months ago
parent
commit
ffb641ed9c
  1. 8
      src/Magnum/GL/PixelFormat.h
  2. 8
      src/Magnum/GL/Texture.h

8
src/Magnum/GL/PixelFormat.h

@ -27,7 +27,7 @@
*/ */
/** @file /** @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 <Corrade/Utility/Assert.h> #include <Corrade/Utility/Assert.h>
@ -2169,7 +2169,8 @@ Expects that @p format is not one of the generic
@relativeref{CompressedPixelFormat,RGBA} formats for which properties are @relativeref{CompressedPixelFormat,RGBA} formats for which properties are
unspecified. For 2D formats the Z dimension is always 1. unspecified. For 2D formats the Z dimension is always 1.
@see @ref compressedPixelFormatBlockDataSize(), @see @ref compressedPixelFormatBlockDataSize(),
@ref Magnum::compressedPixelFormatBlockSize(), @ref pixelFormatSize() @ref Magnum::compressedPixelFormatBlockSize(),
@ref Texture::compressedBlockSize(), @ref pixelFormatSize()
*/ */
MAGNUM_GL_EXPORT Vector3i compressedPixelFormatBlockSize(CompressedPixelFormat format); 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 @relativeref{CompressedPixelFormat,RGBA} formats for which properties are
unspecified. unspecified.
@see @ref compressedPixelFormatBlockSize(), @see @ref compressedPixelFormatBlockSize(),
@ref Magnum::compressedPixelFormatBlockDataSize(), @ref pixelFormatSize() @ref Magnum::compressedPixelFormatBlockDataSize(),
@ref Texture::compressedBlockDataSize(), @ref pixelFormatSize()
*/ */
MAGNUM_GL_EXPORT UnsignedInt compressedPixelFormatBlockDataSize(CompressedPixelFormat format); MAGNUM_GL_EXPORT UnsignedInt compressedPixelFormatBlockDataSize(CompressedPixelFormat format);

8
src/Magnum/GL/Texture.h

@ -134,7 +134,9 @@ Texture: public AbstractTexture {
* pixels). For uncompressed formats returns zero vector. * pixels). For uncompressed formats returns zero vector.
* @see @ref compressedBlockDataSize(), @fn_gl_keyword{GetInternalformat} * @see @ref compressedBlockDataSize(), @fn_gl_keyword{GetInternalformat}
* with @def_gl_keyword{TEXTURE_COMPRESSED_BLOCK_WIDTH}, * 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_gl43 Extension @gl_extension{ARB,internalformat_query2}
* @requires_gl Compressed texture queries are not available in OpenGL * @requires_gl Compressed texture queries are not available in OpenGL
* ES. * ES.
@ -149,7 +151,9 @@ Texture: public AbstractTexture {
* If @p format is compressed, returns compressed block data size (in * If @p format is compressed, returns compressed block data size (in
* bytes). For uncompressed formats returns zero. * bytes). For uncompressed formats returns zero.
* @see @ref compressedBlockSize(), @fn_gl_keyword{GetInternalformat} * @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_gl43 Extension @gl_extension{ARB,internalformat_query2}
* @requires_gl Compressed texture queries are not available in OpenGL * @requires_gl Compressed texture queries are not available in OpenGL
* ES. * ES.

Loading…
Cancel
Save