Browse Source

Doc++

Forgot to run Doxygen after a475c92d99.
pull/582/merge
Vladimír Vondruš 4 years ago
parent
commit
f0cbb8d3c1
  1. 2
      doc/changelog.dox
  2. 2
      doc/opengl-mapping.dox
  3. 4
      src/Magnum/GL/AbstractShaderProgram.h
  4. 8
      src/Magnum/GL/MeshView.h
  5. 4
      src/Magnum/Shaders/DistanceFieldVectorGL.h
  6. 4
      src/Magnum/Shaders/FlatGL.h
  7. 8
      src/Magnum/Shaders/MeshVisualizerGL.h
  8. 4
      src/Magnum/Shaders/PhongGL.h
  9. 4
      src/Magnum/Shaders/VectorGL.h
  10. 4
      src/Magnum/Shaders/VertexColorGL.h
  11. 8
      src/Magnum/Trade/MaterialData.h

2
doc/changelog.dox

@ -123,7 +123,7 @@ See also:
[mosra/magnum#576](https://github.com/mosra/magnum/pull/576))
- Recognizing ANGLE GLES and WebGL base vertex, base instance and multi-draw
extensions and using them in @ref GL::AbstractShaderProgram::draw(Mesh&)
and @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>):
and @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&):
- @gl_extension{EXT,draw_elements_base_vertex}
- @gl_extension{OES,draw_elements_base_vertex}
- @m_class{m-doc-external} [ANGLE_multi_draw](https://chromium.googlesource.com/angle/angle/+/master/extensions/ANGLE_multi_draw.txt)

2
doc/opengl-mapping.dox

@ -293,7 +293,7 @@ OpenGL function | Matching API
@fn_gl_extension{MaxShaderCompilerThreads,KHR,parallel_shader_compile} | |
@fn_gl{MemoryBarrier}, \n `glMemoryBarrierByRegion()` | @ref GL::Renderer::setMemoryBarrier(), \n @ref GL::Renderer::setMemoryBarrierByRegion()
@fn_gl{MinSampleShading} | @ref GL::Renderer::setMinSampleShading()
@fn_gl{MultiDrawArrays}, \n @fn_gl{MultiDrawElements}, \n @fn_gl{MultiDrawElementsBaseVertex} | @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
@fn_gl{MultiDrawArrays}, \n @fn_gl{MultiDrawElements}, \n @fn_gl{MultiDrawElementsBaseVertex} | @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
@fn_gl{MultiDrawArraysIndirectCount}, \n @fn_gl{MultiDrawElementsIndirectCount} | |
@subsection opengl-mapping-functions-o O

4
src/Magnum/GL/AbstractShaderProgram.h

@ -850,7 +850,7 @@ class MAGNUM_GL_EXPORT AbstractShaderProgram: public AbstractObject {
* instead of setting up the mesh from scratch.
* @see @ref Mesh::setCount(), @ref Mesh::setInstanceCount(),
* @ref draw(MeshView&),
* @ref draw(Containers::ArrayView<const Containers::Reference<MeshView>>),
* @ref draw(const Containers::Iterable<MeshView>&),
* @ref drawTransformFeedback(),
* @fn_gl_keyword{UseProgram}, @fn_gl_keyword{EnableVertexAttribArray},
* @fn_gl{BindBuffer}, @fn_gl_keyword{VertexAttribPointer},
@ -895,7 +895,7 @@ class MAGNUM_GL_EXPORT AbstractShaderProgram: public AbstractObject {
* @m_since{2020,06}
*
* See @ref draw(Mesh&) for more information.
* @see @ref draw(Containers::ArrayView<const Containers::Reference<MeshView>>),
* @see @ref draw(const Containers::Iterable<MeshView>&),
* @ref drawTransformFeedback()
* @requires_gl32 Extension @gl_extension{ARB,draw_elements_base_vertex}
* if the mesh is indexed and @ref MeshView::baseVertex() is not

8
src/Magnum/GL/MeshView.h

@ -63,7 +63,7 @@ class MAGNUM_GL_EXPORT MeshView {
/**
* @brief Draw multiple meshes at once
* @m_deprecated_since{2020,06} Use
* @ref AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* instead.
*/
CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram& shader, Containers::ArrayView<const Containers::Reference<MeshView>> meshes);
@ -71,7 +71,7 @@ class MAGNUM_GL_EXPORT MeshView {
/**
* @overload
* @m_deprecated_since{2020,06} Use
* @ref AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* instead.
*/
CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram&& shader, Containers::ArrayView<const Containers::Reference<MeshView>> meshes);
@ -79,7 +79,7 @@ class MAGNUM_GL_EXPORT MeshView {
/**
* @overload
* @m_deprecated_since{2020,06} Use
* @ref AbstractShaderProgram::draw(std::initializer_list<Containers::Reference<MeshView>>)
* @ref AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* instead.
*/
CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram& shader, std::initializer_list<Containers::Reference<MeshView>> meshes);
@ -87,7 +87,7 @@ class MAGNUM_GL_EXPORT MeshView {
/**
* @overload
* @m_deprecated_since{2020,06} Use
* @ref AbstractShaderProgram::draw(std::initializer_list<Containers::Reference<MeshView>>)
* @ref AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* instead.
*/
CORRADE_DEPRECATED("use AbstractShaderProgram::draw() instead") static void draw(AbstractShaderProgram&& shader, std::initializer_list<Containers::Reference<MeshView>> meshes);

4
src/Magnum/Shaders/DistanceFieldVectorGL.h

@ -184,7 +184,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
* Enable multidraw functionality. Implies @ref Flag::UniformBuffers
* and adds the value from @ref setDrawOffset() with the
* @glsl gl_DrawID @ce builtin, which makes draws submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up per-draw parameters directly, without having to rebind
* the uniform buffers or specify @ref setDrawOffset() before each
* draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is
@ -498,7 +498,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
*
* If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this
* value, which makes each draw submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up its own per-draw parameters.
* @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object}
* @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0.

4
src/Magnum/Shaders/FlatGL.h

@ -490,7 +490,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
* Enable multidraw functionality. Implies @ref Flag::UniformBuffers
* and adds the value from @ref setDrawOffset() with the
* @glsl gl_DrawID @ce builtin, which makes draws submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up per-draw parameters directly, without having to rebind
* the uniform buffers or specify @ref setDrawOffset() before each
* draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is
@ -841,7 +841,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
*
* If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this
* value, which makes each draw submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up its own per-draw parameters.
* @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object}
* @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0.

8
src/Magnum/Shaders/MeshVisualizerGL.h

@ -410,7 +410,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua
* Enable multidraw functionality. Implies @ref Flag::UniformBuffers
* and combines the value from @ref setDrawOffset() with the
* @glsl gl_DrawID @ce builtin, which makes draws submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up per-draw parameters directly, without having to rebind
* the uniform buffers or specify @ref setDrawOffset() before each
* draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is
@ -753,7 +753,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua
*
* If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this
* value, which makes each draw submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up its own per-draw parameters.
* @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object}
* @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0.
@ -1603,7 +1603,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
* Enable multidraw functionality. Implies @ref Flag::UniformBuffers
* and combines the value from @ref setDrawOffset() with the
* @glsl gl_DrawID @ce builtin, which makes draws submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up per-draw parameters directly, without having to rebind
* the uniform buffers or specify @ref setDrawOffset() before each
* draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is
@ -2160,7 +2160,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
*
* If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this
* value, which makes each draw submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up its own per-draw parameters.
* @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object}
* @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0.

