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

Doxygen. Doxygen IS BROKEN BEYOND REPAIR. 

I introduced *strong* enum with values, in a subnamespace, that have the
same name as completely unrelated typedefs. Guess what?! It breaks ALL
LINKS TO THOSE TYPEDEFS! **EVERYWHERE!!!**
pull/191/head
Vladimír Vondruš 8 years ago
parent
0109e0d7fe
commit
c26075427b
9 changed files with 71 additions and 46 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. 47
      src/Magnum/GL/AbstractShaderProgram.h
  2. 21
      src/Magnum/GL/Attribute.h
  3. 3
      src/Magnum/Math/Range.h
  4. 8
      src/Magnum/Shaders/AbstractVector.h
  5. 10
      src/Magnum/Shaders/Flat.h
  6. 7
      src/Magnum/Shaders/Generic.h
  7. 3
      src/Magnum/Shaders/MeshVisualizer.h
  8. 13
      src/Magnum/Shaders/Phong.h
  9. 5
      src/Magnum/Shaders/VertexColor.h

47
src/Magnum/GL/AbstractShaderProgram.h
Unescape View File

@ -363,30 +363,41 @@ used (and their super- or subclasses with the same size and underlying type).
See also @ref Attribute::DataType enum for additional type options.
@requires_gl30 Extension @gl_extension{EXT,gpu_shader4} is required when using
integer attributes (i.e. @ref UnsignedInt, @ref Int, @ref Vector2ui,
@ref Vector2i, @ref Vector3ui, @ref Vector3i, @ref Vector4ui and
@ref Vector4i) or unsigned integer uniforms (i.e. @ref UnsignedInt,
@ref Vector2ui, @ref Vector3ui and @ref Vector4ui).
integer attributes (i.e. @ref Magnum::UnsignedInt "UnsignedInt",
@ref Magnum::Int "Int", @ref Magnum::Vector2ui "Vector2ui",
@ref Magnum::Vector2i "Vector2i", @ref Magnum::Vector3ui "Vector3ui",
@ref Magnum::Vector3i "Vector3i", @ref Magnum::Vector4ui "Vector4ui" and
@ref Magnum::Vector4i "Vector4i") or unsigned integer uniforms (i.e.
@ref Magnum::UnsignedInt "UnsignedInt", @ref Magnum::Vector2ui "Vector2ui",
@ref Magnum::Vector3ui "Vector3ui" and @ref Magnum::Vector4ui "Vector4ui").
@requires_gl40 Extension @gl_extension{ARB,gpu_shader_fp64} is required when
using double uniforms (i.e. @ref Magnum::Double "Double", @ref Vector2d,
@ref Vector3d, @ref Vector4d, @ref Matrix2x2d, @ref Matrix3x3d,
@ref Matrix4x4d, @ref Matrix2x3d, @ref Matrix3x2d, @ref Matrix2x4d,
@ref Matrix4x2d, @ref Matrix3x4d and @ref Matrix4x3d).
using double uniforms (i.e. @ref Magnum::Double "Double",
@ref Magnum::Vector2d "Vector2d", @ref Magnum::Vector3d "Vector3d",
@ref Magnum::Vector4d "Vector4d", @ref Magnum::Matrix2x2d "Matrix2x2d",
@ref Magnum::Matrix3x3d "Matrix3x3d", @ref Magnum::Matrix4x4d "Matrix4x4d",
@ref Magnum::Matrix2x3d "Matrix2x3d", @ref Magnum::Matrix3x2d "Matrix3x2d",
@ref Magnum::Matrix2x4d "Matrix2x4d", @ref Magnum::Matrix4x2d "Matrix4x2d",
@ref Magnum::Matrix3x4d "Matrix3x4d" and @ref Magnum::Matrix4x3d "Matrix4x3d").
@requires_gl41 Extension @gl_extension{ARB,vertex_attrib_64bit} is required when
using double attributes (i.e. @ref Magnum::Double "Double", @ref Vector2d,
@ref Vector3d, @ref Vector4d, @ref Matrix2x2d, @ref Matrix3x3d,
@ref Matrix4x4d, @ref Matrix2x3d, @ref Matrix3x2d, @ref Matrix2x4d,
@ref Matrix4x2d, @ref Matrix3x4d and @ref Matrix4x3d).
using double attributes (i.e. @ref Magnum::Double "Double",
@ref Magnum::Vector2d "Vector2d", @ref Magnum::Vector3d "Vector3d",
@ref Magnum::Vector4d "Vector4d", @ref Magnum::Matrix2x2d "Matrix2x2d",
@ref Magnum::Matrix3x3d "Matrix3x3d", @ref Magnum::Matrix4x4d "Matrix4x4d",
@ref Magnum::Matrix2x3d "Matrix2x3d", @ref Magnum::Matrix3x2d "Matrix3x2d",
@ref Magnum::Matrix2x4d "Matrix2x4d", @ref Magnum::Matrix4x2d "Matrix4x2d",
@ref Magnum::Matrix3x4d "Matrix3x4d" and @ref Magnum::Matrix4x3d "Matrix4x3d").
@requires_gles30 Integer attributes, unsigned integer uniforms and non-square
matrix attributes and uniforms (i.e. @ref Matrix2x3, @ref Matrix3x2,
@ref Matrix2x4, @ref Matrix4x2, @ref Matrix3x4 and @ref Matrix4x3) are not
available in OpenGL ES 2.0.
matrix attributes and uniforms (i.e. @ref Magnum::Matrix2x3 "Matrix2x3",
@ref Magnum::Matrix3x2 "Matrix3x2", @ref Magnum::Matrix2x4 "Matrix2x4",
@ref Magnum::Matrix4x2 "Matrix4x2", @ref Magnum::Matrix3x4 "Matrix3x4" and
@ref Magnum::Matrix4x3 "Matrix4x3") are not available in OpenGL ES 2.0.
@requires_gl Double attributes and uniforms are not available in OpenGL ES or
WebGL.
@requires_webgl20 Integer attributes, unsigned integer uniforms and non-square
matrix attributes and uniforms (i.e. @ref Matrix2x3, @ref Matrix3x2,
@ref Matrix2x4, @ref Matrix4x2, @ref Matrix3x4 and @ref Matrix4x3) are not
available in WebGL 1.0.
matrix attributes and uniforms (i.e. @ref Magnum::Matrix2x3 "Matrix2x3",
@ref Magnum::Matrix3x2 "Matrix3x2", @ref Magnum::Matrix2x4 "Matrix2x4",
@ref Magnum::Matrix4x2 "Matrix4x2", @ref Magnum::Matrix3x4 "Matrix3x4" and
@ref Magnum::Matrix4x3 "Matrix4x3") are not available in WebGL 1.0.
@section GL-AbstractShaderProgram-performance-optimization Performance optimizations

