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

# Copyright 2006 Blender Foundation. All rights reserved.

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

# 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)

# Prefer LEGACY OpenGL to be compatible with all the existing releases and

# platforms which don't have GLVND yet. Only do it if preference was not set

# externally.

if(NOT DEFINED OpenGL_GL_PREFERENCE)

set(OpenGL_GL_PREFERENCE "LEGACY")

endif()

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 empty buildtype

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 some macros.

include(build_files/cmake/macros.cmake)

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

# Initialize project.

blender_project_hack_pre()

project(Blender)

blender_project_hack_post()

enable_testing()

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

# 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 config options

get_blender_version()

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

# Options

# Blender internal features

option(WITH_BLENDER "Build blender (disable to build only the blender player)" ON)

mark_as_advanced(WITH_BLENDER)

if(APPLE)

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

# thumbnails for say Finder. Turn it off for now.

option(WITH_BLENDER_THUMBNAILER "Build \"blender-thumbnailer\" thumbnail extraction utility" OFF)

elseif(WIN32)

option(WITH_BLENDER_THUMBNAILER "Build \"BlendThumb.dll\" helper for Windows explorer integration" ON)

else()

option(WITH_BLENDER_THUMBNAILER "Build \"blender-thumbnailer\" thumbnail extraction utility" ON)

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)

mark_as_advanced(WITH_PYTHON) # don't want people disabling this unless they really know what they are doing.

mark_as_advanced(WITH_PYTHON_SECURITY) # some distributions see this as a security issue, rather than have them patch it, make a build option.

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)

if(APPLE)

option(WITH_PYTHON_FRAMEWORK "Enable building using the Python available in the framework (OSX only)" OFF)

endif()

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)

if(APPLE)

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

# tested there -> disable it by default.

option(WITH_XR_OPENXR "Enable VR features through the OpenXR specification" OFF)

mark_as_advanced(WITH_XR_OPENXR)

else()

option(WITH_XR_OPENXR "Enable VR features through the OpenXR specification" ON)

endif()

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

# Compositor

option(WITH_COMPOSITOR "Enable the tile based 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 (under development)" OFF)

mark_as_advanced(WITH_GHOST_WAYLAND)

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)

option(WITH_X11_ALPHA "Enable X11 transparent background" ON)

endif()

if(UNIX AND NOT APPLE)

option(WITH_SYSTEM_GLEW "Use GLEW OpenGL wrapper library provided by the operating system" OFF)

option(WITH_SYSTEM_GLES "Use OpenGL ES library provided by the operating system" ON)

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

else()

# not an option for other OS's

set(WITH_SYSTEM_GLEW OFF)

set(WITH_SYSTEM_GLES OFF)

set(WITH_SYSTEM_FREETYPE OFF)

endif()

if(UNIX AND NOT APPLE)

option(WITH_SYSTEM_EIGEN3 "Use the systems Eigen3 library" 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_OPENIMAGEIO "Enable OpenImageIO Support (http://www.openimageio.org)" ON)

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_TIFF "Enable LibTIFF Support" ON)

option(WITH_IMAGE_DDS "Enable DDS Image Support" ON)

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

option(WITH_IMAGE_HDR "Enable HDR 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)

# 3D format support

# Disable opencollada when we don't have precompiled libs

option(WITH_OPENCOLLADA "Enable OpenCollada Support (http://www.opencollada.org)" 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)

option(WITH_JACK "Enable JACK Support (http://www.jackaudio.org)" ON)

if(UNIX AND NOT APPLE)

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

endif()

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)

# 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 redistributeable runtime, otherwise install into CMAKE_INSTALL_PREFIX" ON)

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()

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_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_CUBIN_COMPILER "Build cubins with nvrtc based compiler instead of nvcc" OFF)

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)

mark_as_advanced(CYCLES_CUDA_BINARIES_ARCH)

mark_as_advanced(WITH_CYCLES_CUBIN_COMPILER)

mark_as_advanced(WITH_CYCLES_CUDA_BUILD_SERIAL)

mark_as_advanced(WITH_CUDA_DYNLOAD)

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 gfx1010 gfx1011 gfx1012 gfx1030 gfx1031 gfx1032 gfx1034 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()

# 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)

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_GLEW_ES "Switches to experimental copy of GLEW that has support for OpenGL ES. (temporary option for development purposes)" OFF)

option(WITH_GL_EGL "Use the EGL OpenGL system library instead of the platform specific OpenGL system library (CGL, glX, or WGL)" OFF)