4
src/Magnum/Shaders/PhongGL.h

@ -679,7 +679,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram {
* Enable multidraw functionality. Implies @ref Flag::UniformBuffers
* and adds the value from @ref setDrawOffset() with the
* @glsl gl_DrawID @ce builtin, which makes draws submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up per-draw parameters directly, without having to rebind
* the uniform buffers or specify @ref setDrawOffset() before each
* draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is
@ -1409,7 +1409,7 @@ class MAGNUM_SHADERS_EXPORT PhongGL: public GL::AbstractShaderProgram {
*
* If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this
* value, which makes each draw submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up its own per-draw parameters.
* @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object}
* @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0.

4
src/Magnum/Shaders/VectorGL.h

@ -179,7 +179,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public GL
* Enable multidraw functionality. Implies @ref Flag::UniformBuffers
* and adds the value from @ref setDrawOffset() with the
* @glsl gl_DrawID @ce builtin, which makes draws submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up per-draw parameters directly, without having to rebind
* the uniform buffers or specify @ref setDrawOffset() before each
* draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is
@ -454,7 +454,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public GL
*
* If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this
* value, which makes each draw submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up its own per-draw parameters.
* @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object}
* @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0.

4
src/Magnum/Shaders/VertexColorGL.h

@ -174,7 +174,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VertexColorGL: publ
* Enable multidraw functionality. Implies @ref Flag::UniformBuffers
* and adds the value from @ref setDrawOffset() with the
* @glsl gl_DrawID @ce builtin, which makes draws submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up per-draw parameters directly, without having to rebind
* the uniform buffers or specify @ref setDrawOffset() before each
* draw. In a non-multidraw scenario, @glsl gl_DrawID @ce is
@ -384,7 +384,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VertexColorGL: publ
*
* If @ref Flag::MultiDraw is set, @glsl gl_DrawID @ce is added to this
* value, which makes each draw submitted via
* @ref GL::AbstractShaderProgram::draw(Containers::ArrayView<const Containers::Reference<MeshView>>)
* @ref GL::AbstractShaderProgram::draw(const Containers::Iterable<MeshView>&)
* pick up its own per-draw parameters.
* @requires_gl31 Extension @gl_extension{ARB,uniform_buffer_object}
* @requires_gles30 Uniform buffers are not available in OpenGL ES 2.0.

8
src/Magnum/Trade/MaterialData.h

@ -2242,10 +2242,10 @@ class MAGNUM_TRADE_EXPORT MaterialData {
* @brief Offset of a layer inside attribute data
*
* Returns the offset where attributes for @p layer start in the array
* returned by @ref atttributeData() const. The @p layer is expected
* to be less *or equal to* @ref layerCount(), i.e. it's always
* possible to call this function with @cpp layer @ce and
* @cpp layer + 1 @ce to get the attribute range for given layer.
* returned by @ref attributeData() const. The @p layer is expected to
* be less *or equal to* @ref layerCount(), i.e. it's always possible
* to call this function with @cpp layer @ce and @cpp layer + 1 @ce to
* get the attribute range for given layer.
*/
UnsignedInt attributeDataOffset(UnsignedInt layer) const;

Loading…
Cancel
Save