Browse Source

doc: minor formatting changes.

pull/34/head
Vladimír Vondruš 13 years ago
parent
commit
b9ca288b69
  1. 34
      doc/building.dox
  2. 6
      doc/cmake.dox
  3. 2
      modules/FindMagnum.cmake

34
doc/building.dox

@ -140,26 +140,26 @@ By default the engine is built with nearly everything except Audio library and
application libraries (see below). Using `WITH_*` CMake parameters you can application libraries (see below). Using `WITH_*` CMake parameters you can
specify which parts will be built and which not: specify which parts will be built and which not:
- `WITH_AUDIO` - Audio library. Depends on **OpenAL** library, not built by - `WITH_AUDIO` - Audio library. Depends on **OpenAL** library, not built by
default. default.
- `WITH_DEBUGTOOLS` - DebugTools library. Enables also building of MeshTools, - `WITH_DEBUGTOOLS` - DebugTools library. Enables also building of MeshTools,
Primitives, SceneGraph, Shaders and Shapes libraries. Primitives, SceneGraph, Shaders and Shapes libraries.
- `WITH_MESHTOOLS` - MeshTools library. Enabled automatically if `WITH_DEBUGTOOLS` - `WITH_MESHTOOLS` - MeshTools library. Enabled automatically if
`WITH_DEBUGTOOLS` is enabled.
- `WITH_PRIMITIVES` - Primitives library. Enabled automatically if
`WITH_DEBUGTOOLS` is enabled.
- `WITH_SCENEGRAPH` - SceneGraph library. Enabled automatically if
`WITH_DEBUGTOOLS` or `WITH_SHAPES` is enabled.
- `WITH_SHADERS` - Shaders library. Enabled automatically if `WITH_DEBUGTOOLS`
is enabled. is enabled.
- `WITH_PRIMITIVES` - Primitives library. Enabled automatically if `WITH_DEBUGTOOLS` - `WITH_SHAPES` - Shapes library. Enables also building of SceneGraph
is enabled. library. Enabled automatically if `WITH_DEBUGTOOLS` is enabled.
- `WITH_SCENEGRAPH` - SceneGraph library. Enabled automatically if `WITH_DEBUGTOOLS` - `WITH_TEXT` - Text library. Enables also building of TextureTools library.
or `WITH_SHAPES` is enabled. - `WITH_TEXTURETOOLS` - TextureTools library. Enabled automatically if
- `WITH_SHADERS` - Shaders library. Enabled automatically if `WITH_DEBUGTOOLS` `WITH_TEXT` or `WITH_DISTANCEFIELDCONVERTER` is enabled.
is enabled. - `WITH_MAGNUMINFO` - `magnum-info` executable, provides information about
- `WITH_SHAPES` - Shapes library. Enables also building of SceneGraph library. the engine and OpenGL capabilities.
Enabled automatically if `WITH_DEBUGTOOLS` is enabled. - `WITH_DISTANCEFIELDCONVERTER` - `magnum-distancefield` executable for
- `WITH_TEXT` - Text library. Enables also building of TextureTools library.
- `WITH_TEXTURETOOLS` - TextureTools library. Enabled automatically if `WITH_TEXT`
or `WITH_DISTANCEFIELDCONVERTER` is enabled.
- `WITH_MAGNUMINFO` - `magnum-info` executable, provides information about the
engine and OpenGL capabilities.
- `WITH_DISTANCEFIELDCONVERTER` - `magnum-distancefield` executable for
converting black&white images to distance field textures. Enables also converting black&white images to distance field textures. Enables also
building of TextureTools library. building of TextureTools library.

6
doc/cmake.dox

@ -69,8 +69,8 @@ Platform namespace is split into more components:
- `%NaClApplication` -- @ref Platform::NaClApplication "NaClApplication" - `%NaClApplication` -- @ref Platform::NaClApplication "NaClApplication"
- `%Sdl2Application` -- @ref Platform::Sdl2Application "Sdl2Application" - `%Sdl2Application` -- @ref Platform::Sdl2Application "Sdl2Application"
- `%XEglApplication` -- @ref Platform::XEglApplication "XEglApplication" - `%XEglApplication` -- @ref Platform::XEglApplication "XEglApplication"
- `%WindowlessNaClApplication` -- @ref Platform::WindowlessNaClApplication "WindowlessNaClApplication"
- `%WindowlessGlxApplication` -- @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication" - `%WindowlessGlxApplication` -- @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication"
- `%WindowlessNaClApplication` -- @ref Platform::WindowlessNaClApplication "WindowlessNaClApplication"
Note that [each namespace](namespaces.html) and all @ref Platform libraries Note that [each namespace](namespaces.html) and all @ref Platform libraries
contain more detailed information about dependencies, availability on contain more detailed information about dependencies, availability on
@ -103,8 +103,8 @@ are also available as preprocessor variables if including Magnum.h:
- `MAGNUM_TARGET_GLES` -- Defined if compiled for OpenGL ES - `MAGNUM_TARGET_GLES` -- Defined if compiled for OpenGL ES
- `MAGNUM_TARGET_GLES2` -- Defined if compiled for OpenGL ES 2.0 - `MAGNUM_TARGET_GLES2` -- Defined if compiled for OpenGL ES 2.0
- `MAGNUM_TARGET_GLES3` -- Defined if compiled for OpenGL ES 3.0 - `MAGNUM_TARGET_GLES3` -- Defined if compiled for OpenGL ES 3.0
- `MAGNUM_TARGET_DESKTOP_GLES` -- Defined if compiled with OpenGL ES emulation - `MAGNUM_TARGET_DESKTOP_GLES` -- Defined if compiled with OpenGL ES
on desktop OpenGL emulation on desktop OpenGL
%Corrade library provides also its own set of CMake macros and variables, see %Corrade library provides also its own set of CMake macros and variables, see
@ref corrade-cmake "its documentation" for more information. @ref corrade-cmake "its documentation" for more information.

2
modules/FindMagnum.cmake

@ -35,8 +35,8 @@
# NaClApplication - NaCl application # NaClApplication - NaCl application
# Sdl2Application - SDL2 application # Sdl2Application - SDL2 application
# XEglApplication - X/EGL application # XEglApplication - X/EGL application
# WindowlessNaClApplication - Windowless NaCl application
# WindowlessGlxApplication - Windowless GLX application # WindowlessGlxApplication - Windowless GLX application
# WindowlessNaClApplication - Windowless NaCl application
# Example usage with specifying additional components is: # Example usage with specifying additional components is:
# find_package(Magnum [REQUIRED|COMPONENTS] # find_package(Magnum [REQUIRED|COMPONENTS]
# MeshTools Primitives GlutApplication) # MeshTools Primitives GlutApplication)

Loading…
Cancel
Save