21
src/Magnum/GL/Attribute.h
Unescape View File

@ -48,12 +48,13 @@ is vertex attribute location, number between @cpp 0 @ce and
should always have vertex attribute with location @cpp 0 @ce.
Template parameter @p T is the type which is used for shader attribute, e.g.
@ref Vector4i for @glsl ivec4 @ce. DataType is type of passed data when adding
vertex buffers to mesh. By default it is the same as type used in shader (e.g.
@ref DataType::Int for @ref Vector4i). It's also possible to pass integer data
to floating-point shader inputs. In this case you may want to normalize the
values (e.g. color components from @cpp 0 @ce -- @cpp 255 @ce to @cpp 0.0f @ce
-- @cpp 1.0f @ce) --- see @ref DataOption::Normalized.
@ref Magnum::Vector4i "Vector4i" for @glsl ivec4 @ce. DataType is type of
passed data when adding vertex buffers to mesh. By default it is the same as
type used in shader (e.g. @ref DataType::Int for @ref Magnum::Vector4i "Vector4i").
It's also possible to pass integer data to floating-point shader inputs. In
this case you may want to normalize the values (e.g. color components from
@cpp 0 @ce -- @cpp 255 @ce to @cpp 0.0f @ce -- @cpp 1.0f @ce) --- see
@ref DataOption::Normalized.
Only some types are allowed as attribute types, see @ref GL-AbstractShaderProgram-types
for more information.
@ -265,7 +266,8 @@ template<UnsignedInt location, class T> class Attribute {
* @brief Constructor
* @param components Component count
* @param dataType Type of passed data. Default is the same as
* type used in shader (e.g. @ref DataType::Int for @ref Vector4i).
* type used in shader (e.g. @ref DataType::Int for
* @ref Magnum::Vector4i "Vector4i").
* @param dataOptions Data options. Default is no options.
*/
constexpr Attribute(Components components, DataType dataType = Implementation::Attribute<T>::DefaultDataType, DataOptions dataOptions = DataOptions()): _components(components), _dataType(dataType), _dataOptions(dataOptions) {}
@ -273,11 +275,12 @@ template<UnsignedInt location, class T> class Attribute {
/**
* @brief Constructor
* @param dataType Type of passed data. Default is the same as
* type used in shader (e.g. @ref DataType::Int for @ref Vector4i).
* type used in shader (e.g. @ref DataType::Int for
* @ref Magnum::Vector4i "Vector4i").
* @param dataOptions Data options. Default is no options.
*
* Component count is set to the same value as in type used in shader
* (e.g. @ref Components::Three for @ref Vector3).
* (e.g. @ref Components::Three for @ref Magnum::Vector3 "Vector3").
*/
constexpr Attribute(DataType dataType = Implementation::Attribute<T>::DefaultDataType, DataOptions dataOptions = DataOptions()): _components(Implementation::Attribute<T>::DefaultComponents), _dataType(dataType), _dataOptions(dataOptions) {}

3
src/Magnum/Math/Range.h
Unescape View File

@ -58,7 +58,8 @@ template<UnsignedInt dimensions, class T> class Range {
/**
* @brief Underlying vector type
*
* `T` in 1D, @ref Vector2<T> in 2D, @ref Vector3<T> in 3D.
* `T` in 1D, @ref Math::Vector2 "Vector2<T>" in 2D,
* @ref Math::Vector3 "Vector3<T>" in 3D.
*/
typedef typename Implementation::RangeTraits<dimensions, T>::Type VectorType;

8
src/Magnum/Shaders/AbstractVector.h
Unescape View File

@ -45,15 +45,17 @@ template<UnsignedInt dimensions> class AbstractVector: public GL::AbstractShader
/**
* @brief Vertex position
*
* @ref shaders-generic "Generic attribute", @ref Vector2 in 2D,
* @ref Vector3 in 3D.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector2 "Vector2" in 2D, @ref Magnum::Vector3 "Vector3"
* in 3D.
*/
typedef typename Generic<dimensions>::Position Position;
/**
* @brief 2D texture coordinates
*
* @ref shaders-generic "Generic attribute", @ref Vector2.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector2 "Vector2".
*/
typedef typename Generic<dimensions>::TextureCoordinates TextureCoordinates;

10
src/Magnum/Shaders/Flat.h
Unescape View File

@ -90,16 +90,18 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT Flat: public GL::Ab
/**
* @brief Vertex position
*
* @ref shaders-generic "Generic attribute", @ref Vector2 in 2D,
* @ref Vector3 in 3D.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector2 "Vector2" in 2D, @ref Magnum::Vector3 "Vector3"
* in 3D.
*/
typedef typename Generic<dimensions>::Position Position;
/**
* @brief 2D texture coordinates
*
* @ref shaders-generic "Generic attribute", @ref Vector2. Used only if
* @ref Flag::Textured is set.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector2 "Vector2". Used only if @ref Flag::Textured is
* set.
*/
typedef typename Generic<dimensions>::TextureCoordinates TextureCoordinates;

7
src/Magnum/Shaders/Generic.h
Unescape View File

@ -49,21 +49,22 @@ template<UnsignedInt dimensions> struct Generic {
/**
* @brief Vertex position
*
* @ref Vector2 in 2D and @ref Vector3 in 3D.
* @ref Magnum::Vector2 "Vector2" in 2D and @ref Magnum::Vector3 "Vector3"
* in 3D.
*/
typedef GL::Attribute<0, T> Position;
/**
* @brief 2D texture coordinates
*
* @ref Vector2.
* @ref Magnum::Vector2 "Vector2".
*/
typedef GL::Attribute<1, Vector2> TextureCoordinates;
/**
* @brief Vertex normal
*
* @ref Vector3, defined only in 3D.
* @ref Magnum::Vector3 "Vector3", defined only in 3D.
*/
typedef GL::Attribute<2, Vector3> Normal;

3
src/Magnum/Shaders/MeshVisualizer.h
Unescape View File

@ -108,7 +108,8 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizer: public GL::AbstractShaderProgram {
/**
* @brief Vertex position
*
* @ref shaders-generic "Generic attribute", @ref Vector3.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector3 "Vector3".
*/
typedef GL::Attribute<0, Vector3> Position;

13
src/Magnum/Shaders/Phong.h
Unescape View File

@ -93,23 +93,26 @@ class MAGNUM_SHADERS_EXPORT Phong: public GL::AbstractShaderProgram {
/**
* @brief Vertex position
*
* @ref shaders-generic "Generic attribute", @ref Vector3.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector3 "Vector3".
*/
typedef Generic3D::Position Position;
/**
* @brief Normal direction
*
* @ref shaders-generic "Generic attribute", @ref Vector3.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector3 "Vector3".
*/
typedef Generic3D::Normal Normal;
/**
* @brief 2D texture coordinates
*
* @ref shaders-generic "Generic attribute", @ref Vector2, used only if
* at least one of @ref Flag::AmbientTexture, @ref Flag::DiffuseTexture
* and @ref Flag::SpecularTexture is set.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector2 "Vector2", used only if at least one of
* @ref Flag::AmbientTexture, @ref Flag::DiffuseTexture and
* @ref Flag::SpecularTexture is set.
*/
typedef Generic3D::TextureCoordinates TextureCoordinates;

5
src/Magnum/Shaders/VertexColor.h
Unescape View File

@ -66,8 +66,9 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VertexColor: public
/**
* @brief Vertex position
*
* @ref shaders-generic "Generic attribute", @ref Vector2 in 2D,
* @ref Vector3 in 3D.
* @ref shaders-generic "Generic attribute",
* @ref Magnum::Vector2 "Vector2" in 2D @ref Magnum::Vector3 "Vector3"
* in 3D.
*/
typedef typename Generic<dimensions>::Position Position;

Write Preview
Loading…
Cancel
Save