# SPDX-License-Identifier: GPL-2.0-or-later

# Copyright 2006 Blender Foundation

# -----------------------------------------------------------------------------

# Early Initialization

# NOTE: We don't allow in-source builds. This causes no end of troubles because

# all out-of-source builds will use the CMakeCache.txt file there and even

# build the libs and objects in it.

if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})

if(NOT DEFINED WITH_IN_SOURCE_BUILD)

message(FATAL_ERROR

"CMake generation for blender is not allowed within the source directory!"

"\n Remove \"${CMAKE_SOURCE_DIR}/CMakeCache.txt\" and try again from another folder, e.g.:"

"\n "

"\n rm -rf CMakeCache.txt CMakeFiles"

"\n cd .."

"\n mkdir cmake-make"

"\n cd cmake-make"

"\n cmake ../blender"

"\n "

"\n Alternately define WITH_IN_SOURCE_BUILD to force this option (not recommended!)"

)

endif()

endif()

cmake_minimum_required(VERSION 3.10)

if(NOT EXECUTABLE_OUTPUT_PATH)

set(FIRST_RUN TRUE)

else()

set(FIRST_RUN FALSE)

endif()

# this starts out unset

list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/build_files/cmake/Modules")

list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/build_files/cmake/platform")

# Avoid having an empty `CMAKE_BUILD_TYPE`.

if(NOT DEFINED CMAKE_BUILD_TYPE_INIT)

set(CMAKE_BUILD_TYPE_INIT "Release")

# Internal logic caches this variable, avoid showing it by default

# since it's easy to accidentally set instead of the build type.

mark_as_advanced(CMAKE_BUILD_TYPE_INIT)

endif()

# Omit superfluous "Up-to-date" messages.

if(NOT DEFINED CMAKE_INSTALL_MESSAGE)

set(CMAKE_INSTALL_MESSAGE "LAZY")

endif()

# quiet output for Makefiles, 'make -s' helps too

# set_property(GLOBAL PROPERTY RULE_MESSAGES OFF)

# global compile definitions since add_definitions() adds for all.

set_property(DIRECTORY APPEND PROPERTY COMPILE_DEFINITIONS

$<$<CONFIG:Debug>:DEBUG;_DEBUG>

$<$<CONFIG:Release>:NDEBUG>

$<$<CONFIG:MinSizeRel>:NDEBUG>

$<$<CONFIG:RelWithDebInfo>:NDEBUG>

)

# -----------------------------------------------------------------------------

# Set policy

# see "cmake --help-policy CMP0003"

# So library linking is more sane

cmake_policy(SET CMP0003 NEW)

# So BUILDINFO and BLENDERPATH strings are automatically quoted

cmake_policy(SET CMP0005 NEW)

# So syntax problems are errors

cmake_policy(SET CMP0010 NEW)

# Input directories must have CMakeLists.txt

cmake_policy(SET CMP0014 NEW)

# Silence draco warning on macOS, new policy works fine.

if(POLICY CMP0068)

cmake_policy(SET CMP0068 NEW)

endif()

# find_package() uses <PackageName>_ROOT variables.

if(POLICY CMP0074)

cmake_policy(SET CMP0074 NEW)

endif()

# Install CODE|SCRIPT allow the use of generator expressions.

if(POLICY CMP0087)

cmake_policy(SET CMP0087 NEW)

endif()

# -----------------------------------------------------------------------------

# Load Blender's Local Macros

include(build_files/cmake/macros.cmake)

# -----------------------------------------------------------------------------

# Initialize Project

blender_project_hack_pre()

project(Blender)

blender_project_hack_post()

enable_testing()

# -----------------------------------------------------------------------------

# Test Compiler Support

#

# Keep in sync with: https://wiki.blender.org/wiki/Building_Blender

if(CMAKE_COMPILER_IS_GNUCC)

if("${CMAKE_C_COMPILER_VERSION}" VERSION_LESS "11.0.0")

message(FATAL_ERROR "The minimum supported version of GCC is 11.0.0, found ${CMAKE_C_COMPILER_VERSION}")

endif()

elseif(CMAKE_C_COMPILER_ID MATCHES "Clang")

if(CMAKE_COMPILER_IS_GNUCC AND ("${CMAKE_C_COMPILER_VERSION}" VERSION_LESS "8.0"))

message(FATAL_ERROR "The minimum supported version of CLANG is 8.0, found ${CMAKE_C_COMPILER_VERSION}")

endif()

elseif(CMAKE_CXX_COMPILER_ID MATCHES MSVC)

if(MSVC_VERSION VERSION_LESS "1928")

# MSVC_VERSION is an internal version number, it doesn't map to something

# the end user would recognize as a version. Because of this, for MSVC we do

# not show the found number. When using our make.bat the actual VS version

# will be displayed on the console before starting the build, anyway.

message(FATAL_ERROR "The minimum supported version of MSVC is 2019 (16.9.16)")

endif()

endif()

# -----------------------------------------------------------------------------

# Test Compiler/Library Features

include(build_files/cmake/have_features.cmake)

# -----------------------------------------------------------------------------

# Redirect Output Files

set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin CACHE INTERNAL "" FORCE)

set(LIBRARY_OUTPUT_PATH ${CMAKE_BINARY_DIR}/lib CACHE INTERNAL "" FORCE)

get_property(GENERATOR_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)

if(GENERATOR_IS_MULTI_CONFIG)

set(TESTS_OUTPUT_DIR ${EXECUTABLE_OUTPUT_PATH}/tests/$<CONFIG>/ CACHE INTERNAL "" FORCE)

else()

set(TESTS_OUTPUT_DIR ${EXECUTABLE_OUTPUT_PATH}/tests/ CACHE INTERNAL "" FORCE)

endif()

# -----------------------------------------------------------------------------

# Set Default Configuration Options

get_blender_version()

# -----------------------------------------------------------------------------

# Declare Options

# Blender internal features

option(WITH_BLENDER "Build blender (disable to build only Cycles stand-alone)." ON)

mark_as_advanced(WITH_BLENDER)

if(WIN32)

