Browse Source

Shaders: fix doc titles for bind*Buffer() APIs.

Those were originally named set*Buffer(), but in the process of
finishing up ef9da0ec96 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.
pull/499/head
Vladimír Vondruš 3 years ago
parent
commit
f904e483b3
  1. 8
      src/Magnum/Shaders/DistanceFieldVectorGL.h
  2. 10
      src/Magnum/Shaders/FlatGL.h
  3. 16
      src/Magnum/Shaders/MeshVisualizerGL.h
  4. 12
      src/Magnum/Shaders/PhongGL.h
  5. 8
      src/Magnum/Shaders/VectorGL.h
  6. 4
      src/Magnum/Shaders/VertexColorGL.h

8
src/Magnum/Shaders/DistanceFieldVectorGL.h

@ -505,7 +505,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
DistanceFieldVectorGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
DistanceFieldVectorGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
DistanceFieldVectorGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
DistanceFieldVectorGL<dimensions>& 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
*

10
src/Magnum/Shaders/FlatGL.h

@ -827,7 +827,7 @@ template<UnsignedInt dimensions> 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
FlatGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
FlatGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
FlatGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
FlatGL<dimensions>& 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
*

16
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
*

12
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
*

8
src/Magnum/Shaders/VectorGL.h

@ -463,7 +463,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public GL
VectorGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public GL
VectorGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public GL
VectorGL<dimensions>& 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public GL
VectorGL<dimensions>& 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
*

4
src/Magnum/Shaders/VertexColorGL.h

@ -374,7 +374,7 @@ template<UnsignedInt dimensions> 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<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VertexColorGL: publ
VertexColorGL<dimensions>& 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
*

Loading…
Cancel
Save