From bcff7a0a7a3e34eb2f39a473dcd8af6b310db38e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 24 Jun 2022 11:26:58 +0200 Subject: [PATCH] GL: document why BufferImage doesn't have ImageFlags. The lack of support will especially make sense when ImageFlag2D::YUp and such get introduced. --- src/Magnum/GL/BufferImage.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/Magnum/GL/BufferImage.h b/src/Magnum/GL/BufferImage.h index 2d56146e0..bb139e0f1 100644 --- a/src/Magnum/GL/BufferImage.h +++ b/src/Magnum/GL/BufferImage.h @@ -82,6 +82,13 @@ format of image queries in graphics APIs: Similarly to @ref ImageView, this class supports extra storage parameters. See @ref ImageView-usage for more information. +Unlike @ref Image, @ref ImageView and @ref Trade::ImageData, this class doesn't +support setting @ref ImageFlags. In those, image flags are used mainly to +distinguish between various image layouts when interfacing with file formats +and external conversion libraries. The buffer image, however, usually acts as a +temporary storage for data transfer following OpenGL constraints, and as such +the annotations aren't as essential. + @see @ref BufferImage1D, @ref BufferImage2D, @ref BufferImage3D @requires_gles30 Pixel buffer objects are not available in OpenGL ES 2.0. @requires_webgl20 Pixel buffer objects are not available in WebGL 1.0. @@ -418,6 +425,14 @@ format of image queries in graphics APIs: Similarly to @ref CompressedImageView, this class supports extra storage parameters. See @ref CompressedImageView-usage for more information. +Unlike @ref CompressedImage, @ref CompressedImageView and +@ref Trade::ImageData, this class doesn't support setting @ref ImageFlags. In +those, image flags are used mainly to distinguish between various image +layouts when interfacing with file formats and external conversion libraries. +The buffer image, however, usually acts as a temporary storage for data +transfer following OpenGL constraints, and as such the annotations aren't as +essential. + @see @ref CompressedBufferImage1D, @ref CompressedBufferImage2D, @ref CompressedBufferImage3D @requires_gles30 Pixel buffer objects are not available in OpenGL ES 2.0.