@ -31,8 +31,8 @@
Contains classes for interacting with OpenGL. Contains classes for interacting with OpenGL.
This library is built as part of % Magnum by default. To use it, you need to This library is built as part of Magnum by default. To use it, you need to
find `% Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link find `Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link
to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more
information. information.
*/ */
@ -46,9 +46,9 @@ information.
Base classes for creating applications with various toolkits. Base classes for creating applications with various toolkits.
Parts of this namespace are built if `WITH_*APPLICATION` is enabled when Parts of this namespace are built if `WITH_*APPLICATION` is enabled when
building % Magnum, with each library having specific toolkit dependencies and building Magnum, with each library having specific toolkit dependencies and
platform requirements. To use particular application library, you need to platform requirements. To use particular application library, you need to
request given `*Application` component of `% Magnum` package in CMake, add request given `*Application` component of `Magnum` package in CMake, add
`${MAGNUM_*APPLICATION_INCLUDE_DIRS}` to include path and link to `${MAGNUM_*APPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_*APPLICATION_LIBRARIES}`. See particular `*Application` class `${MAGNUM_*APPLICATION_LIBRARIES}`. See particular `*Application` class
documentation, @ref building, @ref cmake and @ref platform for more documentation, @ref building, @ref cmake and @ref platform for more
@ -59,12 +59,12 @@ information.
* @brief Namespace Magnum::Math * @brief Namespace Magnum::Math
*/ */
/** @namespace Magnum::Math /** @namespace Magnum::Math
@brief % Math library @brief Math library
Template classes for matrix and vector calculations. Template classes for matrix and vector calculations.
This library is built as part of % Magnum by default. To use it, you need to This library is built as part of Magnum by default. To use it, you need to
find `% Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link find `Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link
to `${MAGNUM_LIBRARIES}`. See @ref building, @ref cmake, @ref matrix-vector and to `${MAGNUM_LIBRARIES}`. See @ref building, @ref cmake, @ref matrix-vector and
@ref transformations for more information. @ref transformations for more information.
*/ */
@ -73,12 +73,12 @@ to `${MAGNUM_LIBRARIES}`. See @ref building, @ref cmake, @ref matrix-vector and
* @brief Namespace Magnum::Math::Algorithms * @brief Namespace Magnum::Math::Algorithms
*/ */
/** @namespace Magnum::Math::Algorithms /** @namespace Magnum::Math::Algorithms
@brief % Algorithms @brief Algorithms
Various matrix and vector algorithms. Various matrix and vector algorithms.
This library is built as part of % Magnum by default. To use it, you need to This library is built as part of Magnum by default. To use it, you need to
find `% Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link find `Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link
to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more
information. information.
*/ */
@ -87,12 +87,12 @@ information.
* @brief Namespace Magnum::Math::Geometry * @brief Namespace Magnum::Math::Geometry
*/ */
/** @namespace Magnum::Math::Geometry /** @namespace Magnum::Math::Geometry
@brief % Geometry library @brief Geometry library
Functions for computing intersections, distances, areas and volumes. Functions for computing intersections, distances, areas and volumes.
This library is built as part of % Magnum by default. To use it, you need to This library is built as part of Magnum by default. To use it, you need to
find `% Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link find `Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link
to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more
information. information.
*/ */
@ -101,13 +101,13 @@ information.
* @brief Namespace Magnum::Audio * @brief Namespace Magnum::Audio
*/ */
/** @namespace Magnum::Audio /** @namespace Magnum::Audio
@brief % Audio playback @brief Audio playback
Audio import, playback and integration with @ref SceneGraph. Audio import, playback and integration with @ref SceneGraph.
This library depends on **OpenAL** library. It is built if `WITH_AUDIO` is This library depends on **OpenAL** library. It is built if `WITH_AUDIO` is
enabled when building % Magnum. To use this library, you need to request enabled when building Magnum. To use this library, you need to request
`% Audio` component of `% Magnum` package in CMake, add `${MAGNUM_AUDIO_INCLUDE_DIRS}` `Audio` component of `Magnum` package in CMake, add `${MAGNUM_AUDIO_INCLUDE_DIRS}`
to include path and link to `${MAGNUM_AUDIO_LIBRARIES}`. See @ref building and to include path and link to `${MAGNUM_AUDIO_LIBRARIES}`. See @ref building and
@ref cmake for more information. Additional plugins are enabled separately, see @ref cmake for more information. Additional plugins are enabled separately, see
particular `*Importer` class documentation, @ref building-plugins, particular `*Importer` class documentation, @ref building-plugins,
@ -118,12 +118,12 @@ particular `*Importer` class documentation, @ref building-plugins,
* @brief Namespace Magnum::DebugTools * @brief Namespace Magnum::DebugTools
*/ */
/** @namespace Magnum::DebugTools /** @namespace Magnum::DebugTools
@brief % Debug tools @brief Debug tools
Debugging helpers, renderers and profilers. Debugging helpers, renderers and profilers.
This library is built if `WITH_DEBUGTOOLS` is enabled when building % Magnum. To This library is built if `WITH_DEBUGTOOLS` is enabled when building Magnum. To
use this library, you need to request `% DebugTools` component of `% Magnum` use this library, you need to request `DebugTools` component of `Magnum`
package in CMake and link to `${MAGNUM_DEBUGTOOLS_LIBRARIES}`. See package in CMake and link to `${MAGNUM_DEBUGTOOLS_LIBRARIES}`. See
@ref building, @ref cmake and @ref debug-tools for more information. @ref building, @ref cmake and @ref debug-tools for more information.
*/ */
@ -132,12 +132,12 @@ package in CMake and link to `${MAGNUM_DEBUGTOOLS_LIBRARIES}`. See
* @brief Namespace Magnum::MeshTools * @brief Namespace Magnum::MeshTools
*/ */
/** @namespace Magnum::MeshTools /** @namespace Magnum::MeshTools
@brief % Mesh tools @brief Mesh tools
Tools for generating, optimizing and cleaning meshes. Tools for generating, optimizing and cleaning meshes.
This library is built if `WITH_MESHTOOLS` is enabled when building % Magnum. To This library is built if `WITH_MESHTOOLS` is enabled when building Magnum. To
use this library, you need to request `% MeshTools` component of `% Magnum` use this library, you need to request `MeshTools` component of `Magnum`
package in CMake and link to `${MAGNUM_MESHTOOLS_LIBRARIES}`. See @ref building package in CMake and link to `${MAGNUM_MESHTOOLS_LIBRARIES}`. See @ref building
and @ref cmake for more information. and @ref cmake for more information.
*/ */
@ -150,8 +150,8 @@ and @ref cmake for more information.
Basic primitives for testing purposes. Basic primitives for testing purposes.
This library is built if `WITH_PRIMITIVES` is enabled when building % Magnum. To This library is built if `WITH_PRIMITIVES` is enabled when building Magnum. To
use this library, you need to request `% Primitives` component of `% Magnum` use this library, you need to request `Primitives` component of `Magnum`
package in CMake and link to `${MAGNUM_PRIMITIVES_LIBRARIES}`. See package in CMake and link to `${MAGNUM_PRIMITIVES_LIBRARIES}`. See
@ref building and @ref cmake for more information. @ref building and @ref cmake for more information.
*/ */
@ -161,12 +161,12 @@ package in CMake and link to `${MAGNUM_PRIMITIVES_LIBRARIES}`. See
*/ */
/** /**
@namespace Magnum::SceneGraph @namespace Magnum::SceneGraph
@brief % Scene graph library @brief Scene graph library
Managing object hierarchy, transformations and interactions. Managing object hierarchy, transformations and interactions.
This library is built if `WITH_SCENEGRAPH` is enabled when building % Magnum. To This library is built if `WITH_SCENEGRAPH` is enabled when building Magnum. To
use this library, you need to request `% SceneGraph` component of `% Magnum` use this library, you need to request `SceneGraph` component of `Magnum`
package in CMake and link to `${MAGNUM_SCENEGRAPH_LIBRARIES}`. See package in CMake and link to `${MAGNUM_SCENEGRAPH_LIBRARIES}`. See
@ref building, @ref cmake and @ref scenegraph for more information. @ref building, @ref cmake and @ref scenegraph for more information.
*/ */
@ -179,8 +179,8 @@ package in CMake and link to `${MAGNUM_SCENEGRAPH_LIBRARIES}`. See
Collection of shaders for easy prototyping and basic usage. Collection of shaders for easy prototyping and basic usage.
This library is built if `WITH_SHADERS` is enabled when building % Magnum. To This library is built if `WITH_SHADERS` is enabled when building Magnum. To
use this library, you need to request `% Shaders` component of `% Magnum` package use this library, you need to request `Shaders` component of `Magnum` package
in CMake and link to `${MAGNUM_MESHTOOLS_SHADERS}`. See @ref building and in CMake and link to `${MAGNUM_MESHTOOLS_SHADERS}`. See @ref building and
@ref cmake for more information. @ref cmake for more information.
*/ */
@ -189,12 +189,12 @@ in CMake and link to `${MAGNUM_MESHTOOLS_SHADERS}`. See @ref building and
* @brief Namespace Magnum::Shapes * @brief Namespace Magnum::Shapes
*/ */
/** @namespace Magnum::Shapes /** @namespace Magnum::Shapes
@brief % Shape library @brief Shape library
Collision detection system. Collision detection system.
This library is built if `WITH_SHAPES` is enabled when building % Magnum. To use This library is built if `WITH_SHAPES` is enabled when building Magnum. To use
this library, you need to request `% Shapes` component of `% Magnum` package in this library, you need to request `Shapes` component of `Magnum` package in
CMake and link to `${MAGNUM_SHAPES_LIBRARIES}`. See @ref building, @ref cmake CMake and link to `${MAGNUM_SHAPES_LIBRARIES}`. See @ref building, @ref cmake
and @ref shapes for more information. and @ref shapes for more information.
*/ */
@ -203,12 +203,12 @@ and @ref shapes for more information.
* @brief Namespace Magnum::Text * @brief Namespace Magnum::Text
*/ */
/** @namespace Magnum::Text /** @namespace Magnum::Text
@brief % Text rendering @brief Text rendering
Font texture creation and text layouting. Font texture creation and text layouting.
This library is built if `WITH_TEXT` is enabled when building % Magnum. To use This library is built if `WITH_TEXT` is enabled when building Magnum. To use
this library, you need to request `% Text` component of `% Magnum` package in this library, you need to request `Text` component of `Magnum` package in
CMake and link to `${MAGNUM_TEXT_LIBRARIES}`. See @ref building and @ref cmake CMake and link to `${MAGNUM_TEXT_LIBRARIES}`. See @ref building and @ref cmake
for more information. Additional plugins are enabled separately, see particular for more information. Additional plugins are enabled separately, see particular
`*Font` and `*FontConverter` class documentation, @ref building-plugins, `*Font` and `*FontConverter` class documentation, @ref building-plugins,
@ -219,12 +219,12 @@ for more information. Additional plugins are enabled separately, see particular
* @brief Namespace Magnum::TextureTools * @brief Namespace Magnum::TextureTools
*/ */
/** @namespace Magnum::TextureTools /** @namespace Magnum::TextureTools
@brief % Texture tools @brief Texture tools
Tools for generating, compressing and optimizing textures. Tools for generating, compressing and optimizing textures.
This library is built if `WITH_TEXTURETOOLS` is enabled when building % Magnum. This library is built if `WITH_TEXTURETOOLS` is enabled when building Magnum.
To use this library, you need to request `% TextureTools` component of `% Magnum` To use this library, you need to request `TextureTools` component of `Magnum`
package in CMake and link to `${MAGNUM_TEXTURETOOLS_LIBRARIES}`. See package in CMake and link to `${MAGNUM_TEXTURETOOLS_LIBRARIES}`. See
@ref building and @ref cmake for more information. @ref building and @ref cmake for more information.
*/ */
@ -238,8 +238,8 @@ package in CMake and link to `${MAGNUM_TEXTURETOOLS_LIBRARIES}`. See
Contains plugin interfaces for importing data of various formats and classes Contains plugin interfaces for importing data of various formats and classes
for direct access to the data. for direct access to the data.
This library is built as part of % Magnum by default. To use it, you need to This library is built as part of Magnum by default. To use it, you need to
find `% Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link find `Magnum` package, add `${MAGNUM_INCLUDE_DIRS}` to include path and link
to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more
information. Additional plugins are enabled separately, see particular information. Additional plugins are enabled separately, see particular
`*Importer` and `*ImageConverter` class documentation, @ref building-plugins, `*Importer` and `*ImageConverter` class documentation, @ref building-plugins,
@ -247,5 +247,5 @@ information. Additional plugins are enabled separately, see particular
*/ */
/** @dir magnum/src/MagnumPlugins /** @dir magnum/src/MagnumPlugins
* @brief % Magnum plugins (part of @ref building "Magnum library") * @brief Magnum plugins (part of @ref building "Magnum library")
*/ */
Vladimír Vondruš
12 years ago