ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Doc++ 

I have no idea what I was doing here. Insufficient focus again.
pull/187/head^2
Vladimír Vondruš 10 years ago
parent
5c7b1a0eb2
commit
90b005cfa3
2 changed files with 23 additions and 15 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 19
      src/Magnum/Mesh.h
  2. 19
      src/Magnum/MeshView.h

19
src/Magnum/Mesh.h
Unescape View File

@ -603,7 +603,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
* If the mesh is indexed, the value is treated as index count,
* otherwise the value is vertex count. If set to `0`, no draw commands
* are issued when calling @ref draw(AbstractShaderProgram&). Ignored
* when calling @ref draw(AbstractShaderProgram, TransformFeedback&, UsingnedInt).
* when calling @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* Default is `0`.
* @see @ref isIndexed(), @ref setBaseVertex(), @ref setInstanceCount()
*/
@ -621,7 +621,8 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
*
* Sets number of vertices of which the vertex buffer will be offset
* when drawing. Ignored when calling
* @ref draw(AbstractShaderProgram, TransformFeedback&) Default is `0`.
* @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* Default is `0`.
* @see @ref setCount(), @ref setBaseInstance()
* @requires_gl32 Extension @extension{ARB,draw_elements_base_vertex}
* for indexed meshes
@ -642,14 +643,15 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
*
* If set to `1`, non-instanced draw commands are issued when calling
* @ref draw(AbstractShaderProgram&) or
* @ref draw(AbstractShaderProgram&, TransformFeedback&). If set to
* `0`, no draw commands are issued altogether. Default is `1`.
* @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* If set to `0`, no draw commands are issued altogether. Default is
* `1`.
* @see @ref setBaseInstance(), @ref setCount(),
* @ref addVertexBufferInstanced()
* @requires_gl31 Extension @extension{ARB,draw_instanced} if using
* @ref draw(AbstractShaderProgram&)
* @requires_gl42 Extension @extension{ARB,transform_feedback_instanced}
* @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt)
* if using @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt)
* @requires_gles30 Extension @es_extension{ANGLE,instanced_arrays},
* @es_extension2{EXT,draw_instanced,draw_instanced} or
* @es_extension{NV,draw_instanced} in OpenGL ES 2.0.
@ -669,7 +671,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
* @brief Set base instance
* @return Reference to self (for method chaining)
*
* Ignored when calling @ref draw(AbstractShaderProgram, TransformFeedback&, UnsignedInt).
* Ignored when calling @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* Default is `0`.
* @see @ref setInstanceCount(), @ref setBaseVertex()
* @requires_gl42 Extension @extension{ARB,base_instance}
@ -848,6 +850,7 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
* WebGL 1.0 is available, the associated vertex array object is bound
* instead of setting up the mesh from scratch.
* @see @ref setCount(), @ref setInstanceCount(),
* @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt),
* @ref MeshView::draw(AbstractShaderProgram&),
* @ref MeshView::draw(AbstractShaderProgram&, std::initializer_list<std::reference_wrapper<MeshView>>),
* @fn_gl{UseProgram}, @fn_gl{EnableVertexAttribArray},
@ -894,8 +897,8 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
* command is used. If @extension{ARB,vertex_array_object} (part of
* OpenGL 3.0) is available, the associated vertex array object is
* bound instead of setting up the mesh from scratch.
* @see @ref setInstanceCount(),
* @ref MeshView::draw(AbstractShaderProgram, TransformFeedback& xfb, UnsignedInt),
* @see @ref setInstanceCount(), @ref draw(AbstractShaderProgram&),
* @ref MeshView::draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt),
* @fn_gl{UseProgram}, @fn_gl{EnableVertexAttribArray},
* @fn_gl{BindBuffer}, @fn_gl{VertexAttribPointer},
* @fn_gl{DisableVertexAttribArray} or @fn_gl{BindVertexArray},

19
src/Magnum/MeshView.h
Unescape View File