option(WITH_GL_PROFILE_ES20 "Support using OpenGL ES 2.0. (through either EGL or the AGL/WGL/XGL 'es20' profile)" OFF)

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

mark_as_advanced(

WITH_OPENGL

WITH_GLEW_ES

WITH_GL_EGL

WITH_GL_PROFILE_ES20

WITH_GPU_SHADER_BUILDER

)

# Metal

if (APPLE)

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

mark_as_advanced(WITH_METAL_BACKEND)

else()

set(WITH_METAL_BACKEND OFF)

endif()

if (WITH_METAL_BACKEND)

set(CMAKE_OSX_DEPLOYMENT_TARGET "10.15" CACHE STRING "Minimum OS X deployment version" FORCE)

endif()

if(WIN32)

option(WITH_GL_ANGLE "Link with the ANGLE library, an OpenGL ES 2.0 implementation based on Direct3D, instead of the system OpenGL library." OFF)

mark_as_advanced(WITH_GL_ANGLE)

endif()

if(WITH_GLEW_ES AND WITH_SYSTEM_GLEW)

message(WARNING Ignoring WITH_SYSTEM_GLEW and using WITH_GLEW_ES)

set(WITH_SYSTEM_GLEW OFF)

endif()

if(WIN32)

getDefaultWindowsPrefixBase(CMAKE_GENERIC_PROGRAM_FILES)

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

endif()

# Compiler tool-chain.

if(UNIX AND NOT APPLE)

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)

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

mark_as_advanced(WITH_LINKER_LLD)

endif()

if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang")

option(WITH_LINKER_MOLD "Use ld.mold linker which is usually faster than ld.gold & ld.lld." 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()

else()

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

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

)

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)

else()

find_library(

COMPILER_ASAN_LIBRARY asan ${CMAKE_C_IMPLICIT_LINK_DIRECTORIES}

)

endif()

mark_as_advanced(COMPILER_ASAN_LIBRARY)

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()

if(UNIX AND NOT APPLE)

option(WITH_CXX11_ABI "Use native C++11 ABI of compiler" ON)

mark_as_advanced(WITH_CXX11_ABI)

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()

# Apple

if(APPLE)

include(platform_apple_xcode)

endif()

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

# Check for conflicting/unsupported configurations

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)

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_CYCLES OFF)

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_OPENCOLORIO OFF)

set_and_warn_dependency(WITH_BOOST WITH_QUADRIFLOW OFF)

set_and_warn_dependency(WITH_BOOST WITH_USD OFF)

set_and_warn_dependency(WITH_BOOST WITH_ALEMBIC OFF)

if(WITH_CYCLES)

set_and_warn_dependency(WITH_PUGIXML WITH_CYCLES_OSL OFF)

endif()

set_and_warn_dependency(WITH_PUGIXML WITH_OPENIMAGEIO OFF)

if(WITH_BOOST AND NOT (WITH_CYCLES OR WITH_OPENIMAGEIO OR WITH_INTERNATIONAL OR

WITH_OPENVDB OR WITH_OPENCOLORIO OR WITH_USD OR WITH_ALEMBIC))

message(STATUS "No dependencies need 'WITH_BOOST' forcing WITH_BOOST=OFF")

set(WITH_BOOST 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_OPENIMAGEDENOISE 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 and OpenColorIO uses 'half' type from OpenEXR

set_and_warn_dependency(WITH_IMAGE_OPENEXR WITH_OPENVDB OFF)

set_and_warn_dependency(WITH_IMAGE_OPENEXR WITH_OPENCOLORIO OFF)

# Haru needs `TIFFFaxBlackCodes` & `TIFFFaxWhiteCodes` symbols from TIFF.

set_and_warn_dependency(WITH_IMAGE_TIFF WITH_HARU OFF)

# USD needs OpenSubDiv, since that is used by the Cycles Hydra render delegate.

set_and_warn_dependency(WITH_OPENSUBDIV WITH_USD OFF)

# auto enable openimageio for cycles

if(WITH_CYCLES)

set(WITH_OPENIMAGEIO ON)

# 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()

# auto enable openimageio linking dependencies

if(WITH_OPENIMAGEIO)

set(WITH_IMAGE_OPENEXR ON)

set(WITH_IMAGE_TIFF ON)

endif()

# auto enable alembic linking dependencies

if(WITH_ALEMBIC)

set(WITH_IMAGE_OPENEXR ON)

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_X11_ALPHA OFF)

set(WITH_GHOST_XDND OFF)

set(WITH_INPUT_IME OFF)

set(WITH_XR_OPENXR OFF)

endif()

if(WITH_BUILDINFO)

