Document behavior change in how bundles drivers are used
authorCharles Giessen <charles@lunarg.com>
Tue, 6 Dec 2022 21:13:18 +0000 (14:13 -0700)
committerCharles Giessen <46324611+charles-lunarg@users.noreply.github.com>
Mon, 9 Jan 2023 23:25:53 +0000 (16:25 -0700)
Document that a bundled driver on macOS will cause the loader to ignore drivers
in system installed locations.

docs/LoaderDriverInterface.md

index 821f1d58be7b8bc35904e2de5f19c789d183fd33..8c6f7b0ac955344665e49036215df740eb78d5ab 100644 (file)
@@ -506,6 +506,17 @@ The order is similar to the search path on Linux with the exception that
 the application's bundle resources are searched first:
 `(bundle)/Contents/Resources/`.
 
+System installed drivers will be ignored if drivers are found inside of the app
+bundle.
+This is because there is not a standard mechanism in which to distinguish drivers
+that happen to be duplicates.
+For example, MoltenVK is commonly placed inside application bundles.
+If there exists a system installed MoltenVK, the loader will load both the app
+bundled and the system installed MoltenVK, leading to potential issues or crashes.
+Drivers found through environment variables, such as `VK_DRIVER_FILES`, will be
+used regardless of whether there are bundled drivers present or not.
+
+
 #### Example macOS Driver Search Path
 
 For a fictional user "Me" the Driver Manifest search path might look