diff --git a/src/Magnum/GL/CubeMapTexture.h b/src/Magnum/GL/CubeMapTexture.h index 326d37489..0a643402e 100644 --- a/src/Magnum/GL/CubeMapTexture.h +++ b/src/Magnum/GL/CubeMapTexture.h @@ -539,7 +539,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { #ifndef MAGNUM_TARGET_GLES /** - * @brief Read given mip level of texture to image + * @brief Read given texture mip level to an image * * Image parameters like format and type of pixel data are taken from * given image, image size is taken from the texture using @@ -566,7 +566,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { Image3D image(Int level, Image3D&& image); /** - * @brief Read given mip level of texture to buffer image + * @brief Read given texture mip level to a buffer image * * See @ref image(Int, Image3D&) for more information. The storage is * not reallocated if it is large enough to contain the new data, which @@ -587,7 +587,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { BufferImage3D image(Int level, BufferImage3D&& image, BufferUsage usage); /** - * @brief Read given mip level of compressed texture to image + * @brief Read given mip level of a compressed texture to an image * * Compression format and data size are taken from the texture, image * size is taken using @ref imageSize(). The storage is not reallocated @@ -615,7 +615,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { CompressedImage3D compressedImage(Int level, CompressedImage3D&& image); /** - * @brief Read given mip level of compressed texture to buffer image + * @brief Read given compressed texture mip level to a buffer image * * See @ref compressedImage(Int, CompressedImage3D&) for more * information. The storage is not reallocated if it is large enough to @@ -638,7 +638,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { CompressedBufferImage3D compressedImage(Int level, CompressedBufferImage3D&& image, BufferUsage usage); /** - * @brief Read given mip level and coordinate of texture to image + * @brief Read given texture mip level and coordinate to an image * * Image parameters like format and type of pixel data are taken from * given image, image size is taken from the texture using @@ -672,7 +672,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { Image2D image(CubeMapCoordinate coordinate, Int level, Image2D&& image); /** - * @brief Read given mip level and coordinate of texture to buffer image + * @brief Read given texture mip level and coordinate to a buffer image * * See @ref image(CubeMapCoordinate, Int, Image2D&) for more * information. The storage is not reallocated if it is large enough to @@ -692,7 +692,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { BufferImage2D image(CubeMapCoordinate coordinate, Int level, BufferImage2D&& image, BufferUsage usage); /** - * @brief Read given mip level and coordinate of compressed texture to image + * @brief Read given compressed texture mip level and coordinate to an image * * Compression format and data size are taken from the texture, image * size is taken using @ref imageSize(). The storage is not reallocated @@ -728,7 +728,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { CompressedImage2D compressedImage(CubeMapCoordinate coordinate, Int level, CompressedImage2D&& image); /** - * @brief Read given mip level and coordinate of compressed texture to buffer image + * @brief Read given compressed texture mip level and coordinate to a buffer image * * See @ref compressedImage(CubeMapCoordinate, Int, CompressedImage2D&) * for more information. The storage is not reallocated if it is large @@ -751,7 +751,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { CompressedBufferImage2D compressedImage(CubeMapCoordinate coordinate, Int level, CompressedBufferImage2D&& image, BufferUsage usage); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, Image&) + * @brief Read a range of given texture mip level to an image * * See @ref Texture::subImage(Int, const RangeTypeFor&, Image&) * for more information. @@ -773,7 +773,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { Image3D subImage(Int level, const Range3Di& range, Image3D&& image); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) + * @brief Read a range of given texture mip level to a buffer image * * See @ref Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) * for more information. @@ -795,7 +795,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { BufferImage3D subImage(Int level, const Range3Di& range, BufferImage3D&& image, BufferUsage usage); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) + * @brief Read a range of given compressed texture mip level to an image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) * for more information. @@ -821,7 +821,7 @@ class MAGNUM_GL_EXPORT CubeMapTexture: public AbstractTexture { CompressedImage3D compressedSubImage(Int level, const Range3Di& range, CompressedImage3D&& image); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) + * @brief Read a range of given compressed texture mip level to a buffer image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) * for more information. diff --git a/src/Magnum/GL/CubeMapTextureArray.h b/src/Magnum/GL/CubeMapTextureArray.h index a8e9f272b..33769e82f 100644 --- a/src/Magnum/GL/CubeMapTextureArray.h +++ b/src/Magnum/GL/CubeMapTextureArray.h @@ -466,7 +466,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { #ifndef MAGNUM_TARGET_GLES /** - * @brief @copybrief Texture::image(Int, Image&) + * @brief Read given texture mip level to an image * * See @ref Texture::image(Int, Image&) for more information. * @requires_gl Texture image queries are not available in OpenGL ES. @@ -486,7 +486,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { Image3D image(Int level, Image3D&& image); /** - * @brief @copybrief Texture::image(Int, BufferImage&, BufferUsage) + * @brief Read given texture mip level to a buffer image * * See @ref Texture::image(Int, BufferImage&, BufferUsage) for more * information. @@ -507,7 +507,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { BufferImage3D image(Int level, BufferImage3D&& image, BufferUsage usage); /** - * @brief @copybrief Texture::compressedImage(Int, CompressedImage&) + * @brief Read given compressed texture mip level to an image * * See @ref Texture::compressedImage(Int, CompressedImage&) for more * information. @@ -530,7 +530,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { CompressedImage3D compressedImage(Int level, CompressedImage3D&& image); /** - * @brief @copybrief Texture::compressedImage(Int, CompressedBufferImage&, BufferUsage) + * @brief Read given compressed texture mip level to a buffer image * * See @ref Texture::compressedImage(Int, CompressedBufferImage&, BufferUsage) * for more information. @@ -553,7 +553,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { CompressedBufferImage3D compressedImage(Int level, CompressedBufferImage3D&& image, BufferUsage usage); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, Image&) + * @brief Read a range of given texture mip level to an image * * See @ref Texture::subImage(Int, const RangeTypeFor&, Image&) * for more information. @@ -575,7 +575,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { Image3D subImage(Int level, const Range3Di& range, Image3D&& image); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) + * @brief Read a range of given texture mip level to a buffer image * * See @ref Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) * for more information. @@ -597,7 +597,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { BufferImage3D subImage(Int level, const Range3Di& range, BufferImage3D&& image, BufferUsage usage); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) + * @brief Read a range of given compressed texture mip level to an image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) * for more information. @@ -625,7 +625,7 @@ class MAGNUM_GL_EXPORT CubeMapTextureArray: public AbstractTexture { CompressedImage3D compressedSubImage(Int level, const Range3Di& range, CompressedImage3D&& image); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) + * @brief Read a range of given compressed texture mip level to a buffer image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) * for more information. diff --git a/src/Magnum/GL/RectangleTexture.h b/src/Magnum/GL/RectangleTexture.h index 231ef1d7d..e8149a624 100644 --- a/src/Magnum/GL/RectangleTexture.h +++ b/src/Magnum/GL/RectangleTexture.h @@ -353,7 +353,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { Vector2i imageSize() { return DataHelper<2>::imageSize(*this, 0); } /** - * @brief Read texture to image + * @brief Read texture to an image * * See @ref Texture::image(Int, Image&) for more information. */ @@ -370,7 +370,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { Image2D image(Image2D&& image); /** - * @brief Read texture to buffer image + * @brief Read texture to a buffer image * * See @ref Texture::image(Int, BufferImage&, BufferUsage) for more * information. @@ -388,7 +388,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { BufferImage2D image(BufferImage2D&& image, BufferUsage usage); /** - * @brief Read compressed texture to image + * @brief Read compressed texture to an image * * See @ref Texture::compressedImage(Int, CompressedImage&) for more * information. @@ -408,7 +408,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { CompressedImage2D compressedImage(CompressedImage2D&& image); /** - * @brief Read compressed texture to buffer image + * @brief Read compressed texture to a buffer image * * See @ref Texture::compressedImage(Int, CompressedBufferImage&, BufferUsage) * for more information. @@ -428,7 +428,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { CompressedBufferImage2D compressedImage(CompressedBufferImage2D&& image, BufferUsage usage); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, Image&) + * @brief Read a texture range to an image * * See @ref Texture::subImage(Int, const RangeTypeFor&, Image&) * for more information. @@ -447,7 +447,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { Image2D subImage(const Range2Di& range, Image2D&& image); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) + * @brief Read a texture range to a buffer image * * See @ref Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) * for more information. @@ -466,7 +466,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { BufferImage2D subImage(const Range2Di& range, BufferImage2D&& image, BufferUsage usage); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) + * @brief Read a compressed texture range to an image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) * for more information. @@ -491,7 +491,7 @@ class MAGNUM_GL_EXPORT RectangleTexture: public AbstractTexture { CompressedImage2D compressedSubImage(const Range2Di& range, CompressedImage2D&& image); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) + * @brief Read a compressed texture range to a buffer image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) * for more information. diff --git a/src/Magnum/GL/Texture.h b/src/Magnum/GL/Texture.h index a69266290..5f165f4c7 100644 --- a/src/Magnum/GL/Texture.h +++ b/src/Magnum/GL/Texture.h @@ -748,7 +748,7 @@ template class Texture: public AbstractTexture { #ifndef MAGNUM_TARGET_GLES /** - * @brief Read given mip level of texture to image + * @brief Read given texture mip level to an image * @param level Mip level * @param image Image where to put the data * @@ -786,7 +786,7 @@ template class Texture: public AbstractTexture { Image image(Int level, Image&& image); /** - * @brief Read given mip level of texture to buffer image + * @brief Read given texture mip level to a buffer image * @param level Mip level * @param image Buffer image where to put the data * @param usage Buffer usage @@ -813,7 +813,7 @@ template class Texture: public AbstractTexture { BufferImage image(Int level, BufferImage&& image, BufferUsage usage); /** - * @brief Read given mip level of compressed texture to image + * @brief Read given compressed texture mip level to an image * @param level Mip level * @param image Image where to put the compressed data * @@ -854,7 +854,7 @@ template class Texture: public AbstractTexture { CompressedImage compressedImage(Int level, CompressedImage&& image); /** - * @brief Read given mip level of compressed texture to buffer image + * @brief Read given compressed texture mip level to a buffer image * @param level Mip level * @param image Buffer image where to put the compressed data * @param usage Buffer usage @@ -883,7 +883,7 @@ template class Texture: public AbstractTexture { CompressedBufferImage compressedImage(Int level, CompressedBufferImage&& image, BufferUsage usage); /** - * @brief Read range of given texture mip level to image + * @brief Read a range of given texture mip level to an image * @param level Mip level * @param range Range to read * @param image Image where to put the data @@ -911,7 +911,7 @@ template class Texture: public AbstractTexture { Image subImage(Int level, const RangeTypeFor& range, Image&& image); /** - * @brief Read range of given texture mip level to buffer image + * @brief Read a range of given texture mip level to a buffer image * @param level Mip level * @param range Range to read * @param image Buffer image where to put the data @@ -938,7 +938,7 @@ template class Texture: public AbstractTexture { BufferImage subImage(Int level, const RangeTypeFor& range, BufferImage&& image, BufferUsage usage); /** - * @brief Read range of given compressed texture mip level to image + * @brief Read a range of given compressed texture mip level to an image * @param level Mip level * @param range Range to read * @param image Image where to put the compressed data @@ -975,7 +975,7 @@ template class Texture: public AbstractTexture { CompressedImage compressedSubImage(Int level, const RangeTypeFor& range, CompressedImage&& image); /** - * @brief Read range of given compressed texture mip level to buffer image + * @brief Read a range of given compressed texture mip level to a buffer image * @param level Mip level * @param range Range to read * @param image Buffer image where to put the compressed data diff --git a/src/Magnum/GL/TextureArray.h b/src/Magnum/GL/TextureArray.h index 4a778853d..faa48b7be 100644 --- a/src/Magnum/GL/TextureArray.h +++ b/src/Magnum/GL/TextureArray.h @@ -503,7 +503,7 @@ template class TextureArray: public AbstractTexture { #ifndef MAGNUM_TARGET_GLES /** - * @brief @copybrief Texture::image(Int, Image&) + * @brief Read given texture mip level to an image * * See @ref Texture::image(Int, Image&) for more information. * @requires_gl Texture image queries are not available in OpenGL ES or @@ -523,7 +523,7 @@ template class TextureArray: public AbstractTexture { Image image(Int level, Image&& image); /** - * @brief @copybrief Texture::image(Int, BufferImage&, BufferUsage) + * @brief Read given texture mip level to a buffer image * * See @ref Texture::image(Int, BufferImage&, BufferUsage) for more * information. @@ -544,7 +544,7 @@ template class TextureArray: public AbstractTexture { BufferImage image(Int level, BufferImage&& image, BufferUsage usage); /** - * @brief @copybrief Texture::compressedImage(Int, CompressedImage&) + * @brief Read given compressed texture mip level to an image * * See @ref Texture::compressedImage(Int, CompressedImage&) for more * information. @@ -567,7 +567,7 @@ template class TextureArray: public AbstractTexture { CompressedImage compressedImage(Int level, CompressedImage&& image); /** - * @brief @copybrief Texture::compressedImage(Int, CompressedBufferImage&, BufferUsage) + * @brief Read given compressed texture mip level to a buffer image * * See @ref Texture::compressedImage(Int, CompressedBufferImage&, BufferUsage) * for more information. @@ -590,7 +590,7 @@ template class TextureArray: public AbstractTexture { CompressedBufferImage compressedImage(Int level, CompressedBufferImage&& image, BufferUsage usage); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, Image&) + * @brief Read a range of given texture mip level to an image * * See @ref Texture::subImage(Int, const RangeTypeFor&, Image&) * for more information. @@ -612,7 +612,7 @@ template class TextureArray: public AbstractTexture { Image subImage(Int level, const RangeTypeFor& range, Image&& image); /** - * @brief @copybrief Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) + * @brief Read a range of given texture mip level to a buffer image * * See @ref Texture::subImage(Int, const RangeTypeFor&, BufferImage&, BufferUsage) * for more information. @@ -634,7 +634,7 @@ template class TextureArray: public AbstractTexture { BufferImage subImage(Int level, const RangeTypeFor& range, BufferImage&& image, BufferUsage usage); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) + * @brief Read a range of given compressed texture mip level to an image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedImage&) * for more information. @@ -662,7 +662,7 @@ template class TextureArray: public AbstractTexture { CompressedImage compressedSubImage(Int level, const RangeTypeFor& range, CompressedImage&& image); /** - * @brief @copybrief Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) + * @brief Read a range of given compressed texture mip level to a buffer image * * See @ref Texture::compressedSubImage(Int, const RangeTypeFor&, CompressedBufferImage&, BufferUsage) * for more information.