ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: minor formatting changes.

pull/34/head
Vladimír Vondruš 13 years ago
parent
fcc56014b8
commit
b9ca288b69
3 changed files with 64 additions and 64 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 58
      doc/building.dox
  2. 68
      doc/cmake.dox
  3. 2
      modules/FindMagnum.cmake

58
doc/building.dox
Unescape View File

@ -140,40 +140,40 @@ 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
is enabled. `WITH_DEBUGTOOLS` is enabled.
- `WITH_PRIMITIVES` - Primitives library. Enabled automatically if `WITH_DEBUGTOOLS` - `WITH_PRIMITIVES` - Primitives library. Enabled automatically if
is enabled. `WITH_DEBUGTOOLS` is enabled.
- `WITH_SCENEGRAPH` - SceneGraph library. Enabled automatically if `WITH_DEBUGTOOLS` - `WITH_SCENEGRAPH` - SceneGraph library. Enabled automatically if
or `WITH_SHAPES` is enabled. `WITH_DEBUGTOOLS` or `WITH_SHAPES` is enabled.
- `WITH_SHADERS` - Shaders library. Enabled automatically if `WITH_DEBUGTOOLS` - `WITH_SHADERS` - Shaders library. Enabled automatically if `WITH_DEBUGTOOLS`
is enabled. is enabled.
- `WITH_SHAPES` - Shapes library. Enables also building of SceneGraph library. - `WITH_SHAPES` - Shapes library. Enables also building of SceneGraph
Enabled automatically if `WITH_DEBUGTOOLS` is enabled. library. Enabled automatically if `WITH_DEBUGTOOLS` is enabled.
- `WITH_TEXT` - Text library. Enables also building of TextureTools library. - `WITH_TEXT` - Text library. Enables also building of TextureTools library.
- `WITH_TEXTURETOOLS` - TextureTools library. Enabled automatically if `WITH_TEXT` - `WITH_TEXTURETOOLS` - TextureTools library. Enabled automatically if
or `WITH_DISTANCEFIELDCONVERTER` is enabled. `WITH_TEXT` or `WITH_DISTANCEFIELDCONVERTER` is enabled.
- `WITH_MAGNUMINFO` - `magnum-info` executable, provides information about the - `WITH_MAGNUMINFO` - `magnum-info` executable, provides information about
engine and OpenGL capabilities. the engine and OpenGL capabilities.
- `WITH_DISTANCEFIELDCONVERTER` - `magnum-distancefield` executable for - `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.
None of the @ref Platform "application libraries" is built by default (and you None of the @ref Platform "application libraries" is built by default (and you
need at least one). Choose the one which suits your requirements and your need at least one). Choose the one which suits your requirements and your
platform best: platform best:
- `WITH_GLUTAPPLICATION` - @ref Platform::GlutApplication "GlutApplication" - `WITH_GLUTAPPLICATION` - @ref Platform::GlutApplication "GlutApplication"
- `WITH_GLXAPPLICATION` - @ref Platform::GlxApplication "GlxApplication" - `WITH_GLXAPPLICATION` - @ref Platform::GlxApplication "GlxApplication"
- `WITH_NACLAPPLICATION` - @ref Platform::NaClApplication "NaClApplication" - `WITH_NACLAPPLICATION` - @ref Platform::NaClApplication "NaClApplication"
- `WITH_SDL2APPLICATION` - @ref Platform::Sdl2Application "Sdl2Application" - `WITH_SDL2APPLICATION` - @ref Platform::Sdl2Application "Sdl2Application"
- `WITH_XEGLAPPLICATION` - @ref Platform::XEglApplication "XEglApplication" - `WITH_XEGLAPPLICATION` - @ref Platform::XEglApplication "XEglApplication"
- `WITH_WINDOWLESSGLXAPPLICATION` - @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication" - `WITH_WINDOWLESSGLXAPPLICATION` - @ref Platform::WindowlessGlxApplication "WindowlessGlxApplication"
- `WITH_WINDOWLESSNACLAPPLICATION` - @ref Platform::WindowlessNaClApplication "WindowlessNaClApplication" - `WITH_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

68
doc/cmake.dox
Unescape View File