option(WITH_BLENDER_THUMBNAILER "\

Build \"BlendThumb.dll\" helper for Windows explorer integration to support extracting \

thumbnails from `.blend` files."

ON

)

else()

set(_option_default ON)

if(APPLE)

# In future, can be used with `quicklookthumbnailing/qlthumbnailreply`

# to create file thumbnails for say Finder.

# Turn it off for now, even though it can build on APPLE, it's not likely to be useful.

set(_option_default OFF)

endif()

option(WITH_BLENDER_THUMBNAILER "\

Build stand-alone \"blender-thumbnailer\" command-line thumbnail extraction utility, \

intended for use by file-managers to extract PNG images from `.blend` files."

${_option_default}

)

unset(_option_default)

endif()

option(WITH_INTERNATIONAL "Enable I18N (International fonts and text)" ON)

option(WITH_PYTHON "Enable Embedded Python API (only disable for development)" ON)

option(WITH_PYTHON_SECURITY "Disables execution of scripts within blend files by default" ON)

# Don't want people disabling this unless they really know what they are doing.

mark_as_advanced(WITH_PYTHON)

# Some distributions see this as a security issue, rather than have them patch it,

# make a build option.

mark_as_advanced(WITH_PYTHON_SECURITY)

option(WITH_PYTHON_SAFETY "Enable internal API error checking to track invalid data to prevent crash on access (at the expense of some efficiency, only enable for development)." OFF)

mark_as_advanced(WITH_PYTHON_SAFETY)

option(WITH_PYTHON_MODULE "Enable building as a python module which runs without a user interface, like running regular blender in background mode (experimental, only enable for development), installs to PYTHON_SITE_PACKAGES (or CMAKE_INSTALL_PREFIX if WITH_INSTALL_PORTABLE is enabled)." OFF)

option(WITH_BUILDINFO "Include extra build details (only disable for development & faster builds)" ON)

set(BUILDINFO_OVERRIDE_DATE "" CACHE STRING "Use instead of the current date for reproducible builds (empty string disables this option)")

set(BUILDINFO_OVERRIDE_TIME "" CACHE STRING "Use instead of the current time for reproducible builds (empty string disables this option)")

set(CPACK_OVERRIDE_PACKAGENAME "" CACHE STRING "Use instead of the standard packagename (empty string disables this option)")

mark_as_advanced(CPACK_OVERRIDE_PACKAGENAME)

mark_as_advanced(BUILDINFO_OVERRIDE_DATE)

mark_as_advanced(BUILDINFO_OVERRIDE_TIME)

if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.16")

option(WITH_UNITY_BUILD "Enable unity build for modules that support it to improve compile times" ON)

mark_as_advanced(WITH_UNITY_BUILD)

else()

set(WITH_UNITY_BUILD OFF)

endif()

option(WITH_IK_ITASC "Enable ITASC IK solver (only disable for development & for incompatible C++ compilers)" ON)

option(WITH_IK_SOLVER "Enable Legacy IK solver (only disable for development)" ON)

option(WITH_FFTW3 "Enable FFTW3 support (Used for smoke, ocean sim, and audio effects)" ON)

option(WITH_PUGIXML "Enable PugiXML support (Used for OpenImageIO, Grease Pencil SVG export)" ON)

option(WITH_BULLET "Enable Bullet (Physics Engine)" ON)

option(WITH_SYSTEM_BULLET "Use the systems bullet library (currently unsupported due to missing features in upstream!)" )

mark_as_advanced(WITH_SYSTEM_BULLET)

option(WITH_OPENCOLORIO "Enable OpenColorIO color management" ON)

set(_option_default ON)

if(APPLE)

# There's no OpenXR runtime in sight for macOS, neither is code well

# tested there -> disable it by default.

set(_option_default OFF)

endif()

option(WITH_XR_OPENXR "Enable VR features through the OpenXR specification" ${_option_default})

if(APPLE)

mark_as_advanced(WITH_XR_OPENXR)

endif()

unset(_option_default)

option(WITH_GMP "Enable features depending on GMP (Exact Boolean)" ON)

# Compositor

option(WITH_COMPOSITOR_CPU "Enable the tile based CPU nodal compositor" ON)

option(WITH_OPENIMAGEDENOISE "Enable the OpenImageDenoise compositing node" ON)

option(WITH_OPENSUBDIV "Enable OpenSubdiv for surface subdivision" ON)

option(WITH_POTRACE "Enable features relying on potrace" ON)

option(WITH_OPENVDB "Enable features relying on OpenVDB" ON)

option(WITH_OPENVDB_BLOSC "Enable blosc compression for OpenVDB, only enable if OpenVDB was built with blosc support" ON)

option(WITH_OPENVDB_3_ABI_COMPATIBLE "Assume OpenVDB library has been compiled with version 3 ABI compatibility" OFF)

mark_as_advanced(WITH_OPENVDB_3_ABI_COMPATIBLE)

option(WITH_NANOVDB "Enable usage of NanoVDB data structure for rendering on the GPU" ON)

option(WITH_HARU "Enable features relying on Libharu (Grease pencil PDF export)" ON)

# GHOST Windowing Library Options

option(WITH_GHOST_DEBUG "Enable debugging output for the GHOST library" OFF)

mark_as_advanced(WITH_GHOST_DEBUG)

option(WITH_GHOST_SDL "Enable building Blender against SDL for windowing rather than the native APIs" OFF)

mark_as_advanced(WITH_GHOST_SDL)

if(UNIX AND NOT (APPLE OR HAIKU))

option(WITH_GHOST_X11 "Enable building Blender against X11 for windowing" ON)

mark_as_advanced(WITH_GHOST_X11)

option(WITH_GHOST_WAYLAND "Enable building Blender against Wayland for windowing" ON)

mark_as_advanced(WITH_GHOST_WAYLAND)

if(WITH_GHOST_WAYLAND)

option(WITH_GHOST_WAYLAND_LIBDECOR "Optionally build with LibDecor window decorations" ON)

mark_as_advanced(WITH_GHOST_WAYLAND_LIBDECOR)

option(WITH_GHOST_WAYLAND_DBUS "Optionally build with DBUS support (used for Cursor themes). May hang on startup systems where DBUS is not used." OFF)

