Browse Source

Doc++

pull/650/head
Vladimír Vondruš 2 years ago
parent
commit
9b4fd3f45b
  1. 8
      src/Magnum/PixelFormat.h
  2. 3
      src/Magnum/Test/PixelFormatTest.cpp
  3. 5
      src/Magnum/Text/GlyphCacheGL.h

8
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 <Corrade/Utility/Assert.h>
@ -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)
*/

3
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));

5
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});

Loading…
Cancel
Save