CMake Options

You can tweak the generation of nCine project files with the following CMake options and variables:

• NCINE_OPTIONS_PRESETS

  If this variable is set all the following options and variables will be set accordingly in order to produce a binary only or a developer distribution of the nCine. The only two allowed values are "BinDist" and "DevDist" respectively.

• NCINE_BUILD_TESTS

  You can set this option to enable or disable the compilation of test programs. Should you enable it make sure to have cloned the data repository as well.

• NCINE_BUILD_UNIT_TESTS

  You can set this option to enable or disable the compilation of unit tests. When enabled CMake will first download and compile Google Test, then the unit tests.

  • GTEST_VERSION_TAG

    Use this variable to specify a particular commit, tag or branch for Google Test.

• NCINE_BUILD_BENCHMARKS

  You can set this option to enable or disable the compilation of the micro benchmarks. When enabled CMake will first download and compile Google Benchmark, then the micro benchmarks.

  • GBENCHMARK_VERSION_TAG

    Use this variable to specify a particular commit, tag or branch for Google Benchmark.

• NCINE_INSTALL_DEV_SUPPORT

  By enabling this option the nCine installation package will include all the files that support development.

• NCINE_LINKTIME_OPTIMIZATION

  This option will enable the use of whole program and link time optimizations when in Release mode.

• NCINE_AUTOVECTORIZATION_REPORT

  This option will enable report generation from compiler auto-vectorization.

• NCINE_DYNAMIC_LIBRARY

  By enabling this option the engine will be compiled as a dynamic library. Otherwise it will be compiled as a static library. The latter will allow the compilation of additional tests but needs more work from the user.

  When the engine is compiled as a static library any project using it needs to link to all the dynamic libraries on which the engine normally depends.

• NCINE_BUILD_DOCUMENTATION

  By enabling this option Doxygen will be invoked to create the HTML based API documentation and an install target will be set up by CMake.

  • NCINE_IMPLEMENTATION_DOCUMENTATION

    When this option is enabled, the generated documentation will include implementation classes.

• NCINE_EMBED_SHADERS

  By enabling this option CMake will export all shader files in a single file of C strings to be included in the engine sources.

• NCINE_BUILD_ANDROID

  This option will build the Android version of the engine.

  • NCINE_NDK_ARCHITECTURES

    This is a CMake list of the target architectures when compiling for Android. Supported ones are armeabi-v7a, arm64-v8a and x86_64.

  • NCINE_ASSEMBLE_APK

    This option is only available when NCINE_BUILD_ANDROID is on. It will automatically assemble the Android APK invoking the Gradle executable, if it could be found.

  • NCINE_UNIVERSAL_APK

    This option is only available when NCINE_BUILD_ANDROID is on. It will configure the Gradle build script to assemble an additional APK that contains all ABIs specified in NCINE_NDK_ARCHITECTURES.

  • NDK_DIR

    This string should be set to the path of the directory containing the Android NDK. If this string is not set to a valid directory then the ANDROID_NDK_HOME, ANDROID_NDK_ROOT and ANDROID_NDK environment variables will be queried in this order.

• NCINE_STRIP_BINARIES

  When this option is enabled all Linux and Android libraries and executables will be stripped with the strip command.

• NCINE_WITH_THREADS

  This option enables the support for the system agnostic threads API. On Emscripten the Pthreads support is disabled by default as it is in a prototyping stage.

• NCINE_WITH_GLEW

  This option enables the integration with the GLEW library and cannot be turned off on Windows.

• NCINE_WITH_ANGLE

  This option enables the support for Google ANGLE libraries on Windows. It will work only when compiling with MSVC and when libraries are found inside the EXTERNAL_MSVC_DIR directory.

• NCINE_WITH_PNG

  This option enables the integration with the zlib and libpng libraries to allow PNG images loading.

• NCINE_WITH_WEBP

  This option enables the integration with the libwebp library to allow WebP images loading.

• NCINE_WITH_AUDIO

  This option enables the audio and the integration with the OpenAL library.

• NCINE_WITH_VORBIS

  This option enables the integration with the libogg and libvorbis libraries to allow Ogg Vorbis sound loading. It is automatically disabled when NCINE_WITH_AUDIO is not enabled.

• NCINE_WITH_LUA

  This option enables the integration with the Lua library.

  • NCINE_WITH_SCRIPTING_API

    This option enables the Lua scripting API.

• NCINE_WITH_ALLOCATORS

  This option enables the custom memory allocators and the allocation manager.

  • NCINE_RECORD_ALLOCATIONS

    When this option is enabled every allocation or deallocation request will be recorded alongside a timestamp.

  • NCINE_OVERRIDE_NEW

    With this option the global operator new and operator delete will be overriden to use the custom memory allocator.

  • NCINE_USE_FREELIST

    When this option is enabled the FreeList allocator will be used instead of the malloc()/free() based one.

  • NCINE_FREELIST_BUFFER

    This variable will hold the size in bytes of the buffer used by the FreeList allocator. The default size is 32 MiB.

• NCINE_WITH_IMGUI

  When this option is enabled the engine will feature an integration with the Dear ImGui user interface toolkit.

  • IMGUI_VERSION_TAG

    Use this variable to specify a particular commit, tag or branch for Dear ImGui.

• NCINE_WITH_NUKLEAR

  When this option is enabled the engine will feature an integration with the Nuklear user interface toolkit.

  • NUKLEAR_VERSION_TAG

    Use this variable to specify a particular commit, tag or branch for Nuklear.

• NCINE_WITH_TRACY

  When this option is enabled the engine will feature an integration with the Tracy frame profiler.

  • TRACY_VERSION_TAG

    Use this variable to specify a particular commit, tag or branch for Tracy.

• NCINE_WITH_RENDERDOC

  When this option is enabled the engine will feature the in-application integration with the RenderDoc graphics debugger.

  • RENDERDOC_DIR

    If the RenderDoc directory cannot be found automatically you can set its path with this variable.

• NCINE_PREFERRED_BACKEND

  This option specifies the preferred backend to use on desktop for input and window handling. Possible values include GLFW, SDL2 and QT5.

  If you choose QT5 don't forget to define Qt5_DIR and optionally Qt5Gamepad_DIR for CMake to find the required libraries.

• NCINE_EMSCRIPTEN_THREADS

  This options enables the Emscripten Pthreads support by setting both USE_PTHREADS and WASM_MEM_MAX compiler and linker options. It might slow down code execution if WebAssembly is disabled in the compilation scripts.

• NCINE_TESTS_DATA_DIR

  This string sets the path to the data directory that will be embedded in example tests.

• NCINE_CODE_COVERAGE

  This option enables the gcov coverage of GCC and Clang compilers. It is especially useful in combination with NCINE_BUILD_UNIT_TESTS.

• NCINE_ADDRESS_SANITIZER

  This option enables the AddressSanitizer memory error detector of GCC and Clang compilers.

• NCINE_GCC_HARDENING

  This option enables the memory corruption mitigation methods of the GCC compiler.

• NCINE_DATA_DIR

  This string should be set to the path of the directory containing the tests data files.

• EXTERNAL_ANDROID_DIR

  This string should be set to the path of the directory containing the Android dependency libraries.

• EXTERNAL_MSVC_DIR

  This string should be set to the path of the directory containing the MSVC dependency libraries.

• EXTERNAL_EMSCRIPTEN_DIR

  This string should be set to the path of the directory containing the Emscripten dependency libraries.

• NCINE_STARTUP_TEST

  This should be set to a valid target name of a test program. It will then become the startup project in Visual Studio.