diff --git a/doc/building.dox b/doc/building.dox index 863c405ad..9d84d17ca 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -81,9 +81,18 @@ specify which parts will be built and which not: - `WITH_PRIMITIVES` - Primitives library. - `WITH_SCENEGRAPH` - SceneGraph library. - `WITH_SHADERS` - Shaders library. + - `WITH_TEXT` - Text library. Enables also building of TextureTools. Requires + **FreeType** and possibly **HarfBuzz** library (see below). + - `WITH_TEXTURETOOLS` - TextureTools library. - `WITH_MAGNUMINFO` - `magnum-info` executable, provides information about Magnum engine and OpenGL capabilities. +Some dependencies are optional, although disabling them might reduce some +functionality: + + - `USE_HARFBUZZ` - Defaults to `ON`, disabling it will result in worse text + rendering (no kerning & ligatures) and possible issues with non-Latin text. + None of the application libraries is built by default, regardless to `WITH_EVERYTHING` is enabled or not: diff --git a/modules/FindMagnum.cmake b/modules/FindMagnum.cmake index 240c27e83..4f9d96e06 100644 --- a/modules/FindMagnum.cmake +++ b/modules/FindMagnum.cmake @@ -23,7 +23,7 @@ # SceneGraph - Scene graph library # Shaders - Library with stock shaders # Text - Text rendering library (depends on TextureTools component, -# FreeType library and possibly HarfBuzz library) +# FreeType library and possibly HarfBuzz library, see below) # TextureTools - TextureTools library # GlxApplication - GLX application (depends on X11 libraries) # XEglApplication - X/EGL application (depends on EGL and X11 libraries) @@ -41,6 +41,14 @@ # MAGNUM_*_LIBRARIES - Component library and dependent libraries # MAGNUM_*_INCLUDE_DIRS - Include dirs of module dependencies # +# Features of found Magnum library are exposed in these variables: +# MAGNUM_TARGET_GLES - Defined if compiled for OpenGL ES +# MAGNUM_TARGET_GLES2 - Defined if compiled for OpenGL ES 2.0 +# MAGNUM_TARGET_DESKTOP_GLES - Defined if compiled with OpenGL ES emulation +# on desktop OpenGL +# MAGNUM_TARGET_NACL - Defined if compiled for Google Chrome Native Client +# MAGNUM_USE_HARFBUZZ - Defined if HarfBuzz library is used for text rendering +# # Additionally these variables are defined for internal usage: # MAGNUM_INCLUDE_DIR - Root include dir (w/o # dependencies)