aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Ashburn <jon@lunarg.com>2015-07-24 09:20:11 -0600
committerJon Ashburn <jon@lunarg.com>2015-07-24 10:01:24 -0600
commit0d498bd6b118997c1c7d4baacc714deeda964aa2 (patch)
treeab148f0bf5ddecb35ce06444803dc6beeb593002
parent4db982b7ef783668b63b383c55759e7d0b0a58b4 (diff)
downloadusermoji-0d498bd6b118997c1c7d4baacc714deeda964aa2.tar.xz
loader: Update the Linux and Windows manifest file documentation to match khr
-rw-r--r--loader/LinuxICDs.txt23
-rw-r--r--loader/WindowsICDs.txt22
2 files changed, 22 insertions, 23 deletions
diff --git a/loader/LinuxICDs.txt b/loader/LinuxICDs.txt
index 9c5fac19..1e50f651 100644
--- a/loader/LinuxICDs.txt
+++ b/loader/LinuxICDs.txt
@@ -1,7 +1,7 @@
-This is a proposal for how the Vulkan loader should identify Vulkan installable
-client drivers (ICDs) and layers on Linux systems. This is designed for
-production installation of Vulkan ICDs and layers. The design is shown first
-for ICDs, and then the variation for layers will be discussed.
+This is a specification for how the Vulkan loader should identify Vulkan
+installable client drivers (ICDs) and layers on Linux systems. This is
+designed for production installation of Vulkan ICDs and layers. The design is
+shown first for ICDs, and then the variation for layers will be discussed.
1. Installable Client Drivers:
@@ -16,10 +16,10 @@ in the following Linux directories:
/etc/vulkan/icd.d
These directories will contain text information files (a.k.a. "manifest
-files"), that use a JSON format (NOTE: The JSON in this version of the proposal
-is for illustration purposes, and isn’t completely valid yet). The Vulkan
-loader will open each info file to obtain the name or pathname of an ICD shared
-library (“.so”) file. For example:
+files"), that use a JSON format (NOTE: The JSON in this version of the
+specification is for illustration purposes, and isn’t completely valid yet).
+The Vulkan loader will open each info file to obtain the name or pathname of an
+ICD shared library (“.so”) file. For example:
{
"file_format_version": "1.0.0",
@@ -66,8 +66,8 @@ files, with the specified contents:
vendorb_vk.json { "ICD": { "library_path": "vendorb_vulkan_icd.so" }}
vendorc_icd.json { "ICD": { "library_path": "/usr/lib/VENDORC/icd.so" }}
-the loader will open the three files mentioned in the “Text File Name”
-column, and then try to load and use the three shared libraries
+then the loader will open the three files mentioned in the “Text File Contents”
+column, and then try to load and use the three shared libraries mentioned
indicated by the ICD.library_path value.
@@ -190,8 +190,7 @@ information:
both the "enable_environment" and "disable_environment" variables are set,
the implicit layer is disabled.
-For example (NOTE: The JSON in this version of the proposal is for illustration
-purposes, and isn’t completely valid yet):
+For example:
{
“file_format_version” : “1.0.0”,
diff --git a/loader/WindowsICDs.txt b/loader/WindowsICDs.txt
index e6337b65..c93a91b6 100644
--- a/loader/WindowsICDs.txt
+++ b/loader/WindowsICDs.txt
@@ -1,7 +1,7 @@
-This is a proposal for how the Vulkan loader should identify Vulkan installable
-client drivers (ICDs) on MS Windows. This is designed for production
-installation of Vulkan ICDs and layers. The design is shown first for ICDs,
-and then the variation for layers will be discussed.
+This is a specification for how the Vulkan loader should identify Vulkan
+installable client drivers (ICDs) on MS Windows. This is designed for
+production installation of Vulkan ICDs and layers. The design is shown first
+for ICDs, and then the variation for layers will be discussed.
1. Installable Client Drivers:
@@ -16,7 +16,7 @@ HKEY_LOCAL_MACHINE\SOFTWARE\Khronos\Vulkan\Drivers
For each value in this key which has DWORD data set to 0, the loader opens the
text information file (a.k.a. "manifest file"), that uses a JSON format (NOTE:
-The JSON in this version of the proposal is for illustration purposes, and
+The JSON in this version of the specification is for illustration purposes, and
isn’t completely valid yet), specified by the name of the value. Each name
must be a full pathname to the text info file. The Vulkan loader will open
each info file to obtain the name or pathname of an ICD shared library (“.dll”)
@@ -32,10 +32,10 @@ file. For example:
The “library_path” specifies either a filename, a relative pathname, or a full
pathname to an ICD shared library file, which the loader will attempt to load
-using LoadLibrary(). If the ICD is specified via a filename, the shared library
-lives in the system’s DLL search path (e.g. in the “C:\\Windows\\System32” folder).
-If the ICD is specified via a relative pathname, it is relative to the path
-of the info file.
+using LoadLibrary(). If the ICD is specified via a filename, the shared
+library lives in the system’s DLL search path (e.g. in the
+“C:\\Windows\\System32” folder). If the ICD is specified via a relative
+pathname, it is relative to the path of the info file.
The “file_format_version” specifies a major.minor.patch version number in case
the format of the text information file changes in the future. If the same ICD
@@ -180,8 +180,8 @@ information:
both the "enable_environment" and "disable_environment" variables are set,
the implicit layer is disabled.
-For example (NOTE: The JSON in this version of the proposal is for illustration
-purposes, and isn’t completely valid yet):
+For example:
+
{
“file_format_version” : “1.0.0”,
“layer”: {