Clarify JSON Manifest "api_version"
authorMark Young <marky@lunarg.com>
Wed, 25 May 2022 21:38:33 +0000 (15:38 -0600)
committerMark Young <marky@lunarg.com>
Wed, 25 May 2022 21:53:52 +0000 (15:53 -0600)
Clarify what is indicated by the "api_version" field in both
layer and driver manifest files.

Fixes issue #336.

docs/LoaderDriverInterface.md
docs/LoaderLayerInterface.md

index a1a059ef17cc02bff4800dd8d76483f2c815072f..b99e9b2d7ede7089e466fc30f1d650e8790bc249 100644 (file)
@@ -549,8 +549,14 @@ Here is an example driver JSON Manifest file:
   </tr>
   <tr>
     <td>"api_version" </td>
-    <td>The major.minor.patch version number of the Vulkan API that the shared
-        library files for the driver was built against.<br/>
+    <td>The major.minor.patch version number of the maximum Vulkan API supported
+        by the driver.
+        However, just because the driver supports the specific Vulkan API version,
+        it does not guarantee that the hardware on a user's system can support
+        that version.
+        Information on what the underlying physical device can support must be
+        queried by the user using the <i>vkGetPhysicalDeviceProperties</i> API call.
+        <br/>
         For example: 1.0.33.</td>
   </tr>
   <tr>
index 1797c3dc3e17ab9e5646267dc11ed6aed6a4b7a3..2a36336565c55d8cc3e7fed37e0b4e401654e52d 100644 (file)
@@ -1510,8 +1510,11 @@ Here's an example of a meta-layer manifest file:
   </tr>
   <tr>
     <td>"api_version"</td>
-    <td>The major.minor.patch version number of the Vulkan API that the shared
-        library file for the library was built against. </br>
+    <td>The major.minor.patch version number of the Vulkan API that the layer
+        supports.
+        It does not require the application to make use of that API version.
+        It simply is an indication that the layer can support Vulkan API
+        instance and device functions up to and including that API version. </br>
         For example: 1.0.33.
     </td>
     <td>None</td>