mark_as_advanced(WITH_GHOST_WAYLAND_DBUS)

option(WITH_GHOST_WAYLAND_DYNLOAD "Enable runtime dynamic WAYLAND libraries loading" ON)

mark_as_advanced(WITH_GHOST_WAYLAND_DYNLOAD)

set(WITH_GHOST_WAYLAND_APP_ID "" CACHE STRING "\

The application ID used for Blender (use default when an empty string), \

this can be used to differentiate Blender instances by version or branch for example."

)

mark_as_advanced(WITH_GHOST_WAYLAND_APP_ID)

endif()

endif()

if(WITH_GHOST_X11)

option(WITH_GHOST_XDND "Enable drag'n'drop support on X11 using XDND protocol" ON)

endif()

# Misc...

option(WITH_HEADLESS "Build without graphical support (renderfarm, server mode only)" OFF)

mark_as_advanced(WITH_HEADLESS)

option(WITH_QUADRIFLOW "Build with quadriflow remesher support" ON)

option(WITH_AUDASPACE "Build with blenders audio library (only disable if you know what you're doing!)" ON)

option(WITH_SYSTEM_AUDASPACE "Build with external audaspace library installed on the system (only enable if you know what you're doing!)" OFF)

mark_as_advanced(WITH_AUDASPACE)

mark_as_advanced(WITH_SYSTEM_AUDASPACE)

set_and_warn_dependency(WITH_AUDASPACE WITH_SYSTEM_AUDASPACE OFF)

option(WITH_OPENMP "Enable OpenMP (has to be supported by the compiler)" ON)

if(UNIX AND NOT APPLE)

option(WITH_OPENMP_STATIC "Link OpenMP statically (only used by the release environment)" OFF)

mark_as_advanced(WITH_OPENMP_STATIC)

endif()

if(WITH_GHOST_X11)

option(WITH_X11_XINPUT "Enable X11 Xinput (tablet support and unicode input)" ON)

option(WITH_X11_XF86VMODE "Enable X11 video mode switching" ON)

option(WITH_X11_XFIXES "Enable X11 XWayland cursor warping workaround" ON)

endif()

if(UNIX AND NOT APPLE)

option(WITH_SYSTEM_FREETYPE "Use the freetype library provided by the operating system" OFF)

option(WITH_SYSTEM_EIGEN3 "Use the systems Eigen3 library" OFF)

else()

set(WITH_SYSTEM_FREETYPE OFF)

set(WITH_SYSTEM_EIGEN3 OFF)

endif()

# Modifiers

option(WITH_MOD_FLUID "Enable Mantaflow Fluid Simulation Framework" ON)

option(WITH_MOD_REMESH "Enable Remesh Modifier" ON)

option(WITH_MOD_OCEANSIM "Enable Ocean Modifier" ON)

# Image format support

option(WITH_IMAGE_OPENEXR "Enable OpenEXR Support (http://www.openexr.com)" ON)

option(WITH_IMAGE_OPENJPEG "Enable OpenJpeg Support (http://www.openjpeg.org)" ON)

option(WITH_IMAGE_CINEON "Enable CINEON and DPX Image Support" ON)

option(WITH_IMAGE_WEBP "Enable WebP Image Support" ON)

# Audio/Video format support

option(WITH_CODEC_AVI "Enable Blenders own AVI file support (raw/jpeg)" ON)

option(WITH_CODEC_FFMPEG "Enable FFMPeg Support (http://ffmpeg.org)" ON)

option(WITH_CODEC_SNDFILE "Enable libsndfile Support (http://www.mega-nerd.com/libsndfile)" ON)

# Alembic support

option(WITH_ALEMBIC "Enable Alembic Support" ON)

# Universal Scene Description support

option(WITH_USD "Enable Universal Scene Description (USD) Support" ON)

# MaterialX

option(WITH_MATERIALX "Enable MaterialX Support" OFF)

# 3D format support

# Disable opencollada when we don't have precompiled libs

option(WITH_OPENCOLLADA "Enable OpenCollada Support (http://www.opencollada.org)" ON)

option(WITH_IO_WAVEFRONT_OBJ "Enable Wavefront-OBJ 3D file format support (*.obj)" ON)

option(WITH_IO_PLY "Enable PLY 3D file format support (*.ply)" ON)

option(WITH_IO_STL "Enable STL 3D file format support (*.stl)" ON)

option(WITH_IO_GPENCIL "Enable grease-pencil file format IO (*.svg, *.pdf)" ON)

# Sound output

option(WITH_SDL "Enable SDL for sound" ON)

option(WITH_OPENAL "Enable OpenAL Support (http://www.openal.org)" ON)

if(APPLE)

option(WITH_COREAUDIO "Enable CoreAudio for audio support on macOS" ON)

else()

set(WITH_COREAUDIO OFF)

endif()

if(NOT WIN32)

set(_option_default ON)

if(APPLE)

set(_option_default OFF)

endif()

option(WITH_JACK "Enable JACK Support (http://www.jackaudio.org)" ${_option_default})

unset(_option_default)

option(WITH_JACK_DYNLOAD "Enable runtime dynamic JACK libraries loading" OFF)

else()

set(WITH_JACK OFF)

endif()

if(UNIX AND NOT APPLE)

option(WITH_SDL_DYNLOAD "Enable runtime dynamic SDL libraries loading" OFF)

endif()

if(UNIX AND NOT APPLE)

option(WITH_PULSEAUDIO "Enable PulseAudio for audio support on Linux" ON)

option(WITH_PULSEAUDIO_DYNLOAD "Enable runtime dynamic PulseAudio libraries loading" OFF)

else()

set(WITH_PULSEAUDIO OFF)

endif()

if(WIN32)

option(WITH_WASAPI "Enable Windows Audio Sessions API for audio support on Windows" ON)

else()

set(WITH_WASAPI OFF)

endif()

# Compression

option(WITH_LZO "Enable fast LZO compression (used for pointcache)" ON)

option(WITH_LZMA "Enable best LZMA compression, (used for pointcache)" ON)

if(UNIX AND NOT APPLE)

option(WITH_SYSTEM_LZO "Use the system LZO library" OFF)

