diff options
author | Mark Young <marky@lunarg.com> | 2022-09-07 21:57:35 +0300 |
---|---|---|
committer | Charles Giessen <46324611+charles-lunarg@users.noreply.github.com> | 2022-11-04 23:08:39 +0300 |
commit | ff2805803d88e778d745d89b0718cb7f294b6917 (patch) | |
tree | 2e7846859be1b2f77a8f4254a9fde2daade7584b | |
parent | b16ed71dfdbac075555a5715da9b7e3e929cc5aa (diff) |
Put placeholder for loader version
TODO: Replace all 1.3.yyyy with appropriate header version after
approval.
-rw-r--r-- | docs/LoaderDebugging.md | 12 | ||||
-rw-r--r-- | docs/LoaderDriverInterface.md | 3 | ||||
-rw-r--r-- | docs/LoaderInterfaceArchitecture.md | 9 | ||||
-rw-r--r-- | docs/LoaderLayerInterface.md | 3 | ||||
-rw-r--r-- | loader/vk_loader_platform.h | 2 |
5 files changed, 27 insertions, 2 deletions
diff --git a/docs/LoaderDebugging.md b/docs/LoaderDebugging.md index e404fe791..c8ebbc38e 100644 --- a/docs/LoaderDebugging.md +++ b/docs/LoaderDebugging.md @@ -165,6 +165,9 @@ which indicates that it was likely enabled by the application. ### Disable Layers +**NOTE:** This functionality is only available with Loaders built with version +1.3.yyyy of the Vulkan headers and later. + Sometimes, implicit layers can cause issues with an application. Because of this, the next step is to try to disable one or more of the listed implicit layers. @@ -189,6 +192,9 @@ WARNING | LAYER: Implicit layer "VK_LAYER_Twitch_Overlay" forced disabled becau ### Selectively Re-enable Layers +**NOTE:** This functionality is only available with Loaders built with version +1.3.yyyy of the Vulkan headers and later. + When trying to diagnose problems caused by layers, it is useful to first disable all layers and re-enable each layer individually. If the problem reappears, then it is immediately clear which layer is the source @@ -225,6 +231,9 @@ For more info on how to use the filtering environment variables, refer to the ### Enable Driver Logging +**NOTE:** This functionality is only available with Loaders built with version +1.3.yyyy of the Vulkan headers and later. + If you suspect a driver issue, set the loader logging to specifically output driver messages: @@ -291,6 +300,9 @@ DRIVER: Using "Intel(R) UHD Graphics 630 (CFL GT2)" with driver: "/usr/li ### Selectively Enable Specific Drivers +**NOTE:** This functionality is only available with Loaders built with version +1.3.yyyy of the Vulkan headers and later. + You can now use the filtering environment variables (`VK_LOADER_DRIVERS_SELECT` and `VK_LOADER_DRIVERS_DISABLE`) to selectively select or disable various drivers. diff --git a/docs/LoaderDriverInterface.md b/docs/LoaderDriverInterface.md index e82d7ab68..5fd146e3e 100644 --- a/docs/LoaderDriverInterface.md +++ b/docs/LoaderDriverInterface.md @@ -142,6 +142,9 @@ ignored. ### Driver Filtering +**NOTE:** This functionality is only available with Loaders built with version +1.3.yyyy of the Vulkan headers and later. + The driver select environment variable `VK_LOADER_DRIVERS_SELECT` is a comma-delimited list of globs to search for in known drivers. Since drivers don’t have a name like layers, this substring is used to compare diff --git a/docs/LoaderInterfaceArchitecture.md b/docs/LoaderInterfaceArchitecture.md index 22b4518fb..1e4a98b9f 100644 --- a/docs/LoaderInterfaceArchitecture.md +++ b/docs/LoaderInterfaceArchitecture.md @@ -709,6 +709,8 @@ discovery. variables (like <i>VK_ICD_FILENAMES</i> or <i>VK_ADD_DRIVER_FILES</i>). </small></td> <td><small> + This functionality is only available with Loaders built with version + 1.3.yyyy of the Vulkan headers and later.<br/> If no drivers are found with a manifest filename that matches any of the provided globs, then no driver is enabled and it <b>may</b> result in Vulkan applications failing to run properly. @@ -738,6 +740,8 @@ discovery. variables (like <i>VK_ICD_FILENAMES</i> or <i>VK_ADD_DRIVER_FILES</i>). </small></td> <td><small> + This functionality is only available with Loaders built with version + 1.3.yyyy of the Vulkan headers and later.<br/> If all available drivers are disabled using this environment variable, then no drivers will be found by the loader and <b>will</b> result in Vulkan applications failing to run properly.<br/> @@ -772,7 +776,8 @@ discovery. <i>VK_INSTANCE_LAYERS</i> </small></td> <td><small> - None + This functionality is only available with Loaders built with version + 1.3.yyyy of the Vulkan headers and later. </small></td> <td><small> export<br/> @@ -798,6 +803,8 @@ discovery. (like <i>VK_LAYER_PATH</i>). </small></td> <td><small> + This functionality is only available with Loaders built with version + 1.3.yyyy of the Vulkan headers and later.<br/> Disabling a layer that an application intentionally enables as an explicit layer <b>may</b> cause the application to not function properly.<br/> diff --git a/docs/LoaderLayerInterface.md b/docs/LoaderLayerInterface.md index 638e6a589..91c9fc1a0 100644 --- a/docs/LoaderLayerInterface.md +++ b/docs/LoaderLayerInterface.md @@ -421,6 +421,9 @@ following: ### Layer Filtering +**NOTE:** This functionality is only available with Loaders built with version +1.3.yyyy of the Vulkan headers and later. + The layer enable environment variable `VK_LOADER_LAYERS_ENABLE` is a comma-delimited list of globs to search for in known layers. Known layers are those that are already found by the loader taking into account diff --git a/loader/vk_loader_platform.h b/loader/vk_loader_platform.h index cfdc6660e..6f01c653d 100644 --- a/loader/vk_loader_platform.h +++ b/loader/vk_loader_platform.h @@ -92,7 +92,7 @@ // Support added in v1.3.207 loader #define VK_ADDITIONAL_DRIVER_FILES_ENV_VAR "VK_ADD_DRIVER_FILES" #define VK_ADDITIONAL_LAYER_PATH_ENV_VAR "VK_ADD_LAYER_PATH" -// Support added in v1.3.217 loader +// Support added in v1.3.yyyy loader #define VK_LAYERS_ENABLE_ENV_VAR "VK_LOADER_LAYERS_ENABLE" #define VK_LAYERS_DISABLE_ENV_VAR "VK_LOADER_LAYERS_DISABLE" #define VK_DRIVERS_SELECT_ENV_VAR "VK_LOADER_DRIVERS_SELECT" |