From c0ce10882fcf7b6cc05dcbe65d5fb9c076dabc22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 11 Jan 2017 17:34:06 +0100 Subject: [PATCH] Fix misleading documentation of PixelStorage::dataProperties(). --- src/Magnum/PixelStorage.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Magnum/PixelStorage.h b/src/Magnum/PixelStorage.h index 2b60ed62e..2ee203f24 100644 --- a/src/Magnum/PixelStorage.h +++ b/src/Magnum/PixelStorage.h @@ -214,8 +214,8 @@ class MAGNUM_EXPORT PixelStorage { * Returns byte offset in each direction, (row length, row count, layer * count) and pixel size for image of given @p size with current pixel * storage parameters, @p format and @p type. The offset reflects the - * @ref skip() parameter. Adding byte offset and product of the vector - * gives minimal byte count to store given data. + * @ref skip() parameter. Sum of the byte offset vector gives the + * byte offset of first pixel in the data array. * @see @ref pixelSize() */ std::tuple, Math::Vector3, std::size_t> dataProperties(PixelFormat format, PixelType type, const Vector3i& size) const;