endif()

option(WITH_DRACO "Enable Draco mesh compression Python module (used for glTF)" ON)

# Camera/motion tracking

option(WITH_LIBMV "Enable Libmv structure from motion library" ON)

option(WITH_LIBMV_SCHUR_SPECIALIZATIONS "Enable fixed-size schur specializations." ON)

mark_as_advanced(WITH_LIBMV_SCHUR_SPECIALIZATIONS)

# Logging/unbit test libraries.

option(WITH_SYSTEM_GFLAGS "Use system-wide Gflags instead of a bundled one" OFF)

option(WITH_SYSTEM_GLOG "Use system-wide Glog instead of a bundled one" OFF)

mark_as_advanced(WITH_SYSTEM_GFLAGS)

mark_as_advanced(WITH_SYSTEM_GLOG)

# Freestyle

option(WITH_FREESTYLE "Enable Freestyle (advanced edges rendering)" ON)

# Libraries.

if(UNIX AND NOT APPLE)

# Optionally build without pre-compiled libraries.

# NOTE: this could be supported on all platforms however in practice UNIX is the only platform

# that has good support for detecting installed libraries.

option(WITH_LIBS_PRECOMPILED "\

Detect and link against pre-compiled libraries (typically found under \"../lib/\"). \

Disabling this option will use the system libraries although cached paths \

that point to pre-compiled libraries will be left as-is."

ON

)

mark_as_advanced(WITH_LIBS_PRECOMPILED)

option(WITH_STATIC_LIBS "Try to link with static libraries, as much as possible, to make blender more portable across distributions" OFF)

if(WITH_STATIC_LIBS)

option(WITH_BOOST_ICU "Boost uses ICU library (required for linking with static Boost built with libicu)." OFF)

mark_as_advanced(WITH_BOOST_ICU)

endif()

endif()

# Misc

if(WIN32 OR APPLE)

option(WITH_INPUT_IME "Enable Input Method Editor (IME) for complex Asian character input" ON)

endif()

option(WITH_INPUT_NDOF "Enable NDOF input devices (SpaceNavigator and friends)" ON)

if(UNIX AND NOT APPLE)

option(WITH_INSTALL_PORTABLE "Install redistributable runtime, otherwise install into CMAKE_INSTALL_PREFIX" ON)

endif()

option(WITH_PYTHON_INSTALL "Copy system python into the blender install folder" ON)

if((WITH_AUDASPACE AND NOT WITH_SYSTEM_AUDASPACE) OR WITH_MOD_FLUID)

option(WITH_PYTHON_NUMPY "Include NumPy in Blender (used by Audaspace and Mantaflow)" ON)

endif()

if(WIN32 OR APPLE)

# Windows and macOS have this bundled with Python libraries.

elseif(WITH_PYTHON_INSTALL OR WITH_PYTHON_NUMPY)

set(PYTHON_NUMPY_PATH "" CACHE PATH "Path to python site-packages or dist-packages containing 'numpy' module")

mark_as_advanced(PYTHON_NUMPY_PATH)

set(PYTHON_NUMPY_INCLUDE_DIRS "" CACHE PATH "Path to the include directory of the NumPy module")

mark_as_advanced(PYTHON_NUMPY_INCLUDE_DIRS)

endif()

if(WITH_PYTHON_INSTALL)

option(WITH_PYTHON_INSTALL_NUMPY "Copy system NumPy into the blender install folder" ON)

if(UNIX AND NOT APPLE)

option(WITH_PYTHON_INSTALL_REQUESTS "Copy system requests into the blender install folder" ON)

set(PYTHON_REQUESTS_PATH "" CACHE PATH "Path to python site-packages or dist-packages containing 'requests' module")

mark_as_advanced(PYTHON_REQUESTS_PATH)

endif()

option(WITH_PYTHON_INSTALL_ZSTANDARD "Copy zstandard into the blender install folder" ON)

set(PYTHON_ZSTANDARD_PATH "" CACHE PATH "Path to python site-packages or dist-packages containing 'zstandard' module")

mark_as_advanced(PYTHON_ZSTANDARD_PATH)

endif()

option(WITH_CPU_SIMD "Enable SIMD instruction if they're detected on the host machine" ON)

mark_as_advanced(WITH_CPU_SIMD)

# Cycles

option(WITH_CYCLES "Enable Cycles Render Engine" ON)

option(WITH_CYCLES_OSL "Build Cycles with OpenShadingLanguage support" ON)

option(WITH_CYCLES_PATH_GUIDING "Build Cycles with path guiding support" ON)

option(WITH_CYCLES_EMBREE "Build Cycles with Embree support" ON)

option(WITH_CYCLES_LOGGING "Build Cycles with logging support" ON)

option(WITH_CYCLES_DEBUG "Build Cycles with options useful for debugging (e.g., MIS)" OFF)

option(WITH_CYCLES_STANDALONE "Build Cycles standalone application" OFF)

option(WITH_CYCLES_STANDALONE_GUI "Build Cycles standalone with GUI" OFF)

option(WITH_CYCLES_HYDRA_RENDER_DELEGATE "Build Cycles Hydra render delegate" OFF)

option(WITH_CYCLES_DEBUG_NAN "Build Cycles with additional asserts for detecting NaNs and invalid values" OFF)

option(WITH_CYCLES_NATIVE_ONLY "Build Cycles with native kernel only (which fits current CPU, use for development only)" OFF)

option(WITH_CYCLES_KERNEL_ASAN "Build Cycles kernels with address sanitizer when WITH_COMPILER_ASAN is on, even if it's very slow" OFF)

set(CYCLES_TEST_DEVICES CPU CACHE STRING "Run regression tests on the specified device types (CPU CUDA OPTIX HIP)" )

mark_as_advanced(WITH_CYCLES_KERNEL_ASAN)

mark_as_advanced(WITH_CYCLES_LOGGING)

mark_as_advanced(WITH_CYCLES_DEBUG_NAN)

mark_as_advanced(WITH_CYCLES_NATIVE_ONLY)

# NVIDIA CUDA & OptiX

if(NOT APPLE)

option(WITH_CYCLES_DEVICE_CUDA "Enable Cycles NVIDIA CUDA compute support" ON)

option(WITH_CYCLES_DEVICE_OPTIX "Enable Cycles NVIDIA OptiX support" ON)

mark_as_advanced(WITH_CYCLES_DEVICE_CUDA)

option(WITH_CYCLES_CUDA_BINARIES "Build Cycles NVIDIA CUDA binaries" OFF)

set(CYCLES_CUDA_BINARIES_ARCH sm_30 sm_35 sm_37 sm_50 sm_52 sm_60 sm_61 sm_70 sm_75 sm_86 compute_75 CACHE STRING "CUDA architectures to build binaries for")

option(WITH_CYCLES_CUDA_BUILD_SERIAL "Build cubins one after another (useful on machines with limited RAM)" OFF)

option(WITH_CUDA_DYNLOAD "Dynamically load CUDA libraries at runtime (for developers, makes cuda-gdb work)" ON)

set(OPTIX_ROOT_DIR "" CACHE PATH "Path to the OptiX SDK root directory, for building Cycles OptiX kernels.")

set(CYCLES_RUNTIME_OPTIX_ROOT_DIR "" CACHE PATH "Path to the OptiX SDK root directory. When set, this path will be used at runtime to compile OptiX kernels.")

mark_as_advanced(CYCLES_CUDA_BINARIES_ARCH)

mark_as_advanced(WITH_CYCLES_CUDA_BUILD_SERIAL)

mark_as_advanced(WITH_CUDA_DYNLOAD)

mark_as_advanced(OPTIX_ROOT_DIR)

mark_as_advanced(CYCLES_RUNTIME_OPTIX_ROOT_DIR)

endif()

# AMD HIP

if(NOT APPLE)

option(WITH_CYCLES_DEVICE_HIP "Enable Cycles AMD HIP support" ON)

option(WITH_CYCLES_HIP_BINARIES "Build Cycles AMD HIP binaries" OFF)

set(CYCLES_HIP_BINARIES_ARCH gfx900 gfx906 gfx90c gfx902 gfx1010 gfx1011 gfx1012 gfx1030 gfx1031 gfx1032 gfx1034 gfx1035 gfx1100 gfx1101 gfx1102 CACHE STRING "AMD HIP architectures to build binaries for")

mark_as_advanced(WITH_CYCLES_DEVICE_HIP)

mark_as_advanced(CYCLES_HIP_BINARIES_ARCH)

endif()

# Apple Metal

if(APPLE)

option(WITH_CYCLES_DEVICE_METAL "Enable Cycles Apple Metal compute support" ON)

endif()

# oneAPI

if(NOT APPLE)

option(WITH_CYCLES_DEVICE_ONEAPI "Enable Cycles oneAPI compute support" OFF)

option(WITH_CYCLES_ONEAPI_BINARIES "Enable Ahead-Of-Time compilation for Cycles oneAPI device" OFF)

option(WITH_CYCLES_ONEAPI_HOST_TASK_EXECUTION "Switch target of oneAPI implementation from SYCL devices to Host Task (single thread on CPU). This option is only for debugging purposes." OFF)

# https://www.intel.com/content/www/us/en/develop/documentation/oneapi-dpcpp-cpp-compiler-dev-guide-and-reference/top/compilation/ahead-of-time-compilation.html

# acm-g10 is the target for the first Intel Arc Alchemist GPUs.

set(CYCLES_ONEAPI_SPIR64_GEN_DEVICES "acm-g10" CACHE STRING "oneAPI Intel GPU architectures to build binaries for")

set(CYCLES_ONEAPI_SYCL_TARGETS spir64 spir64_gen CACHE STRING "oneAPI targets to build AOT binaries for")

mark_as_advanced(WITH_CYCLES_ONEAPI_HOST_TASK_EXECUTION)

mark_as_advanced(CYCLES_ONEAPI_SPIR64_GEN_DEVICES)

mark_as_advanced(CYCLES_ONEAPI_SYCL_TARGETS)

endif()

# Draw Manager

option(WITH_DRAW_DEBUG "Add extra debug capabilities to Draw Manager" OFF)

mark_as_advanced(WITH_DRAW_DEBUG)

# LLVM

option(WITH_LLVM "Use LLVM" OFF)

if(APPLE)

option(LLVM_STATIC "Link with LLVM static libraries" ON) # we prefer static llvm build on Apple, dyn build possible though

else()

option(LLVM_STATIC "Link with LLVM static libraries" OFF)

endif()

mark_as_advanced(LLVM_STATIC)

option(WITH_CLANG "Use Clang" OFF)

# disable for now, but plan to support on all platforms eventually

option(WITH_MEM_JEMALLOC "Enable malloc replacement (http://www.canonware.com/jemalloc)" ON)

mark_as_advanced(WITH_MEM_JEMALLOC)

# currently only used for BLI_mempool

option(WITH_MEM_VALGRIND "Enable extended valgrind support for better reporting" OFF)

mark_as_advanced(WITH_MEM_VALGRIND)

# Debug

option(WITH_CXX_GUARDEDALLOC "Enable GuardedAlloc for C++ memory allocation tracking (only enable for development)" OFF)

mark_as_advanced(WITH_CXX_GUARDEDALLOC)

option(WITH_ASSERT_ABORT "Call abort() when raising an assertion through BLI_assert()" ON)

mark_as_advanced(WITH_ASSERT_ABORT)

if((UNIX AND NOT APPLE) OR (CMAKE_GENERATOR MATCHES "^Visual Studio.+"))

option(WITH_CLANG_TIDY "Use Clang Tidy to analyze the source code (only enable for development on Linux using Clang, or Windows using the Visual Studio IDE)" OFF)

mark_as_advanced(WITH_CLANG_TIDY)

endif()

option(WITH_BOOST "Enable features depending on boost" ON)

option(WITH_TBB "Enable multithreading. TBB is also required for features such as Cycles, OpenVDB and USD" ON)

# TBB malloc is only supported on for windows currently

if(WIN32)

option(WITH_TBB_MALLOC_PROXY "Enable the TBB malloc replacement" ON)

endif()

# This should be turned off when Blender enter beta/rc/release

if("${BLENDER_VERSION_CYCLE}" STREQUAL "alpha")

set(WITH_EXPERIMENTAL_FEATURES ON)

else()

set(WITH_EXPERIMENTAL_FEATURES OFF)

endif()

# Unit testing

option(WITH_GTESTS "Enable GTest unit testing" OFF)

option(WITH_OPENGL_RENDER_TESTS "Enable OpenGL render related unit testing (Experimental)" OFF)

option(WITH_OPENGL_DRAW_TESTS "Enable OpenGL UI drawing related unit testing (Experimental)" OFF)

# NOTE: All callers of this must add `TEST_PYTHON_EXE_EXTRA_ARGS` before any other arguments.

set(TEST_PYTHON_EXE "" CACHE PATH "Python executable to run unit tests")

mark_as_advanced(TEST_PYTHON_EXE)

# Documentation

if(UNIX AND NOT APPLE)

option(WITH_DOC_MANPAGE "Create a manual page (Unix manpage)" OFF)

endif()

# OpenGL

option(WITH_OPENGL "When off limits visibility of the opengl headers to just bf_gpu and gawain (temporary option for development purposes)" ON)

option(WITH_GPU_BUILDTIME_SHADER_BUILDER "Shader builder is a developer option enabling linting on GLSL during compilation" OFF)

option(WITH_RENDERDOC "Use Renderdoc API to capture frames" OFF)

mark_as_advanced(

WITH_OPENGL

WITH_GPU_BUILDTIME_SHADER_BUILDER

WITH_RENDERDOC

)

# Vulkan

option(WITH_VULKAN_BACKEND "Enable Vulkan as graphics backend (only for development)" OFF)

option(WITH_VULKAN_GUARDEDALLOC "Use guardedalloc for host allocations done inside Vulkan (development option)" OFF)

mark_as_advanced(

WITH_VULKAN_BACKEND

WITH_VULKAN_GUARDEDALLOC

)

# Metal

if(APPLE)

option(WITH_METAL_BACKEND "Use Metal for graphics instead of (or as well as) OpenGL on macOS." ON)

mark_as_advanced(WITH_METAL_BACKEND)

else()

set(WITH_METAL_BACKEND OFF)

endif()

if(WIN32)

getDefaultWindowsPrefixBase(CMAKE_GENERIC_PROGRAM_FILES)

set(CPACK_INSTALL_PREFIX ${CMAKE_GENERIC_PROGRAM_FILES}/${})

endif()

# Compiler tool-chain.

if(UNIX)

if(CMAKE_COMPILER_IS_GNUCC)

option(WITH_LINKER_GOLD "Use ld.gold linker which is usually faster than ld.bfd" ON)

mark_as_advanced(WITH_LINKER_GOLD)

endif()

if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang")

option(WITH_LINKER_LLD "Use ld.lld linker which is usually faster than ld.gold" OFF)

mark_as_advanced(WITH_LINKER_LLD)

option(WITH_LINKER_MOLD "Use ld.mold linker which is usually faster than ld.gold & ld.lld. Needs \"sold\" subscription on macOS." OFF)

mark_as_advanced(WITH_LINKER_MOLD)

endif()

endif()

option(WITH_COMPILER_ASAN "Build and link against address sanitizer (only for Debug & RelWithDebInfo targets)." OFF)

mark_as_advanced(WITH_COMPILER_ASAN)

if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang")

if(WITH_COMPILER_ASAN)

set(_asan_defaults "\

-fsanitize=address \

-fsanitize=bool \

-fsanitize=bounds \

-fsanitize=enum \

-fsanitize=float-cast-overflow \

-fsanitize=float-divide-by-zero \

-fsanitize=nonnull-attribute \

-fsanitize=returns-nonnull-attribute \

-fsanitize=signed-integer-overflow \

-fsanitize=undefined \

-fsanitize=vla-bound \

-fno-sanitize=alignment \

")

if(MSVC)

# clang-cl doesn't support all sanitizers, but leak and object-size give errors/warnings.

set(_asan_defaults "${_asan_defaults}")

elseif(APPLE)

# AppleClang doesn't support all sanitizers, but leak gives error.

# Build type is not known for multi-config generator, so don't add object-size sanitizer.

if(CMAKE_BUILD_TYPE MATCHES "Debug" OR GENERATOR_IS_MULTI_CONFIG)

# Silence the warning that object-size is not effective in -O0.

set(_asan_defaults "${_asan_defaults}")

else()

string(APPEND _asan_defaults " -fsanitize=object-size")

endif()

elseif(CMAKE_COMPILER_IS_GNUCC)

string(APPEND _asan_defaults " -fsanitize=leak -fsanitize=object-size")

else()

string(APPEND _asan_defaults " -fsanitize=leak")

endif()

set(COMPILER_ASAN_CFLAGS "${_asan_defaults}" CACHE STRING "C flags for address sanitizer")

mark_as_advanced(COMPILER_ASAN_CFLAGS)

set(COMPILER_ASAN_CXXFLAGS "${_asan_defaults}" CACHE STRING "C++ flags for address sanitizer")

mark_as_advanced(COMPILER_ASAN_CXXFLAGS)

unset(_asan_defaults)

if(MSVC)

find_library(

COMPILER_ASAN_LIBRARY NAMES clang_rt.asan-x86_64

PATHS

[HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\LLVM\\LLVM;]/lib/clang/7.0.0/lib/windows

[HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\LLVM\\LLVM;]/lib/clang/6.0.0/lib/windows

)

mark_as_advanced(COMPILER_ASAN_LIBRARY)

elseif(APPLE)

execute_process(COMMAND ${CMAKE_CXX_COMPILER}

-print-file-name=lib

OUTPUT_VARIABLE CLANG_LIB_DIR

)

string(STRIP "${CLANG_LIB_DIR}" CLANG_LIB_DIR)

find_library(

COMPILER_ASAN_LIBRARY

NAMES

libclang_rt.asan_osx_dynamic.dylib

PATHS

"${CLANG_LIB_DIR}/darwin/"

)

unset(CLANG_LIB_DIR)

mark_as_advanced(COMPILER_ASAN_LIBRARY)

elseif(CMAKE_COMPILER_IS_GNUCC)

find_library(

COMPILER_ASAN_LIBRARY asan ${CMAKE_C_IMPLICIT_LINK_DIRECTORIES}

)

mark_as_advanced(COMPILER_ASAN_LIBRARY)

endif()

endif()

endif()

if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang")

option(WITH_COMPILER_SHORT_FILE_MACRO "Make paths in macros like __FILE__ relative to top level source and build directories." ON)

mark_as_advanced(WITH_COMPILER_SHORT_FILE_MACRO)

endif()

if(WIN32)

# Use hardcoded paths or find_package to find externals

option(WITH_WINDOWS_FIND_MODULES "Use find_package to locate libraries" OFF)

mark_as_advanced(WITH_WINDOWS_FIND_MODULES)

option(WINDOWS_PYTHON_DEBUG "Include the files needed for debugging python scripts with visual studio 2017+." OFF)

mark_as_advanced(WINDOWS_PYTHON_DEBUG)

option(WITH_WINDOWS_BUNDLE_CRT "Bundle the C runtime for install free distribution." ON)

mark_as_advanced(WITH_WINDOWS_BUNDLE_CRT)

option(WITH_WINDOWS_SCCACHE "Use sccache to speed up builds (Ninja builder only)" OFF)

mark_as_advanced(WITH_WINDOWS_SCCACHE)

option(WITH_WINDOWS_PDB "Generate a pdb file for client side stacktraces" ON)

mark_as_advanced(WITH_WINDOWS_PDB)

option(WITH_WINDOWS_STRIPPED_PDB "Use a stripped PDB file" ON)

mark_as_advanced(WITH_WINDOWS_STRIPPED_PDB)

endif()

if(WIN32 OR XCODE)

option(IDE_GROUP_SOURCES_IN_FOLDERS "Organize the source files in filters matching the source folders." ON)

mark_as_advanced(IDE_GROUP_SOURCES_IN_FOLDERS)

option(IDE_GROUP_PROJECTS_IN_FOLDERS "Organize the projects according to source folder structure." ON)

mark_as_advanced(IDE_GROUP_PROJECTS_IN_FOLDERS)

if(IDE_GROUP_PROJECTS_IN_FOLDERS)

set_property(GLOBAL PROPERTY USE_FOLDERS ON)

endif()

endif()

if(UNIX)

# See WITH_WINDOWS_SCCACHE for Windows.

option(WITH_COMPILER_CCACHE "Use ccache to improve rebuild times (Works with Ninja, Makefiles and Xcode)" OFF)

mark_as_advanced(WITH_COMPILER_CCACHE)

endif()

# The following only works with the Ninja generator in CMake >= 3.0.

if("${CMAKE_GENERATOR}" MATCHES "Ninja")

option(WITH_NINJA_POOL_JOBS

"Enable Ninja pools of jobs, to try to ease building on machines with 16GB of RAM or less (if not yet defined, will try to set best values based on detected machine specifications)."

OFF)

mark_as_advanced(WITH_NINJA_POOL_JOBS)

endif()

# Installation process.

set(POSTINSTALL_SCRIPT "" CACHE FILEPATH "Run given CMake script after installation process")

mark_as_advanced(POSTINSTALL_SCRIPT)

set(POSTCONFIGURE_SCRIPT "" CACHE FILEPATH "Run given CMake script as the last step of CMake configuration")

mark_as_advanced(POSTCONFIGURE_SCRIPT)

# end option(...)

# By default we want to install to the directory we are compiling our executables

# unless specified otherwise, which we currently do not allow

if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)

if(WIN32)

set(CMAKE_INSTALL_PREFIX ${EXECUTABLE_OUTPUT_PATH}/\${BUILD_TYPE} CACHE PATH "default install path" FORCE)

elseif(APPLE)

set(CMAKE_INSTALL_PREFIX ${EXECUTABLE_OUTPUT_PATH}/\${BUILD_TYPE} CACHE PATH "default install path" FORCE)

else()

if(WITH_INSTALL_PORTABLE)

set(CMAKE_INSTALL_PREFIX ${EXECUTABLE_OUTPUT_PATH} CACHE PATH "default install path" FORCE)

endif()

endif()

endif()

# Effective install path including config folder, as a generator expression.

get_property(GENERATOR_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)

if(GENERATOR_IS_MULTI_CONFIG)

string(REPLACE "\${BUILD_TYPE}" "$<CONFIG>" CMAKE_INSTALL_PREFIX_WITH_CONFIG ${CMAKE_INSTALL_PREFIX})

else()

string(REPLACE "\${BUILD_TYPE}" "" CMAKE_INSTALL_PREFIX_WITH_CONFIG ${CMAKE_INSTALL_PREFIX})

endif()

# Apple

if(APPLE)

include(platform_apple_xcode)

endif()

# -----------------------------------------------------------------------------

# Check for Conflicting/Unsupported Configurations

option(WITH_STRICT_BUILD_OPTIONS "When requirements for a build option are not met, error instead of disabling the option" OFF)

if(NOT WITH_BLENDER AND NOT WITH_CYCLES_STANDALONE AND NOT WITH_CYCLES_HYDRA_RENDER_DELEGATE)

message(FATAL_ERROR

"At least one of WITH_BLENDER or WITH_CYCLES_STANDALONE "

"or WITH_CYCLES_HYDRA_RENDER_DELEGATE "

"must be enabled, nothing to do!"

)

endif()

set_and_warn_dependency(WITH_AUDASPACE WITH_OPENAL OFF)

set_and_warn_dependency(WITH_AUDASPACE WITH_COREAUDIO OFF)

set_and_warn_dependency(WITH_AUDASPACE WITH_JACK OFF)

set_and_warn_dependency(WITH_AUDASPACE WITH_PULSEAUDIO OFF)

set_and_warn_dependency(WITH_AUDASPACE WITH_WASAPI OFF)

if(NOT WITH_SDL AND WITH_GHOST_SDL)

message(FATAL_ERROR "WITH_GHOST_SDL requires WITH_SDL")

endif()

# python module, needs some different options

if(WITH_PYTHON_MODULE AND WITH_PYTHON_INSTALL)

message(FATAL_ERROR "WITH_PYTHON_MODULE requires WITH_PYTHON_INSTALL to be OFF")

endif()

set_and_warn_dependency(WITH_PYTHON WITH_CYCLES OFF)

set_and_warn_dependency(WITH_PYTHON WITH_DRACO OFF)

set_and_warn_dependency(WITH_PYTHON WITH_MOD_FLUID OFF)

if(WITH_DRACO AND NOT WITH_PYTHON_INSTALL)

message(STATUS "WITH_DRACO requires WITH_PYTHON_INSTALL to be ON, disabling WITH_DRACO for now")

set(WITH_DRACO OFF)

endif()

# enable boost for cycles, audaspace or i18n

# otherwise if the user disabled

set_and_warn_dependency(WITH_BOOST WITH_INTERNATIONAL OFF)

set_and_warn_dependency(WITH_BOOST WITH_OPENVDB OFF)

set_and_warn_dependency(WITH_BOOST WITH_QUADRIFLOW OFF)

set_and_warn_dependency(WITH_BOOST WITH_USD OFF)

if(WITH_CYCLES)

set_and_warn_dependency(WITH_BOOST WITH_CYCLES_OSL OFF)

set_and_warn_dependency(WITH_PUGIXML WITH_CYCLES_OSL OFF)

endif()

set_and_warn_dependency(WITH_TBB WITH_CYCLES OFF)

set_and_warn_dependency(WITH_TBB WITH_USD OFF)

set_and_warn_dependency(WITH_TBB WITH_OPENVDB OFF)

set_and_warn_dependency(WITH_TBB WITH_MOD_FLUID OFF)

# NanoVDB requires OpenVDB to convert the data structure

set_and_warn_dependency(WITH_OPENVDB WITH_NANOVDB OFF)

# OpenVDB, Alembic and Vulkan, OSL uses 'half' or 'imath' from OpenEXR

set_and_warn_dependency(WITH_IMAGE_OPENEXR WITH_OPENVDB OFF)

set_and_warn_dependency(WITH_IMAGE_OPENEXR WITH_ALEMBIC OFF)

set_and_warn_dependency(WITH_IMAGE_OPENEXR WITH_VULKAN_BACKEND OFF)

set_and_warn_dependency(WITH_IMAGE_OPENEXR WITH_CYCLES_OSL OFF)

# auto enable openimageio for cycles

if(WITH_CYCLES)

# auto enable llvm for cycles_osl

if(WITH_CYCLES_OSL)

set(WITH_LLVM ON CACHE BOOL "" FORCE)

set(WITH_CLANG ON CACHE BOOL "" FORCE)

endif()

else()

set(WITH_CYCLES_OSL OFF)

endif()

# don't store paths to libs for portable distribution

if(WITH_INSTALL_PORTABLE)

set(CMAKE_SKIP_BUILD_RPATH TRUE)

endif()

if(WITH_GHOST_SDL OR WITH_HEADLESS)

message(STATUS "Disabling Ghost Wayland, X11, Input IME, and OpenXR")

set(WITH_GHOST_WAYLAND OFF)

set(WITH_GHOST_X11 OFF)

set(WITH_X11_XINPUT OFF)

set(WITH_X11_XF86VMODE OFF)

set(WITH_X11_XFIXES OFF)

set(WITH_GHOST_XDND OFF)

set(WITH_INPUT_IME OFF)

set(WITH_XR_OPENXR OFF)

endif()

if(WITH_BUILDINFO)

find_package(Git)

set_and_warn_library_found("Git" GIT_FOUND WITH_BUILDINFO)

endif()

if(WITH_AUDASPACE)

if(NOT WITH_SYSTEM_AUDASPACE)

set(AUDASPACE_C_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/extern/audaspace/bindings/C" "${CMAKE_BINARY_DIR}/extern/audaspace")

set(AUDASPACE_PY_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/extern/audaspace/bindings")

endif()

endif()

# Auto-enable CUDA dynload if toolkit is not found.

if(WITH_CYCLES AND WITH_CYCLES_DEVICE_CUDA AND NOT WITH_CUDA_DYNLOAD)

find_package(CUDA)

if(NOT CUDA_FOUND)

message(

STATUS

"CUDA toolkit not found, "

"using dynamic runtime loading of libraries (WITH_CUDA_DYNLOAD) instead"

)

set(WITH_CUDA_DYNLOAD ON)

endif()

endif()

if(WITH_CYCLES_DEVICE_HIP)

# Currently HIP must be dynamically loaded, this may change in future toolkits

set(WITH_HIP_DYNLOAD ON)

endif()

# -----------------------------------------------------------------------------

# Check if Sub-modules are Cloned

if(WITH_PYTHON)

# While we have this as an '#error' in 'bpy_capi_utils.h',

# upgrading Python tends to cause confusion for users who build.

# Give the error message early to make this more obvious.

#

# Do this before main 'platform_*' checks,

# because UNIX will search for the old Python paths which may not exist.

# giving errors about missing paths before this case is met.

if(DEFINED PYTHON_VERSION AND "${PYTHON_VERSION}" VERSION_LESS "3.10")

message(

FATAL_ERROR

"At least Python 3.10 is required to build, but found Python ${PYTHON_VERSION}"

)

endif()

file(GLOB RESULT "${CMAKE_SOURCE_DIR}/scripts/addons")

list(LENGTH RESULT DIR_LEN)

if(DIR_LEN EQUAL 0)

message(

WARNING

"Addons path '${CMAKE_SOURCE_DIR}/scripts/addons' is missing. "

"This is an external repository which needs to be checked out. Use `make update` to do so. "

"* CONTINUING WITHOUT ADDONS *"

)

endif()

endif()

# -----------------------------------------------------------------------------

# InitialIze Un-cached Vars, Avoid Unused Warning

# linux only, not cached

set(WITH_BINRELOC OFF)

# MACOSX only, set to avoid uninitialized

set(EXETYPE "")

# C/C++ flags

set(PLATFORM_CFLAGS)

# these are added to later on.

set(C_WARNINGS)

set(CXX_WARNINGS)