Browse Source

Doc++

pull/7/head
Vladimír Vondruš 14 years ago
parent
commit
ad9a55a867
  1. 14
      src/Math/Constants.h
  2. 10
      src/Math/Functions.h
  3. 2
      src/MeshTools/CombineIndexedArrays.h

14
src/Math/Constants.h

@ -71,16 +71,16 @@ Usable for entering e.g. rotation:
Matrix4::rotation(deg(30.0f), Vector3::yAxis());
@endcode
This function (and also rad()) is available also in Magnum namespace itself.
@see Constants, rad()
*/
@see Magnum::deg(), Constants, rad()
*/
template<class T> inline constexpr T deg(T value) { return value*Constants<T>::pi()/180; }
/**
* @brief Angle in radians
*
* See deg() for more information.
*/
@brief Angle in radians
See deg() for more information.
@see Magnum::rad()
*/
template<class T> inline constexpr T rad(T value) { return value; }
}}

10
src/Math/Functions.h

@ -30,14 +30,6 @@
namespace Magnum { namespace Math {
/**
@todo Vector/scalar overloaded functions (...SIMD):
- min(), max() (component-wise)
- abs()
- sin(), cos()...
- clamp(), lerp()
*/
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Implementation {
template<std::uint32_t exponent> struct Pow {
@ -186,7 +178,7 @@ template<class FloatingPoint, class Integral> inline constexpr typename std::ena
@brief Denormalize floating-point value
Converts floating-point value in range @f$ [0, 1] @f$ to full range of given
unsigned integral type or range @f$ [-1, 1] @f$ to full range of given signed
*unsigned* integral type or range @f$ [-1, 1] @f$ to full range of given *signed*
integral type.
@note For best precision, `FloatingPoint` type should be always larger that

2
src/MeshTools/CombineIndexedArrays.h

@ -120,7 +120,7 @@ std::vector<std::uint32_t> indices = MeshTools::combineIndexedArrays(
`positions`, `normals` and `textureCoordinates` will then contain combined
attributes indexed with `indices`.
The function expects that all arrays have the same size.
@attention The function expects that all arrays have the same size.
*/
/* Implementation note: It's done using tuples because it is more clear which
parameter is index array and which is attribute array, mainly when both are

Loading…
Cancel
Save