From f904e483b3accb24d601611aa90cfbbfaed1f724 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 27 Nov 2022 18:20:13 +0100 Subject: [PATCH] Shaders: fix doc titles for bind*Buffer() APIs. Those were originally named set*Buffer(), but in the process of finishing up ef9da0ec96274a43eea966e1232101f440b2ae62 got changed to bind*Buffer() to avoid a false impression that the buffer stays bound to the shader instance forever (which it doesn't, same as with textures). However the documentation didn't get updated, apparently. --- src/Magnum/Shaders/DistanceFieldVectorGL.h | 8 ++++---- src/Magnum/Shaders/FlatGL.h | 10 +++++----- src/Magnum/Shaders/MeshVisualizerGL.h | 16 ++++++++-------- src/Magnum/Shaders/PhongGL.h | 12 ++++++------ src/Magnum/Shaders/VectorGL.h | 8 ++++---- src/Magnum/Shaders/VertexColorGL.h | 4 ++-- 6 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/Magnum/Shaders/DistanceFieldVectorGL.h b/src/Magnum/Shaders/DistanceFieldVectorGL.h index 711501f55..1f53aec2b 100644 --- a/src/Magnum/Shaders/DistanceFieldVectorGL.h +++ b/src/Magnum/Shaders/DistanceFieldVectorGL.h @@ -505,7 +505,7 @@ template class MAGNUM_SHADERS_EXPORT DistanceFieldVector DistanceFieldVectorGL& setDrawOffset(UnsignedInt offset); /** - * @brief Set a transformation and projection uniform buffer + * @brief Bind a transformation and projection uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -526,7 +526,7 @@ template class MAGNUM_SHADERS_EXPORT DistanceFieldVector DistanceFieldVectorGL& bindTransformationProjectionBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a draw uniform buffer + * @brief Bind a draw uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -547,7 +547,7 @@ template class MAGNUM_SHADERS_EXPORT DistanceFieldVector DistanceFieldVectorGL& bindDrawBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a texture transformation uniform buffer + * @brief Bind a texture transformation uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -567,7 +567,7 @@ template class MAGNUM_SHADERS_EXPORT DistanceFieldVector DistanceFieldVectorGL& bindTextureTransformationBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a material uniform buffer + * @brief Bind a material uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * diff --git a/src/Magnum/Shaders/FlatGL.h b/src/Magnum/Shaders/FlatGL.h index d5a02b35b..380c3456d 100644 --- a/src/Magnum/Shaders/FlatGL.h +++ b/src/Magnum/Shaders/FlatGL.h @@ -827,7 +827,7 @@ template class MAGNUM_SHADERS_EXPORT FlatGL: public GL:: */ /** - * @brief Set a draw offset + * @brief Bind a draw offset * @return Reference to self (for method chaining) * @m_since_latest * @@ -852,7 +852,7 @@ template class MAGNUM_SHADERS_EXPORT FlatGL: public GL:: FlatGL& setDrawOffset(UnsignedInt offset); /** - * @brief Set a transformation and projection uniform buffer + * @brief Bind a transformation and projection uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -873,7 +873,7 @@ template class MAGNUM_SHADERS_EXPORT FlatGL: public GL:: FlatGL& bindTransformationProjectionBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a draw uniform buffer + * @brief Bind a draw uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -894,7 +894,7 @@ template class MAGNUM_SHADERS_EXPORT FlatGL: public GL:: FlatGL& bindDrawBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a texture transformation uniform buffer + * @brief Bind a texture transformation uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -914,7 +914,7 @@ template class MAGNUM_SHADERS_EXPORT FlatGL: public GL:: FlatGL& bindTextureTransformationBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a material uniform buffer + * @brief Bind a material uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * diff --git a/src/Magnum/Shaders/MeshVisualizerGL.h b/src/Magnum/Shaders/MeshVisualizerGL.h index efae80101..cc5fc6d26 100644 --- a/src/Magnum/Shaders/MeshVisualizerGL.h +++ b/src/Magnum/Shaders/MeshVisualizerGL.h @@ -751,7 +751,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua } /** - * @brief Set a transformation and projection uniform buffer + * @brief Bind a transformation and projection uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -771,7 +771,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua MeshVisualizerGL2D& bindTransformationProjectionBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a draw uniform buffer + * @brief Bind a draw uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -801,7 +801,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua } /** - * @brief Set a material uniform buffer + * @brief Bind a material uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -2229,7 +2229,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua } /** - * @brief Set a projection uniform buffer + * @brief Bind a projection uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -2250,7 +2250,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua MeshVisualizerGL3D& bindProjectionBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a transformation uniform buffer + * @brief Bind a transformation uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -2270,7 +2270,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua MeshVisualizerGL3D& bindTransformationBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a draw uniform buffer + * @brief Bind a draw uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -2291,7 +2291,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua MeshVisualizerGL3D& bindDrawBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a texture transformation uniform buffer for an object ID texture + * @brief Bind a texture transformation uniform buffer for an object ID texture * @return Reference to self (for method chaining) * @m_since_latest * @@ -2319,7 +2319,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua } /** - * @brief Set a material uniform buffer + * @brief Bind a material uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * diff --git a/src/Magnum/Shaders/PhongGL.h b/src/Magnum/Shaders/PhongGL.h index 4724d3a6b..aa643d4d6 100644 --- a/src/Magnum/Shaders/PhongGL.h +++ b/src/Magnum/Shaders/PhongGL.h @@ -1424,7 +1424,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { PhongGL& setDrawOffset(UnsignedInt offset); /** - * @brief Set a projection uniform buffer + * @brief Bind a projection uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -1445,7 +1445,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { PhongGL& bindProjectionBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a transformation uniform buffer + * @brief Bind a transformation uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -1466,7 +1466,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { PhongGL& bindTransformationBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a draw uniform buffer + * @brief Bind a draw uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -1487,7 +1487,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { PhongGL& bindDrawBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a texture transformation uniform buffer + * @brief Bind a texture transformation uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -1507,7 +1507,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { PhongGL& bindTextureTransformationBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a material uniform buffer + * @brief Bind a material uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -1528,7 +1528,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram { PhongGL& bindMaterialBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a light uniform buffer + * @brief Bind a light uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * diff --git a/src/Magnum/Shaders/VectorGL.h b/src/Magnum/Shaders/VectorGL.h index f62fd4e89..b886896b8 100644 --- a/src/Magnum/Shaders/VectorGL.h +++ b/src/Magnum/Shaders/VectorGL.h @@ -463,7 +463,7 @@ template class MAGNUM_SHADERS_EXPORT VectorGL: public GL VectorGL& setDrawOffset(UnsignedInt offset); /** - * @brief Set a transformation and projection uniform buffer + * @brief Bind a transformation and projection uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -484,7 +484,7 @@ template class MAGNUM_SHADERS_EXPORT VectorGL: public GL VectorGL& bindTransformationProjectionBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a draw uniform buffer + * @brief Bind a draw uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -505,7 +505,7 @@ template class MAGNUM_SHADERS_EXPORT VectorGL: public GL VectorGL& bindDrawBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a texture transformation uniform buffer + * @brief Bind a texture transformation uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * @@ -525,7 +525,7 @@ template class MAGNUM_SHADERS_EXPORT VectorGL: public GL VectorGL& bindTextureTransformationBuffer(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size); /** - * @brief Set a material uniform buffer + * @brief Bind a material uniform buffer * @return Reference to self (for method chaining) * @m_since_latest * diff --git a/src/Magnum/Shaders/VertexColorGL.h b/src/Magnum/Shaders/VertexColorGL.h index 5049c7d81..9aa7c3fd8 100644 --- a/src/Magnum/Shaders/VertexColorGL.h +++ b/src/Magnum/Shaders/VertexColorGL.h @@ -374,7 +374,7 @@ template class MAGNUM_SHADERS_EXPORT VertexColorGL: publ */ /** - * @brief Set a draw offset + * @brief Bind a draw offset * @return Reference to self (for method chaining) * @m_since_latest * @@ -397,7 +397,7 @@ template class MAGNUM_SHADERS_EXPORT VertexColorGL: publ VertexColorGL& setDrawOffset(UnsignedInt offset); /** - * @brief Set a transformation and projection uniform buffer + * @brief Bind a transformation and projection uniform buffer * @return Reference to self (for method chaining) * @m_since_latest *