From cce69ec2d394468a4a6fff25703becc1e619b4e8 Mon Sep 17 00:00:00 2001 From: Philip Rideout Date: Tue, 14 Jun 2022 16:23:34 -0700 Subject: [PATCH] Update instructions for Vulkan + macOS. --- BUILDING.md | 3 +++ filament/README.md | 6 ++---- filament/docs/Debugging.md | 9 ++------- 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index c9baa9ac485..fb73b5cddcc 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -144,6 +144,9 @@ make sure the command line tools are setup by running: $ xcode-select --install ``` +If you wish to run the Vulkan backend instead of the default Metal backend, you must install +the LunarG SDK, enable "System Global Components", and reboot your machine. + Then run `cmake` and `ninja` to trigger a build: ``` diff --git a/filament/README.md b/filament/README.md index 961b7a9e218..1560c96135e 100644 --- a/filament/README.md +++ b/filament/README.md @@ -44,10 +44,8 @@ To link against debug builds of Filament, you must also link against: - `matdbg`, Support library that adds an interactive web-based debugger to Filament -To use the Vulkan backend on macOS you must also make the following libraries available at runtime: -- `MoltenVK_icd.json` -- `libMoltenVK.dylib` -- `libvulkan.1.dylib` +To use the Vulkan backend on macOS you must install the LunarG SDK, enable "System Global +Components", and reboot your machine. The easiest way to install those files is to use the macOS [LunarG Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) installer. diff --git a/filament/docs/Debugging.md b/filament/docs/Debugging.md index d0c7ffe500b..a29f175874f 100644 --- a/filament/docs/Debugging.md +++ b/filament/docs/Debugging.md @@ -1,19 +1,14 @@ # Filament Debugging -## Debugging Vulkan on macOS - -Install the LunarG SDK and allow the installer to include "System Global Components", which should -be enabled by default. - ## Debugging Vulkan on Linux ### Enable Validation Logs Simply install the LunarG SDK (it's fast and easy), then make sure you've got the following -environment variables set up in your **bashrc** file: +environment variables set up in your **bashrc** file. For example: ``` -export VULKAN_SDK='/usr/local/google/home/MY_LDAP/VulkanSDK/1.1.70.1/x86_64' +export VULKAN_SDK='/path_to_home/VulkanSDK/1.3.216.0/x86_64' export VK_LAYER_PATH="$VULKAN_SDK/etc/explicit_layer.d" export PATH="$VULKAN_SDK/bin:$PATH" ```