The artoolkitX build system - hipandayu/artoolkitx GitHub Wiki

artoolkitX includes a user-friendly build script which builds the SDK, including the ARX library (and its dependencies), the ARXJ library, the core utilities, and optionally the examples for each platform.

The main build system uses cmake as a generator, so if you prefer to customise your build, you can manually invoke cmake and then manually build using the resulting generated project files (makefiles / Xcode projects / Visual Studio projects etc.). The examples use prebuilt project files for iOS, macOS, and Windows, and cmake to generate project files for the remaining platforms.

To build the SDK:

cd Source && ./build.sh platform(s)

where platform(s) is one or more of: android, ios, linux, linux-raspbian, macos, windows.

Additionally, you can add the following parameters:

  • --debug: Does a debug build, rather than the default release build.
  • examples: Also compiles the examples for the specified platforms.

Cmake options:

If you use the build.sh script, these are set automatically. If you prefer to manually configure via cmake, these options can be set on the cmake command line by using cmakes's -D option. E.g. cmake -DCMAKE_BUILD_TYPE=Debug

Option Type Description
CMAKE_BUILD_TYPE STRING A core CMake variable. artoolkitX supported variants include Debug and Release.
GL_PREFER_EMBEDDED BOOLEAN When set, if both desktop and embedded OpenGL is available, embedded will be preferred.
ARX_TARGET_PLATFORM_VARIANT STRING If set, appends a platform variant name to all platform source dependencies. E.g. If ARX_TARGET_PLATFORM_LINUX is set, and ARX_TARGET_PLATFORM_VARIANT equals raspbian, header files will be searched for in depends/linux-raspbian/include