Possibly incorrect build instructions for macOS

[lccatala]

⚠️ Issues not using this template will be systematically closed.

Describe the bug
Current macOS build instructions don't fully address C++ header resolution issues that can occur with different Xcode/CommandLineTools setups.

To Reproduce
Steps to reproduce the behavior:

1. Clone the repository git clone https://github.com/google/filament/
2. cd filament
3. mkdir -p out/cmake-release
4. cd out/cmake-release
5. cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../release/filament ../..
6. ninja

Expected behavior
The project builds correctly

Screenshots
Not necessary

Logs
[1/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/CountDownLatch.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/CountDownLatch.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/CountDownLatch.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/CountDownLatch.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/CountDownLatch.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/CountDownLatch.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/CountDownLatch.cpp:17: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/CountDownLatch.h:21: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/Condition.h:23: /Users/lcatala/Projects/filament/libs/utils/include/utils/generic/Condition.h:20:10: fatal error: 'condition_variable' file not found 20 | #include <condition_variable> | ^~~~~~~~~~~~~~~~~~~~ 1 error generated. [2/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/CyclicBarrier.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/CyclicBarrier.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/CyclicBarrier.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/CyclicBarrier.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/CyclicBarrier.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/CyclicBarrier.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/CyclicBarrier.cpp:17: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/CyclicBarrier.h:23: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/Condition.h:23: /Users/lcatala/Projects/filament/libs/utils/include/utils/generic/Condition.h:20:10: fatal error: 'condition_variable' file not found 20 | #include <condition_variable> | ^~~~~~~~~~~~~~~~~~~~ 1 error generated. [3/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/CString.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/CString.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/CString.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/CString.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/CString.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/CString.cpp /Users/lcatala/Projects/filament/libs/utils/src/CString.cpp:21:10: fatal error: 'algorithm' file not found 21 | #include <algorithm> | ^~~~~~~~~~~ 1 error generated. [4/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/ashmem.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/ashmem.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/ashmem.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/ashmem.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/ashmem.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/ashmem.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/ashmem.cpp:24: /Users/lcatala/Projects/filament/libs/utils/include/utils/Path.h:22:10: fatal error: 'iosfwd' file not found 22 | #include <iosfwd> | ^~~~~~~~ 1 error generated. [5/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/debug.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/debug.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/debug.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/debug.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/debug.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/debug.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/debug.cpp:19: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/Panic.h:29: /Users/lcatala/Projects/filament/libs/utils/include/utils/CallStack.h:22:10: fatal error: 'typeinfo' file not found 22 | #include <typeinfo> | ^~~~~~~~~~ 1 error generated. [6/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/Log.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/Log.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/Log.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/Log.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/Log.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/Log.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/Log.cpp:17: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/Log.h:21: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/ostream.h:20: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/bitset.h:20: /Users/lcatala/Projects/filament/libs/utils/include/utils/algorithm.h:22:10: fatal error: 'type_traits' file not found 22 | #include <type_traits> // for std::enable_if | ^~~~~~~~~~~~~ 1 error generated. [7/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/EntityManager.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/EntityManager.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/EntityManager.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/EntityManager.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/EntityManager.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/EntityManager.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/EntityManager.cpp:19: In file included from /Users/lcatala/Projects/filament/libs/utils/src/EntityManagerImpl.h:24: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/Mutex.h:23: /Users/lcatala/Projects/filament/libs/utils/include/utils/generic/Mutex.h:20:10: fatal error: 'mutex' file not found 20 | #include <mutex> | ^~~~~~~ 1 error generated. [8/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/Allocator.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/Allocator.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/Allocator.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/Allocator.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/Allocator.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/Allocator.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/Allocator.cpp:17: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/Allocator.h:22: /Users/lcatala/Projects/filament/libs/utils/include/utils/memalign.h:20:10: fatal error: 'type_traits' file not found 20 | #include <type_traits> | ^~~~~~~~~~~~~ 1 error generated. [9/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/CallStack.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/CallStack.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/CallStack.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/CallStack.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/CallStack.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/CallStack.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/CallStack.cpp:17: /Users/lcatala/Projects/filament/libs/utils/include/utils/CallStack.h:22:10: fatal error: 'typeinfo' file not found 22 | #include <typeinfo> | ^~~~~~~~~~ 1 error generated. [10/1440] Building CXX object libs/utils/CMakeFiles/utils.dir/src/JobSystem.cpp.o FAILED: libs/utils/CMakeFiles/utils.dir/src/JobSystem.cpp.o /Library/Developer/CommandLineTools/usr/bin/c++ -DFILAMENT_DRIVER_SUPPORTS_VULKAN -DFILAMENT_SUPPORTS_METAL -DFILAMENT_SUPPORTS_OPENGL -I/Users/lcatala/Projects/filament/libs/utils/include -I/Users/lcatala/Projects/filament/third_party/robin-map/tnt/.. -std=c++17 -fstrict-aliasing -Wno-unknown-pragmas -Wno-unused-function -Wno-deprecated-declarations -fcolor-diagnostics -fvisibility=hidden -O3 -DNDEBUG -fomit-frame-pointer -ffunction-sections -fdata-sections -fno-stack-check -arch arm64 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk -mmacosx-version-min=10.15 -MD -MT libs/utils/CMakeFiles/utils.dir/src/JobSystem.cpp.o -MF libs/utils/CMakeFiles/utils.dir/src/JobSystem.cpp.o.d -o libs/utils/CMakeFiles/utils.dir/src/JobSystem.cpp.o -c /Users/lcatala/Projects/filament/libs/utils/src/JobSystem.cpp In file included from /Users/lcatala/Projects/filament/libs/utils/src/JobSystem.cpp:26: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/JobSystem.h:20: In file included from /Users/lcatala/Projects/filament/libs/utils/include/utils/Allocator.h:22: /Users/lcatala/Projects/filament/libs/utils/include/utils/memalign.h:20:10: fatal error: 'type_traits' file not found 20 | #include <type_traits> | ^~~~~~~~~~~~~ 1 error generated. ninja: build stopped: subcommand failed.

Desktop (please complete the following information):

• OS: macOS Sonoma with Xcode Command Line Tools 15.2
• GPU: M2 chip
• Backend: Metal

Smartphone (please complete the following information):

• Device: N/A
• OS: N/A

Additional context
I found specifying the compiler, headers and SDK paths in the cmake command fixes it
cmake -G Ninja \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=../release/filament \ -DCMAKE_CXX_FLAGS="-stdlib=libc++ -I/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include -I/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/c++/v1" \ -DCMAKE_OSX_SYSROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk \ -DCMAKE_CXX_COMPILER=/Library/Developer/CommandLineTools/usr/bin/clang++ \ ../..
I'm not sure if I should create a PR updating this or if nobody else has found the same problem, thus being a problem with only my machine.

[show50726]

I just ran the same commands on my mac and I didn't encounter this problem.

One thing I found it strange is in the build commands you provided, sysroot seems to point to the CLT toolchain instead of Xcode toolchain:

-isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX15.2.sdk

We expect the users have the most recent Xcode version installed, could you check if your Xcode is installed and setup correctly? And then run xcode-select -p to make sure the current toolchain is something like /Applications/Xcode.app/Contents/Developer/...

[lccatala]

My bad then, I understood you only needed to have the command line tools installed. Sorry for the inconvenience!