| Option | Description | Default | Advanced |
|---|---|---|---|
ENABLE_CCACHE
|
Build with ccache. | ON | NO |
BUILD_WITH_CUDA
|
Enable CUDA | OFF | NO |
BUILD_GLSL_EXTENSIONS
|
Build GLSL extensions API | ON | NO |
BUILD_WITH_OPENMP
|
Use OpenMP | OFF | NO |
BUILD_EASYLOGGINGPP
|
Build EasyLogging++ as a part of the build | ON | NO |
BUILD_WITH_STATIC_CRT
|
Build with static link CRT | ON | NO |
HWM_OVER_XU
|
Send HWM commands over UVC XU control | ON | NO |
COM_MULTITHREADED
|
Set OFF to initialize COM library with COINIT_APARTMENTTHREADED (Windows only) | ON | NO |
BUILD_SHARED_LIBS
|
Build shared library | ON | NO |
BUILD_UNIT_TESTS
|
Build LibCI unit tests. If enabled, additional test data may be downloaded | OFF | NO |
BUILD_VIEWER_TESTS
|
Build automated GUI tests for realsense-viewer, will use FetchContent for the test engine files | OFF | NO |
BUILD_EXAMPLES
|
Build examples (not including graphical examples -- see BUILD_GRAPHICAL_EXAMPLES) | ON | NO |
BUILD_GRAPHICAL_EXAMPLES
|
Build graphical examples (Viewer & DQT) -- Implies BUILD_GLSL_EXTENSIONS | ON | NO |
BUILD_CV_EXAMPLES
|
Build OpenCV examples | OFF | NO |
BUILD_DLIB_EXAMPLES
|
Build DLIB examples - requires DLIB_DIR | OFF | NO |
BUILD_PCL_EXAMPLES
|
Build PCL examples | OFF | NO |
BUILD_TOOLS
|
Build tools (fw-updater, etc.) that are not examples | ON | NO |
ENFORCE_METADATA
|
Require WinSDK with Metadata support during compilation. Windows OS Only | OFF | NO |
BUILD_PYTHON_BINDINGS
|
Build Python bindings | OFF | NO |
BUILD_LEGACY_PYBACKEND
|
Build deprecated Python backend bindings | OFF | NO |
BUILD_PYTHON_DOCS
|
Build Documentation for Python bindings | OFF | NO |
BUILD_CSHARP_BINDINGS
|
Build C# bindings | OFF | NO |
BUILD_MATLAB_BINDINGS
|
Build Matlab bindings | OFF | NO |
BUILD_UNITY_BINDINGS
|
Copy the unity project to the build folder with the required dependencies | OFF | NO |
BUILD_OPENVINO_EXAMPLES
|
Build Intel OpenVINO Toolkit examples - requires INTEL_OPENVINO_DIR | OFF | NO |
BUILD_OPEN3D_EXAMPLES
|
Build Open3D examples | OFF | NO |
BUILD_OPENNI2_BINDINGS
|
Build OpenNI bindings | OFF | NO |
BUILD_CV_KINFU_EXAMPLE
|
Build OpenCV KinectFusion example | OFF | NO |
FORCE_RSUSB_BACKEND
|
Use RS USB backend, mandatory for Win7/MacOS/Android, optional for Linux | OFF | NO |
FORCE_LIBUVC
|
Explicitly turn-on libuvc backend - deprecated, use FORCE_RSUSB_BACKEND instead | OFF | NO |
FORCE_WINUSB_UVC
|
Explicitly turn-on winusb_uvc (for win7) backend - deprecated, use FORCE_RSUSB_BACKEND instead | OFF | NO |
ANDROID_USB_HOST_UVC
|
Build UVC backend for Android - deprecated, use FORCE_RSUSB_BACKEND instead | OFF | NO |
CHECK_FOR_UPDATES
|
Checks for versions updates This feature requires OpenSSL installation on Linux/OSX, OSX normally does not come with OpenSSL integrated(Thats why default is OFF on OSX) |
Environment dependantON if NOT APPLE,OFF otherwise |
NO |
BUILD_WITH_CPU_EXTENSIONS
|
Enable compiler optimizations using CPU extensions (such as AVX) | ON | NO |
BUILD_WITH_NEON
|
Enable ARM64 NEON optimizations Enable NEON option only on 64-bit ARM platforms (ARM64/AArch64) |
Environment dependantON if CMAKE_SYSTEM_PROCESSOR MATCHES "^(arm64|ARM64|aarch64|AARCH64)" |
NO |
UNIT_TESTS_ARGS
|
Command-line arguments to pass to unit-tests-config.py, e.g. '-t |
""
|
NO |
ENABLE_EASYLOGGINGPP_ASYNC
|
Switch Logger to Asynchronous Mode (set OFF for Synchronous Mode) Performance improvement with Ubuntu 18/20 |
Environment dependantON if UNIX AND (NOT ANDROID_NDK_TOOLCHAIN_INCLUDED),OFF otherwise |
NO |
BUILD_PC_STITCHING
|
Build pointcloud-stitching example | OFF | NO |
BUILD_WITH_DDS
|
Access camera devices through DDS topics (requires CMake 3.16.3) | OFF | NO |
BUILD_RS2_ALL
|
Build realsense2-all static bundle containing all realsense libraries (with BUILD_SHARED_LIBS=OFF) | ON | NO |
ENABLE_SECURITY_FLAGS
|
Enable additional compiler security flags to enhance the build's security | OFF | NO |
USE_EXTERNAL_LZ4
|
Use externally build LZ4 library instead of building and using the in this repo provided version | OFF | NO |
BUILD_ASAN
|
Enable AddressSanitizer | OFF | YES |
BUILD_ROSBAG2
|
Build and use rosbag2 recording system" ON) # temporary flag, should be removed when deprecated ROSBAG1 recording system is | removed | YES |