CMake options

CMake options#

eCAL is using CMake as build system. The build makes use of CMake options to configure what features to build and to see what capabilities are available. The options are grouped by their prefix:

  • ECAL_USE_ variables indicate if eCAL shall use a certain dependency. E.g setting ECAL_USE_QT to off, will disable all components of eCAL that have a (Qt) GUI attached.

  • ECAL_BUILD_ variables turn on / off certain eCAL components. Those components can be language bindings, application (like monitor / player / recorder), documentation or tests

  • ECAL_THIRDPARTY_BUILD variables control on a dependency by dependency basis, if that dependency is to be compiled alongside eCAL.

There are a few addional options which do not fit in these categories, but they are also documentd below.

All options can be passed on the command line cmake -D<option>=<value> or in the CMake GUI application.

To build the eCAL CSharp extension you need to set the CMake option ECAL_BUILD_CSHARP_BINDING to ON. In order to make the CSharp Google::Protobuf extension work you need to install additionally the Microsoft package management tool Nuget. Please ensure that the installation path is part of your windows user or system PATH environment variable. Nuget will be used to download the .Net Google.Protobuf package automatically when building the extension.