Browse Source

Doc: updated window context building options.

vectorfields
Vladimír Vondruš 14 years ago
parent
commit
9a391beb96
  1. 2
      README.md
  2. 27
      doc/building.dox

2
README.md

@ -48,7 +48,7 @@ these four commands:
mkdir -p build && cd build mkdir -p build && cd build
cmake .. \ cmake .. \
-DCMAKE_INSTALL_PREFIX=/usr \ -DCMAKE_INSTALL_PREFIX=/usr \
-DWITH_GLUTCONTEXT=ON -DWITH_GLUTWINDOWCONTEXT=ON
make make
make install make install

27
doc/building.dox

@ -37,13 +37,14 @@ subdirectory:
git submodule update git submodule update
@section building-compilation Compilation, installation @section building-compilation Compilation, installation
The library (for example with GLUT context) can be built and installed using The library (for example with GLUT window context) can be built and installed
these four commands. See below for more information about optional features. using these four commands. See below for more information about optional
features.
mkdir -p build && cd build mkdir -p build && cd build
cmake .. \ cmake .. \
-DCMAKE_INSTALL_PREFIX=/usr \ -DCMAKE_INSTALL_PREFIX=/usr \
-DWITH_GLUTCONTEXT=ON -DWITH_GLUTWINDOWCONTEXT=ON
make make
make install make install
@ -59,22 +60,24 @@ By default the engine is built with everything except
@ref Contexts "context libraries". Using `WITH_*` CMake parameters you can @ref Contexts "context libraries". 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_EVERYTHING` - Defaults to `ON`, builds everything except contexts. If - `WITH_EVERYTHING` - Defaults to `ON`, builds everything except window
set to `OFF`, only the main library is built and you can select additional contexts. If set to `OFF`, only the main library is built and you can
libraries with the following: select additional libraries with the following:
- `WITH_MESHTOOLS` - MeshTools library. - `WITH_MESHTOOLS` - MeshTools library.
- `WITH_PHYSICS` - Physics library. - `WITH_PHYSICS` - Physics library.
- `WITH_PRIMITIVES` - Primitives library. - `WITH_PRIMITIVES` - Primitives library.
- `WITH_SHADERS` - Shaders library. - `WITH_SHADERS` - Shaders library.
None of the context libraries is built by default, regardless to None of the window context libraries is built by default, regardless to
`WITH_EVERYTHING` is enabled or not: `WITH_EVERYTHING` is enabled or not:
- `WITH_EGLCONTEXT` - X/EGL context, available only if targeting OpenGL ES - `WITH_XEGLWINDOWCONTEXT` - X/EGL window context, available only if
(see above). Requires **X11** and **EGL** libraries. targeting OpenGL ES (see above). Requires **X11** and **EGL** libraries.
- `WITH_GLUTCONTEXT` - GLUT context, available only if targeting desktop - `WITH_GLXWINDOWCONTEXT` - GLX window context. Requires **X11** and **GLX**
OpenGL. Requires **GLUT** library. libraries.
- `WITH_SDL2CONTEXT` - SDL2 context. Requires **SDL2** library. - `WITH_GLUTWINDOWCONTEXT` - GLUT window context, available only if targeting
desktop OpenGL. Requires **GLUT** library.
- `WITH_SDL2WINDOWCONTEXT` - SDL2 window context. Requires **SDL2** library.
@subsection building-tests Building and running unit tests @subsection building-tests Building and running unit tests
If you want to build also unit tests (which are not built by default), pass If you want to build also unit tests (which are not built by default), pass

Loading…
Cancel
Save