Browse Source

doc: clarify what's all in the MagnumMath single header lib.

pull/168/head
Vladimír Vondruš 3 years ago
parent
commit
23b6db341e
  1. 13
      doc/namespaces.dox

13
doc/namespaces.dox

@ -100,9 +100,11 @@ more information.
[MagnumMath.hpp](https://github.com/mosra/magnum-singles/tree/master/MagnumMath.hpp) [MagnumMath.hpp](https://github.com/mosra/magnum-singles/tree/master/MagnumMath.hpp)
library in the Magnum Singles repository for easier integration into your library in the Magnum Singles repository for easier integration into your
projects. See @ref singles for more information. Everything except contents projects. See @ref singles for more information. Everything except contents
of the @ref Magnum/Math/FunctionsBatch.h and @ref Magnum/Math/Algorithms/Svd.h of the @ref Magnum/Math/ColorBatch.h, @ref Magnum/Math/FunctionsBatch.h,
headers is included. The library has a separate non-inline implementation @ref Magnum/Math/PackingBatch.h and @ref Magnum/Math/Algorithms/Svd.h
part, enable it *just once* like this: headers and the @ref Magnum::Math::StrictWeakOrdering helper is included.
The library has a separate non-inline implementation part, enable it
* *just once* like this:
@par @par
@code{.cpp} @code{.cpp}
#define MAGNUM_MATH_IMPLEMENTATION #define MAGNUM_MATH_IMPLEMENTATION
@ -111,8 +113,9 @@ more information.
@par @par
If you need the deinlined symbols to be exported from a shared library, If you need the deinlined symbols to be exported from a shared library,
@cpp #define MAGNUM_EXPORT @ce as appropriate. In addition, contents of the @cpp #define MAGNUM_EXPORT @ce as appropriate. In addition, contents of the
@ref GlmIntegration and @ref EigenIntegration libraries are included as @ref GlmIntegration and @ref EigenIntegration libraries except for the
well --- opt-in by specifying either @ref Magnum/EigenIntegration/DynamicMatrixIntegration.h header are included
as well --- opt-in by specifying either
@cpp #define MAGNUM_MATH_GLM_INTEGRATION @ce or @cpp #define MAGNUM_MATH_GLM_INTEGRATION @ce or
@cpp #define MAGNUM_MATH_EIGEN_INTEGRATION @ce before including the file. @cpp #define MAGNUM_MATH_EIGEN_INTEGRATION @ce before including the file.
Including it multiple times with different macros defined works as well. Including it multiple times with different macros defined works as well.

Loading…
Cancel
Save