Browse Source

Doc++

pull/278/head
Vladimír Vondruš 13 years ago
parent
commit
5eb98494b3
  1. 38
      src/AbstractShaderProgram.h
  2. 2
      src/Physics/AxisAlignedBox.cpp
  3. 2
      src/Physics/Capsule.cpp
  4. 2
      src/Physics/ObjectShape.cpp
  5. 2
      src/Physics/ObjectShapeGroup.cpp
  6. 2
      src/Physics/Sphere.cpp
  7. 7
      src/Query.h

38
src/AbstractShaderProgram.h

@ -223,25 +223,39 @@ See @ref types for more information, only types with GLSL equivalent can be used
(and their super- or subclasses with the same size and underlying type).
@requires_gl30 %Extension @extension{EXT,gpu_shader4} is required when using
integer attributes (i.e. UnsignedInt, Int, Vector2ui, Vector2i, Vector3ui,
Vector3i, Vector4ui and Vector4i) or unsigned integer uniforms. (i.e.
UnsignedInt, Vector2ui, Vector3ui and 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_gles30 Integer attributes and unsigned integer uniforms are not
available in OpenGL ES 2.0.
@requires_gl40 %Extension @extension{ARB,gpu_shader_fp64} is required when
using double uniforms (i.e. Double, Vector2d, Vector3d, Vector4d, Matrix2d,
Matrix3d, Matrix4d, Matrix2x3d, Matrix3x2d, Matrix2x4d, Matrix4x2d,
Matrix3x4d and Matrix4x3d).
using double uniforms (i.e. @ref Magnum::Double "Double",
@ref Magnum::Vector2d "Vector2d", @ref Magnum::Vector3d "Vector3d",
@ref Magnum::Vector4d "Vector4d", @ref Magnum::Matrix2d "Matrix2d",
@ref Magnum::Matrix3d "Matrix3d", @ref Magnum::Matrix4d "Matrix4d",
@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 @extension{ARB,vertex_attrib_64bit} is required when
using double attributes (i.e. Double, Vector2d, Vector3d, Vector4d, Matrix2d,
Matrix3d, Matrix4d, Matrix2x3d, Matrix3x2d, Matrix2x4d, Matrix4x2d,
Matrix3x4d and Matrix4x3d).
using double attributes (i.e. @ref Magnum::Double "Double",
@ref Magnum::Vector2d "Vector2d", @ref Magnum::Vector3d "Vector3d",
@ref Magnum::Vector4d "Vector4d", @ref Magnum::Matrix2d "Matrix2d",
@ref Magnum::Matrix3d "Matrix3d", @ref Magnum::Matrix4d "Matrix4d",
@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_gl Double attributes and uniforms are not available in OpenGL ES.
@requires_gles30 Non-square matrix attributes and uniforms (i.e. Matrix2x3,
Matrix3x2, Matrix2x4, Matrix4x2, Matrix3x4 and Matrix4x3) are not available
in OpenGL ES 2.0.
@requires_gles30 Non-square matrix attributes and uniforms (i.e.
@ref Magnum::Matrix2x3 "Matrix2x3", @ref Magnum::Matrix3x2 "Matrix3x2",
@ref Magnum::Matrix2x4 "Matrix2x4", @ref Magnum::Matrix4x2d "Matrix4x2",
@ref Magnum::Matrix3x4 "Matrix3x4" and @ref Magnum::Matrix4x3 "Matrix4x3")
are not available in OpenGL ES 2.0.
@section AbstractShaderProgram-performance-optimization Performance optimizations

2
src/Physics/AxisAlignedBox.cpp

@ -38,7 +38,9 @@ template<UnsignedInt dimensions> bool AxisAlignedBox<dimensions>::operator%(cons
(other.transformedPosition() < _transformedMax).all();
}
#ifndef DOXYGEN_GENERATING_OUTPUT
template class MAGNUM_PHYSICS_EXPORT AxisAlignedBox<2>;
template class MAGNUM_PHYSICS_EXPORT AxisAlignedBox<3>;
#endif
}}

2
src/Physics/Capsule.cpp

@ -52,7 +52,9 @@ template<UnsignedInt dimensions> bool Capsule<dimensions>::operator%(const Spher
Math::pow<2>(transformedRadius()+other.transformedRadius());
}
#ifndef DOXYGEN_GENERATING_OUTPUT
template class MAGNUM_PHYSICS_EXPORT Capsule<2>;
template class MAGNUM_PHYSICS_EXPORT Capsule<3>;
#endif
}}

2
src/Physics/ObjectShape.cpp

@ -46,7 +46,9 @@ template<UnsignedInt dimensions> void ObjectShape<dimensions>::clean(const typen
if(_shape) _shape->applyTransformationMatrix(absoluteTransformationMatrix);
}
#ifndef DOXYGEN_GENERATING_OUTPUT
template class MAGNUM_PHYSICS_EXPORT ObjectShape<2>;
template class MAGNUM_PHYSICS_EXPORT ObjectShape<3>;
#endif
}}

2
src/Physics/ObjectShapeGroup.cpp

@ -45,7 +45,9 @@ template<UnsignedInt dimensions> ObjectShape<dimensions>* ObjectShapeGroup<dimen
return nullptr;
}
#ifndef DOXYGEN_GENERATING_OUTPUT
template class MAGNUM_PHYSICS_EXPORT ObjectShapeGroup<2>;
template class MAGNUM_PHYSICS_EXPORT ObjectShapeGroup<3>;
#endif
}}

2
src/Physics/Sphere.cpp

@ -77,7 +77,9 @@ template<UnsignedInt dimensions> bool Sphere<dimensions>::operator%(const Sphere
Math::pow<2>(transformedRadius()+other.transformedRadius());
}
#ifndef DOXYGEN_GENERATING_OUTPUT
template class MAGNUM_PHYSICS_EXPORT Sphere<2>;
template class MAGNUM_PHYSICS_EXPORT Sphere<3>;
#endif
}}

7
src/Query.h

@ -79,9 +79,10 @@ class MAGNUM_EXPORT AbstractQuery {
* See resultAvailable().
* @see @fn_gl{GetQueryObject} with @def_gl{QUERY_RESULT}
* @requires_gl33 %Extension @extension{ARB,timer_query} (result type
* UnsignedInt and Long)
* @requires_gl Result types Int, UnsignedLong and Long are not
* available in OpenGL ES.
* @ref Magnum::UnsignedInt "UnsignedInt" and @ref Magnum::Long
* "Long")
* @requires_gl Result types @ref Magnum::Int "Int", @ref Magnum::UnsignedLong "UnsignedLong"
* and @ref Magnum::Long "Long" are not available in OpenGL ES.
*/
template<class T> T result();

Loading…
Cancel
Save