From 2a574012183881672b1d4e6ac0703bf990a673e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 7 Jan 2020 23:44:13 +0100 Subject: [PATCH] Trade: doc++ --- src/Magnum/Trade/ImageData.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/Magnum/Trade/ImageData.h b/src/Magnum/Trade/ImageData.h index 5e421e704..a59fb1d56 100644 --- a/src/Magnum/Trade/ImageData.h +++ b/src/Magnum/Trade/ImageData.h @@ -388,9 +388,12 @@ template class ImageData { * @m_since{2019,10} * * Provides direct and easy-to-use access to image pixels. Expects that - * the image is not compressed. See @ref Image-pixel-views for more - * information. - * @see @ref isCompressed() + * the image is not compressed. The last dimension represents the + * actual data type (its size is equal to type size) and is guaranteed + * to be contiguous. Use the templated overload below to get pixels in + * a concrete type. See @ref Image-pixel-views for more information. + * @see @ref isCompressed(), + * @ref Corrade::Containers::StridedArrayView::isContiguous() */ Containers::StridedArrayView pixels(); Containers::StridedArrayView pixels() const; /**< @overload */