@ -40,37 +40,37 @@ Basic usage is:
This command tries to find base %Magnum library and then defines these This command tries to find base %Magnum library and then defines these
variables: variables:
- `MAGNUM_FOUND` -- Whether the library was found - `MAGNUM_FOUND` -- Whether the library was found
- `MAGNUM_LIBRARIES` -- %Magnum library and dependent libraries - `MAGNUM_LIBRARIES` -- %Magnum library and dependent libraries
- `MAGNUM_INCLUDE_DIRS` -- Root include dir and include dirs of dependencies - `MAGNUM_INCLUDE_DIRS` -- Root include dir and include dirs of dependencies
- `MAGNUM_PLUGINS_FONT_DIR` -- Directory with font plugins - `MAGNUM_PLUGINS_FONT_DIR` -- Directory with font plugins
- `MAGNUM_PLUGINS_IMPORTER_DIR` -- Directory with importer plugins - `MAGNUM_PLUGINS_IMPORTER_DIR` -- Directory with importer plugins
However, this command will try to find only the base library, not the optional However, this command will try to find only the base library, not the optional
components. The base library depends on %Corrade and OpenGL libraries (or components. The base library depends on %Corrade and OpenGL libraries (or
OpenGL ES libraries). Additional dependencies are specified by the components. OpenGL ES libraries). Additional dependencies are specified by the components.
The optional components are: The optional components are:
- `%Audio` -- Audio library - `%Audio` -- Audio library
- `%DebugTools` -- DebugTools library (depends on `%MeshTools`, - `%DebugTools` -- DebugTools library (depends on `%MeshTools`,
`%Primitives`, `%SceneGraph`, `%Shaders` and `%Shapes` components) `%Primitives`, `%SceneGraph`, `%Shaders` and `%Shapes` components)
- `%MeshTools` -- MeshTools library - `%MeshTools` -- MeshTools library
- `%Primitives` -- Primitives library - `%Primitives` -- Primitives library
- `%SceneGraph` -- SceneGraph library - `%SceneGraph` -- SceneGraph library
- `%Shaders` -- Shaders library - `%Shaders` -- Shaders library
- `%Shapes` -- Shapes library (depends on `%SceneGraph` component) - `%Shapes` -- Shapes library (depends on `%SceneGraph` component)
- `%Text` -- Text library (depends on `%TextureTools` component) - `%Text` -- Text library (depends on `%TextureTools` component)
- `%TextureTools` -- TextureTools library - `%TextureTools` -- TextureTools library
Platform namespace is split into more components: Platform namespace is split into more components:
- `%GlutApplication` -- @ref Platform::GlutApplication "GlutApplication" - `%GlutApplication` -- @ref Platform::GlutApplication "GlutApplication"
- `%GlxApplication` -- @ref Platform::GlxApplication "GlxApplication" - `%GlxApplication` -- @ref Platform::GlxApplication "GlxApplication"
- `%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
@ -83,9 +83,9 @@ Example usage with specifying additional components is:
For each component is then defined: For each component is then defined:
- `MAGNUM_*_FOUND` -- Whether the component was found - `MAGNUM_*_FOUND` -- Whether the component was found
- `MAGNUM_*_LIBRARIES` -- Component library and dependent libraries - `MAGNUM_*_LIBRARIES` -- Component library and dependent libraries
- `MAGNUM_*_INCLUDE_DIRS` -- Include dirs of module dependencies - `MAGNUM_*_INCLUDE_DIRS` -- Include dirs of module dependencies
If exactly one `*Application` or exactly one `Windowless*Application` component If exactly one `*Application` or exactly one `Windowless*Application` component
is requested and found, its libraries and include dirs are available in is requested and found, its libraries and include dirs are available in
@ -96,15 +96,15 @@ convenience aliases `MAGNUM_APPLICATION_LIBRARIES` /
Features of found %Magnum library are exposed in these CMake variables, they Features of found %Magnum library are exposed in these CMake variables, they
are also available as preprocessor variables if including Magnum.h: are also available as preprocessor variables if including Magnum.h:
- `MAGNUM_BUILD_DEPRECATED` -- Defined if compiled with deprecated APIs - `MAGNUM_BUILD_DEPRECATED` -- Defined if compiled with deprecated APIs
included included
- `MAGNUM_BUILD_STATIC` -- Defined if built as static libraries. Default are - `MAGNUM_BUILD_STATIC` -- Defined if built as static libraries. Default are
shared libraries. shared libraries.
- `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
Unescape View File

@ -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)

Write Preview
Loading…
Cancel
Save