From c33bf5fba78d5f099cb8927fcc369ff9e76c7d3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 14 Dec 2022 14:57:55 +0100 Subject: [PATCH] Shaders: document also that some Configuration getters are not on ES2. For consistency, because the same getters on the shader class itself contain this info. --- src/Magnum/Shaders/DistanceFieldVectorGL.h | 14 +++++++++-- src/Magnum/Shaders/FlatGL.h | 14 +++++++++-- src/Magnum/Shaders/MeshVisualizerGL.h | 28 ++++++++++++++++++---- src/Magnum/Shaders/PhongGL.h | 14 +++++++++-- src/Magnum/Shaders/VectorGL.h | 14 +++++++++-- src/Magnum/Shaders/VertexColorGL.h | 7 +++++- 6 files changed, 78 insertions(+), 13 deletions(-) diff --git a/src/Magnum/Shaders/DistanceFieldVectorGL.h b/src/Magnum/Shaders/DistanceFieldVectorGL.h index 1f53aec2b..56ef04d3d 100644 --- a/src/Magnum/Shaders/DistanceFieldVectorGL.h +++ b/src/Magnum/Shaders/DistanceFieldVectorGL.h @@ -661,7 +661,12 @@ template class DistanceFieldVectorGL::Config } #ifndef MAGNUM_TARGET_GLES2 - /** @brief Material count */ + /** + * @brief Material count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt materialCount() const { return _materialCount; } /** @@ -686,7 +691,12 @@ template class DistanceFieldVectorGL::Config return *this; } - /** @brief Draw count */ + /** + * @brief Draw count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt drawCount() const { return _drawCount; } /** diff --git a/src/Magnum/Shaders/FlatGL.h b/src/Magnum/Shaders/FlatGL.h index 380c3456d..0d949d98e 100644 --- a/src/Magnum/Shaders/FlatGL.h +++ b/src/Magnum/Shaders/FlatGL.h @@ -1075,7 +1075,12 @@ template class FlatGL::Configuration { } #ifndef MAGNUM_TARGET_GLES2 - /** @brief Material count */ + /** + * @brief Material count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt materialCount() const { return _materialCount; } /** @@ -1099,7 +1104,12 @@ template class FlatGL::Configuration { return *this; } - /** @brief Draw count */ + /** + * @brief Draw count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt drawCount() const { return _drawCount; } /** diff --git a/src/Magnum/Shaders/MeshVisualizerGL.h b/src/Magnum/Shaders/MeshVisualizerGL.h index cc5fc6d26..233ba0a4c 100644 --- a/src/Magnum/Shaders/MeshVisualizerGL.h +++ b/src/Magnum/Shaders/MeshVisualizerGL.h @@ -894,7 +894,12 @@ class MeshVisualizerGL2D::Configuration { } #ifndef MAGNUM_TARGET_GLES2 - /** @brief Material count */ + /** + * @brief Material count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt materialCount() const { return _materialCount; } /** @@ -919,7 +924,12 @@ class MeshVisualizerGL2D::Configuration { return *this; } - /** @brief Draw count */ + /** + * @brief Draw count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt drawCount() const { return _drawCount; } /** @@ -2473,7 +2483,12 @@ class MeshVisualizerGL3D::Configuration { } #ifndef MAGNUM_TARGET_GLES2 - /** @brief Material count */ + /** + * @brief Material count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt materialCount() const { return _materialCount; } /** @@ -2498,7 +2513,12 @@ class MeshVisualizerGL3D::Configuration { return *this; } - /** @brief Draw count */ + /** + * @brief Draw count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt drawCount() const { return _drawCount; } /** diff --git a/src/Magnum/Shaders/PhongGL.h b/src/Magnum/Shaders/PhongGL.h index aa643d4d6..484033d6a 100644 --- a/src/Magnum/Shaders/PhongGL.h +++ b/src/Magnum/Shaders/PhongGL.h @@ -1855,7 +1855,12 @@ class PhongGL::Configuration { } #ifndef MAGNUM_TARGET_GLES2 - /** @brief Material count */ + /** + * @brief Material count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt materialCount() const { return _materialCount; } /** @@ -1879,7 +1884,12 @@ class PhongGL::Configuration { return *this; } - /** @brief Draw count */ + /** + * @brief Draw count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt drawCount() const { return _drawCount; } /** diff --git a/src/Magnum/Shaders/VectorGL.h b/src/Magnum/Shaders/VectorGL.h index b886896b8..57ab78fbf 100644 --- a/src/Magnum/Shaders/VectorGL.h +++ b/src/Magnum/Shaders/VectorGL.h @@ -613,7 +613,12 @@ template class VectorGL::Configuration { } #ifndef MAGNUM_TARGET_GLES2 - /** @brief Material count */ + /** + * @brief Material count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt materialCount() const { return _materialCount; } /** @@ -637,7 +642,12 @@ template class VectorGL::Configuration { return *this; } - /** @brief Draw count */ + /** + * @brief Draw count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt drawCount() const { return _drawCount; } /** diff --git a/src/Magnum/Shaders/VertexColorGL.h b/src/Magnum/Shaders/VertexColorGL.h index 9aa7c3fd8..7c063edeb 100644 --- a/src/Magnum/Shaders/VertexColorGL.h +++ b/src/Magnum/Shaders/VertexColorGL.h @@ -466,7 +466,12 @@ template class VertexColorGL::Configuration } #ifndef MAGNUM_TARGET_GLES2 - /** @brief Draw count */ + /** + * @brief Draw count + * + * @requires_gles30 Not defined on OpenGL ES 2.0 builds. + * @requires_webgl20 Not defined on WebGL 1.0 builds. + */ UnsignedInt drawCount() const { return _drawCount; } /**