diff options
author | Mark Young <marky@lunarg.com> | 2022-02-17 14:25:29 -0700 |
---|---|---|
committer | Mark Young <marky@lunarg.com> | 2022-02-18 08:10:06 -0700 |
commit | 2dc241007691cd6335b8cfff45935244a0c08ccb (patch) | |
tree | f2ed8e28b9418589544b1d068570be7163baebff | |
parent | 18852aa1b97a67d8507ceccc3c3ff646264b4ee6 (diff) | |
download | Vulkan-Loader-2dc241007691cd6335b8cfff45935244a0c08ccb.tar.gz Vulkan-Loader-2dc241007691cd6335b8cfff45935244a0c08ccb.tar.bz2 Vulkan-Loader-2dc241007691cd6335b8cfff45935244a0c08ccb.zip |
Fix vk_icdGetPhysicalDeviceProcAddr docs
The language was not normative and also made clearer.
-rw-r--r-- | docs/LoaderDriverInterface.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/LoaderDriverInterface.md b/docs/LoaderDriverInterface.md index 965993a1..7576822b 100644 --- a/docs/LoaderDriverInterface.md +++ b/docs/LoaderDriverInterface.md @@ -703,12 +703,15 @@ In this way, it compares "pName" to every physical device function supported in the driver. The following rules apply: -* If it is the name of a physical device function supported by the driver, the -pointer to the driver's corresponding function should be returned. -* If it is the name of a valid function which is **not** a physical device -function (i.e. an instance, device, or other function implemented by the -driver), then the value of `NULL` should be returned. -* If the driver has no idea what this function is, it should return `NULL`. +* If `pName` is the name of a Vulkan API entrypoint that takes a `VkPhysicalDevice` + as its primary dispatch handle, and the driver supports the entrypoint, then + the driver **must** return the valid function pointer to the driver's + implementation of that entrypoint. +* If `pName` is the name of a Vulkan API entrypoint that takes something other than + a `VkPhysicalDevice` as its primary dispatch handle, then the driver **must** + return `NULL`. +* If the driver is unaware of any entrypoint with the name `pName`, it **must** + return `NULL`. This support is optional and should not be considered a requirement. This is only required if a driver intends to support some functionality not |