Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/KhronosGroup/Vulkan-Loader.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Young <marky@lunarg.com>2022-05-26 00:38:33 +0300
committerMark Young <marky@lunarg.com>2022-05-26 00:53:52 +0300
commitfc48c8640bb99e1782b02740cc7e285c5246fa8b (patch)
treed9da4416c09aca385a2e0203e065f4901cf1f689
parentc2897084d25489454bb1ee6b7bedc5b96e6dadd5 (diff)
Clarify JSON Manifest "api_version"
Clarify what is indicated by the "api_version" field in both layer and driver manifest files. Fixes issue #336.
-rw-r--r--docs/LoaderDriverInterface.md10
-rw-r--r--docs/LoaderLayerInterface.md7
2 files changed, 13 insertions, 4 deletions
diff --git a/docs/LoaderDriverInterface.md b/docs/LoaderDriverInterface.md
index a1a059ef1..b99e9b2d7 100644
--- a/docs/LoaderDriverInterface.md
+++ b/docs/LoaderDriverInterface.md
@@ -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>
diff --git a/docs/LoaderLayerInterface.md b/docs/LoaderLayerInterface.md
index 1797c3dc3..2a3633656 100644
--- a/docs/LoaderLayerInterface.md
+++ b/docs/LoaderLayerInterface.md
@@ -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>