find_package(Git)

if(NOT GIT_FOUND)

message(WARNING "Git was not found, disabling WITH_BUILDINFO")

set(WITH_BUILDINFO OFF)

endif()

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 submodules are cloned.

if(WITH_INTERNATIONAL)

file(GLOB RESULT "${CMAKE_SOURCE_DIR}/release/datafiles/locale")

list(LENGTH RESULT DIR_LEN)

if(DIR_LEN EQUAL 0)

message(WARNING

"Translation path '${CMAKE_SOURCE_DIR}/release/datafiles/locale' is missing, "

"This is a 'git submodule', which are known not to work with bridges to other version "

"control systems, disabling 'WITH_INTERNATIONAL'."

)

set(WITH_INTERNATIONAL OFF)

endif()

endif()

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}/release/scripts/addons")

list(LENGTH RESULT DIR_LEN)

if(DIR_LEN EQUAL 0)

message(WARNING

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

"This is a 'git submodule', which are known not to work with bridges to other version "

"control systems: * 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)

# NOTE: These flags are intended for situations where where it's impractical to

# suppress warnings by modifying the code or for code which is maintained externally.

# For GCC this typically means adding `-Wno-*` arguments to negate warnings

# that are useful in the general case.

set(C_REMOVE_STRICT_FLAGS)

set(CXX_REMOVE_STRICT_FLAGS)

# Libraries to link to targets in setup_platform_linker_libs

set(PLATFORM_LINKLIBS "")

# Added to target linker flags in setup_platform_linker_flags

# - CMAKE_EXE_LINKER_FLAGS

# - CMAKE_EXE_LINKER_FLAGS_DEBUG

set(PLATFORM_LINKFLAGS "")

set(PLATFORM_LINKFLAGS_DEBUG "")

if(NOT CMAKE_BUILD_TYPE MATCHES "Release")

if(WITH_COMPILER_ASAN)

if(NOT APPLE)

# Avoid passing address sanitizer compiler flags to `try_compile`.

# Since linker flags are not set, all compiler checks and `find_package`

# calls that rely on `try_compile` will fail.

# See CMP0066 also.

string(APPEND CMAKE_C_FLAGS_DEBUG " ${COMPILER_ASAN_CFLAGS}")

string(APPEND CMAKE_C_FLAGS_RELWITHDEBINFO " ${COMPILER_ASAN_CFLAGS}")

string(APPEND CMAKE_CXX_FLAGS_DEBUG " ${COMPILER_ASAN_CXXFLAGS}")

string(APPEND CMAKE_CXX_FLAGS_RELWITHDEBINFO " ${COMPILER_ASAN_CXXFLAGS}")

endif()

if(MSVC)

set(COMPILER_ASAN_LINKER_FLAGS "/FUNCTIONPADMIN:6")

endif()

if(APPLE AND COMPILER_ASAN_LIBRARY)

string(REPLACE " " ";" _list_COMPILER_ASAN_CFLAGS ${COMPILER_ASAN_CFLAGS})

set(_is_CONFIG_DEBUG "$<OR:$<CONFIG:Debug>,$<CONFIG:RelWithDebInfo>>")

add_compile_options("$<${_is_CONFIG_DEBUG}:${_list_COMPILER_ASAN_CFLAGS}>")

add_link_options("$<${_is_CONFIG_DEBUG}:-fno-omit-frame-pointer;-fsanitize=address>")

unset(_list_COMPILER_ASAN_CFLAGS)

unset(_is_CONFIG_DEBUG)

elseif(COMPILER_ASAN_LIBRARY)

set(PLATFORM_LINKLIBS "${PLATFORM_LINKLIBS};${COMPILER_ASAN_LIBRARY}")

set(PLATFORM_LINKFLAGS "${COMPILER_ASAN_LIBRARY} ${COMPILER_ASAN_LINKER_FLAGS}")

set(PLATFORM_LINKFLAGS_DEBUG "${COMPILER_ASAN_LIBRARY} ${COMPILER_ASAN_LINKER_FLAGS}")

endif()

endif()

endif()

# Test SIMD support, before platform includes to determine if sse2neon is needed.

if(WITH_CPU_SIMD)

set(COMPILER_SSE_FLAG)

set(COMPILER_SSE2_FLAG)

# Test Neon first since macOS Arm can compile and run x86-64 SSE binaries.

TEST_NEON_SUPPORT()

if(NOT SUPPORT_NEON_BUILD)

TEST_SSE_SUPPORT(COMPILER_SSE_FLAG COMPILER_SSE2_FLAG)

endif()

endif()

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