Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update instructions for Vulkan + macOS. #5693

Merged
merged 1 commit into from
Jun 15, 2022
Merged

Update instructions for Vulkan + macOS. #5693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Comment on lines +147 to +149
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not actually needed for building correct? it's just to be able to run the apps.

Maybe this should be (or also be) in filament/README.md, where it has this section like:

To use the Vulkan backend on macOS you must also make the following libraries available at runtime:

Maybe the informations contained in both places should be consolidated and copied (or referenced) in both places?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I updated filament/README.md. I think duplication is fine here, asking the reader to "refer to" another section isn't as friendly as repeating the info.

Then run `cmake` and `ninja` to trigger a build:

```
Expand Down
6 changes: 2 additions & 4 deletions filament/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 2 additions & 7 deletions filament/docs/Debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
```
Expand Down