From 7a0d178116f34e051e818df0ef6a05a88a0fe203 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Sun, 26 Jan 2025 00:21:45 +0100
Subject: [PATCH] GL: unify BufferImage extension documentation with other
 places.

The wording of the ARB_compressed_texture_pixel_storage requirement is
slightly different in Texture and such, likely due to being updated there
but not here.
---
 src/Magnum/GL/BufferImage.h | 28 +++++++++++++++-------------
 1 file changed, 15 insertions(+), 13 deletions(-)

diff --git a/src/Magnum/GL/BufferImage.h b/src/Magnum/GL/BufferImage.h
index de0dc9684..a0e23ecb7 100644
--- a/src/Magnum/GL/BufferImage.h
+++ b/src/Magnum/GL/BufferImage.h
@@ -455,9 +455,9 @@ template<UnsignedInt dimensions> class CompressedBufferImage {
          * @param usage             Image buffer usage
          *
          * @requires_gl42 Extension @gl_extension{ARB,compressed_texture_pixel_storage}
-         *      for non-default compressed pixel storage
-         * @requires_gl Compressed pixel storage is hardcoded in OpenGL ES and
-         *      WebGL.
+         *      for non-default @ref CompressedPixelStorage
+         * @requires_gl Non-default @ref CompressedPixelStorage is not
+         *      available in OpenGL ES and WebGL.
          */
         explicit CompressedBufferImage(CompressedPixelStorage storage, CompressedPixelFormat format, const VectorTypeFor<dimensions, Int>& size, Containers::ArrayView<const void> data, BufferUsage usage);
 
@@ -510,9 +510,9 @@ template<UnsignedInt dimensions> class CompressedBufferImage {
          * If @p dataSize is @cpp 0 @ce, the buffer is unconditionally
          * reallocated on the first call to @ref setData().
          * @requires_gl42 Extension @gl_extension{ARB,compressed_texture_pixel_storage}
-         *      for non-default compressed pixel storage
-         * @requires_gl Compressed pixel storage is hardcoded in OpenGL ES and
-         *      WebGL.
+         *      for non-default @ref CompressedPixelStorage
+         * @requires_gl Non-default @ref CompressedPixelStorage is not
+         *      available in OpenGL ES and WebGL.
          */
         explicit CompressedBufferImage(CompressedPixelStorage storage, CompressedPixelFormat format, const VectorTypeFor<dimensions, Int>& size, Buffer&& buffer, std::size_t dataSize) noexcept;
 
@@ -561,9 +561,9 @@ template<UnsignedInt dimensions> class CompressedBufferImage {
          * Format is undefined, size is zero and buffer is empty, call
          * @ref setData() to fill the image with data.
          * @requires_gl42 Extension @gl_extension{ARB,compressed_texture_pixel_storage}
-         *      for non-default compressed pixel storage
-         * @requires_gl Compressed pixel storage is hardcoded in OpenGL ES and
-         *      WebGL.
+         *      for non-default @ref CompressedPixelStorage
+         * @requires_gl Non-default @ref CompressedPixelStorage is not
+         *      available in OpenGL ES and WebGL.
          */
         /*implicit*/ CompressedBufferImage(CompressedPixelStorage storage);
 
@@ -617,8 +617,9 @@ template<UnsignedInt dimensions> class CompressedBufferImage {
          * See @ref CompressedPixelStorage::dataProperties() for more
          * information.
          * @requires_gl42 Extension @gl_extension{ARB,compressed_texture_pixel_storage}
-         * @requires_gl Compressed pixel storage is hardcoded in OpenGL ES and
-         *      WebGL.
+         *      for non-default @ref CompressedPixelStorage
+         * @requires_gl Non-default @ref CompressedPixelStorage is not
+         *      available in OpenGL ES and WebGL.
          */
         std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>> dataProperties() const;
 
@@ -645,8 +646,9 @@ template<UnsignedInt dimensions> class CompressedBufferImage {
          * that current data size is large enough for the new parameters.
          * @see @ref Buffer::setData()
          * @requires_gl42 Extension @gl_extension{ARB,compressed_texture_pixel_storage}
-         * @requires_gl Compressed pixel storage is hardcoded in OpenGL ES and
-         *      WebGL.
+         *      for non-default @ref CompressedPixelStorage
+         * @requires_gl Non-default @ref CompressedPixelStorage is not
+         *      available in OpenGL ES and WebGL.
          */
         void setData(CompressedPixelStorage storage, CompressedPixelFormat format, const VectorTypeFor<dimensions, Int>& size, Containers::ArrayView<const void> data, BufferUsage usage);