@ -116,7 +116,7 @@ class MAGNUM_EXPORT MeshView {
* @brief Set vertex/index count
* @return Reference to self (for method chaining)
*
* Ignored when calling @ref draw(AbstractShaderProgram, TransformFeedback&, UnsignedInt).
* Ignored when calling @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* Default is `0`.
*/
MeshView& setCount(Int count) {
@ -132,7 +132,7 @@ class MAGNUM_EXPORT MeshView {
* @return Reference to self (for method chaining)
*
* Sets number of vertices of which the vertex buffer will be offset
* when drawing. Ignored when calling @ref draw(AbstractShaderProgram, TransformFeedback&, UnsignedInt).
* when drawing. Ignored when calling @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* Default is `0`.
* @requires_gl32 Extension @extension{ARB,draw_elements_base_vertex}
* for indexed meshes
@ -156,7 +156,7 @@ class MAGNUM_EXPORT MeshView {
* acccessed. On OpenGL ES 2.0 this function behaves the same as
* @ref setIndexRange(Int), as index range functionality is not
* available there. Ignored when calling
* @ref draw(AbstractShaderProgram, TransformFeedback&, UnsignedInt).
* @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* @see @ref setCount()
*/
/* MinGW/MSVC needs inline also here to avoid linkage conflicts */
@ -169,7 +169,7 @@ class MAGNUM_EXPORT MeshView {
*
* Prefer to use @ref setIndexRange(Int, UnsignedInt, UnsignedInt) for
* better performance. Ignored when calling
* @ref draw(AbstractShaderProgram, TransformFeedback&, UnsignedInt).
* @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* @see @ref setCount()
*/
MeshView& setIndexRange(Int first);
@ -182,7 +182,10 @@ class MAGNUM_EXPORT MeshView {
* @return Reference to self (for method chaining)
*
* Default is `1`.
* @requires_gl31 Extension @extension{ARB,draw_instanced}
* @requires_gl31 Extension @extension{ARB,draw_instanced} if using
* @ref draw(AbstractShaderProgram&)
* @requires_gl42 Extension @extension{ARB,transform_feedback_instanced}
* if using @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt)
* @requires_gles30 Extension @es_extension{ANGLE,instanced_arrays},
* @es_extension2{EXT,draw_instanced,draw_instanced} or
* @es_extension{NV,draw_instanced} in OpenGL ES 2.0.
@ -202,7 +205,7 @@ class MAGNUM_EXPORT MeshView {
* @brief Set base instance
* @return Reference to self (for method chaining)
*
* Ignored when calling @ref draw(AbstractShaderProgram, TransformFeedback&, UnsignedInt).
* Ignored when calling @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt).
* Default is `0`.
* @requires_gl42 Extension @extension{ARB,base_instance}
* @requires_gl Base instance cannot be specified in OpenGL ES or
@ -218,7 +221,8 @@ class MAGNUM_EXPORT MeshView {
* @brief Draw the mesh
*
* See @ref Mesh::draw(AbstractShaderProgram&) for more information.
* @see @ref draw(AbstractShaderProgram&, std::initializer_list<std::reference_wrapper<MeshView>>)
* @see @ref draw(AbstractShaderProgram&, std::initializer_list<std::reference_wrapper<MeshView>>),
* @ref draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt)
* @requires_gl32 Extension @extension{ARB,draw_elements_base_vertex}
* if the mesh is indexed and @ref baseVertex() is not `0`.
* @requires_gl33 Extension @extension{ARB,instanced_arrays} if
@ -247,6 +251,7 @@ class MAGNUM_EXPORT MeshView {
* taken from the @p xfb object. See
* @ref Mesh::draw(AbstractShaderProgram&, TransformFeedback&, UnsignedInt)
* for more information.
* @see @ref draw(AbstractShaderProgram&)
* @requires_gl40 Extension @extension{ARB,transform_feedback2}
* @requires_gl40 Extension @extension{ARB,transform_feedback3} if
* @p stream is not `0`

Write Preview
Loading…
Cancel
Save