.. include:: defs.hrst

CMake
#####

Include |Obscura|
-----------------

Currently we only support integrating |Obscura| by including the library via ``add_subdirectory``. We will make the library installable and consumable soon.

Build parameters for |Obscura|
------------------------------
.. list-table:: Build parameters
   :widths: 25 15 50
   :header-rows: 1

   * - Option
     - Default
     - Description
   * - ``OBSUCRA_BUILD_EXAMPLES``
     - ``OFF``
     - Build the examples
   * - ``OBSUCRA_BUILD_DOCS``
     - ``OFF``
     - Build the documentation
   * - ``OBSUCRA_PACKAGE_TESTS``
     - ``OFF``
     - Build the tests
   * - ``OBSUCRA_BUILD_HEADLESS``
     - ``OFF``
     - Build the headless version of the engine
   * - ``OBSCURA_ENABLE_STATIC_CHECKS``
     - ``ON``
     - Enables static check tools clang-tidy and cppcheck
   * - ``OBSCURA_ENABLE_EXPERIMENTAL_STATIC_CHECKS``
     - ``OFF``
     - Enables gcc -fanalyzer flag (not recommended to use)
   * - ``OBSCURA_BUILD_ENGINE``
     - ``ON``
     - Build the actual engine. Turning this off only makes sense if you only want to build the documentation without having the dependencies installed.
   * - ``OBSCURA_PRECOMPILE_HEADERS``
     - ``ON``
     - Precompile headers for faster compilation times. Might cause issues with clang-tidy.