Commit Graph

94 Commits

Author SHA1 Message Date
Charles Giessen a1ceae74ea docs: Add info on DXGI adapters in Windows ICD Discovery 2021-06-29 18:36:52 -06:00
Christophe 346680554c Add layer manifest version 1.2.0 to history 2021-06-17 09:19:10 -06:00
Charles Giessen 6a0f8b9ab9 docs: Update pre-instance-function list
Add `vkEnumerateInstanceVersion` to the list of allowed pre instance
functions in the LoaderLayerInterface.md

Change-Id: I238aec5c3606af4d39bff5c50bbe75e909cd3224
2021-04-21 12:00:01 -06:00
Mike Gorchak ff7918e9a0 Add support for QNX platform. 2021-04-06 14:52:51 -06:00
Lenny Komow 8535dacc1c docs: Update note about ICD proc addr 2021-03-23 17:21:03 -06:00
Charles Giessen 552516eae4 docs: Update static linking info
When static linking was removed as a build option, the documentation
for it was not ammended. This commit changes the text to describe that
it used to be supported, is no longer supported, and why the feature
was removed.

Change-Id: I8da0c1c811be7e9dc5119c4c27c34a5cbb30edf8
2020-09-29 15:26:19 -06:00
Charles Giessen 71d982f982 docs: Add info on VkConfig and override layer
Change-Id: I7fab8f7ff25a7f3ffd00a88da82daeac69e4e83c
2020-09-03 13:56:43 -06:00
Charles Giessen fb6ade00fd docs: Remove mention of old layers
The LoaderAndLayerInterface.md contained references to layers that
are no longer exist. This commit cleans that up.

Change-Id: I09a78513ba6f56cad6b6e9f2432242b86a291e93
2020-08-27 18:07:04 -06:00
Lenny Komow 5cb576c461 docs: Update loader doc with device sorting info 2020-08-14 14:38:39 -06:00
Lenny Komow 510cead4bc docs: Pass inst handles when getting func pointers
This fixes some documentation that incorrectly showed passing a NULL
instance when getting function pointers from vkGetInstanceProcAddr.

Change-Id: I56b4e8f244ec79ffb489ad86e09b30b8df8bc006
2020-08-06 09:39:19 -06:00
Petr Kraus a0c6aac7a9 docs: Fix typo 2020-04-28 17:50:44 -06:00
Petr Kraus 608f8e0a4d docs: Fix link in interface docs 2020-04-20 11:34:27 -06:00
Wang YanQing 5c222eeffd docs: Improve vkNegotiateLoaderLayerInterfaceVersion's description
The current description about the version number negotiation between
loader and layer is easy to cause disagreement, and the description
about the version number negotiation between loader and ICD is much
more readable, so I think it is better to adopt the same way as the
vk_icdNegotiateLoaderICDInterfaceVersion description to describe the
vkNegotiateLoaderLayerInterfaceVersion.

Signed-off-by: Wang YanQing <udknight@gmail.com>
2020-04-06 10:27:42 -06:00
Wang YanQing d88023f699 docs: Correct one minor discrepancy in "Implicit vs Explicit Layers"
No place mentions the way previously that we could use environment
variable to enable explicit layers, so I think it is better to move
the notice in brackets to the more proper place.
2020-04-06 09:57:04 -06:00
Wang YanQing bc9250e1c6 docs: Fix wrong type name in InterceptFunctionName prototype
The right type name of InterceptFunctionName's first argument
is VkEnumerateInstanceExtensionPropertiesChan instead of the
VkEnumerateInstanceExtensionProperties.

Signed-off-by: Wang YanQing <udknight@gmail.com>
2020-03-26 10:44:01 -06:00
Mark Lobodzinski 7201ce4131 loader: Remove standard_val refs from LoaderLayerIF doc
Change-Id: I1f76bda5ff497def8522690367ee86d19a40e5e2
2020-02-20 12:52:21 -07:00
Lenny Komow a691a4986d docs: Update documentation for loader changes
Change-Id: Id4c18d91c977d8698bcccd4680e0740877378c95
2019-09-13 09:44:55 -06:00
Petr Kraus cb1243243b docs: Fix link typo in loader spec 2019-09-04 14:35:30 -06:00
Daniel Stone 02112c1f55 docs: Consistently capitalise XCB in docs
Change-Id: I580e818bbf603f22e8a907ca614d17b310cf7136
2019-06-24 13:31:18 -06:00
Daniel Stone ed0729ce6e docs: Remove Wayland disclaimer in docs
Wayland works totally fine, and has for a very long time.

Change-Id: Ifc582fd5068ad31758005f74b290f78e0f4554cc
2019-06-24 13:31:18 -06:00
John Zulauf cc860d5690 Update Dispatch Table update to actual location
DispatchTable struct now has it's own file.  Updated references to the correct file.
2019-04-18 10:33:59 -06:00
KarenGhavam-lunarG 5608b19440 docs: Add copyright internal to file as comment
Change-Id: Icbe3be658721c6a32bc3867b2dcc065e7ac94e00
2019-02-25 15:43:51 -07:00
KarenGhavam-lunarG 9853940e1b docs: Add Vulkan Logo
Adding Vulkan Logo for consistency across Vulkan SDK documentation.
Adding creative commons license (because there was no license on the documentation)
2019-02-15 11:56:31 -07:00
Bob Ellison 1ec7dac373 docs: Fix grammar and consistency in loader doc
LoaderAndLayerInterface.md:
- entry-point => entry point
- MacOS => macOS (except in API function names)
- on the applications surfaces => on the application's surfaces
- Because layers are optionally, => Because layers are optional,
- a child of a one of the above => a child of one of the above
- action / operation => action or operation
- fixed indentation of the dispatch table description to what I think was intended
- the application and/or system can specify => the application and the system can each specify
- linking to the .dll and .so versions of the loader => linking to the dynamic versions of the loader
  (because .dylib is also a dynamic link)
- platform specific => platform-specific
- dlsym() => `dlsym` (to match usage elsewhere)
- setup => set up (when used as a verb)
- don't break link references across lines
  e.g. [XX XX XX XX](YY) should never be broken in the YY clause
- 3 enabled layers => three enabled layers (spell numbers up to 10)
- backwards compatibility => backward compatibility
- Windows paths use "\" instead of "/"
- libXXX.YYY => `libXXX.YYY` (to match usage elsewhere)
- Layers => layers (to match usage elsewhere, where "Layers" isn't a capitalized term)
- bottommost => bottom-most (for consistency elsewhere)
- the VK_LAYER_XXX ... => the VK_LAYER_XXX layer (for consistency elsewhere)
- either end all list or table items with periods, or none of them
- Khronos approved => Khronos-approved
- hand-shake => handshake
- logical device (This depends => logical device (this depends
- other-hand => other hand
- filtering out of => filtering of
- JSON formatted => JSON-formatted
- /path/to/something => `/path/to/something` (to match usage elsewhere)
- system wide registries => system registries
- fixed some "*" entries (which generally must be escaed, "\*", in markdown)
- environment variable enabled layer => environment-variable-enabled layer
- The implementation of each intercept functions is => The implementation fo each intercept function is
- corrected some "it's" to "its", and vice versa
- the extension suffix of the file ends with ".json" => the extension suffix of the file is ".json"
- added commas to fix illegal JSON file content
- semi-colon separated => semi-colon-separated
- other minor grammar and consistency fixes
2018-12-18 09:29:18 -07:00
Wang YanQing 7a82edfad9 docs: Use "ICD" instead of "layer" in ICD info
Although an ICD is a layer too, in this context, using "ICD" is better
than using "layer".

Change-Id: Ic9619c0a99412c34aaba40cf4c1cc2187a00731b
Signed-off-by: Wang YanQing <udknight@gmail.com>
2018-11-28 17:04:17 -07:00
Tony-LunarG 85b7a60a96 repo: Remove MIR specific code
Note that references in scripts/common_codegen.py and
scripts/loader_extension_generator.py will need to be
removed later

Change-Id: I7b17c80f7a06a339d7df0c199ff556212a7c6534
2018-10-25 09:39:32 -06:00
Petr Kraus 2a71356a8e docs: Fix path typo in interface doc 2018-08-07 10:39:46 -06:00
Mark Young 9bceaac243 docs: Remove references to old repo
Remove references to the old repo. Also, remove ninja build steps
since they are no longer valid.

Change-Id: I4a963ec7dc49af2d7d0d186079f0aee78d110d70
2018-06-05 09:49:17 -06:00
Lenny Komow 373a3c2b96 docs: Update loader doc for 1.0 ICD handling
The 1.1 loader has to handle 1.0 ICDs specially during instance
creation. This commit documents that behavior.
2018-03-09 13:54:31 -07:00
Karl Schultz d81ebfb75a macOS: Add macOS support 2018-03-02 12:21:19 -07:00
Lenny Komow d5b641461b docs: Update loader doc for pre-instance layers
Change-Id: I4780d36714a6a15c4c57cd0f6324f640249a9427
2018-01-09 14:11:20 -07:00
Tobin Ehlis 7ed0da1719 loader: Fix function name in interface doc
There is no "vk_icdGetLoaderICDInterfaceVersion" function. The correct name is "vk_icdNegotiateLoaderICDInterfaceVersion."
2017-10-23 16:22:42 -06:00
Tobin Ehlis cd42e21a82 loader:Updates to LL Interface Doc
Fixing some formatting issues and typos as I read through doc.
2017-10-20 17:03:22 -06:00
Lenny Komow c7d9970b64 docs: Update loader doc for pnp registry changes
Change-Id: I3d41b7b01140243457ac35cfa2c22235f35e4e83
2017-09-06 11:54:17 -06:00
Slawomir Cygan 032ead5fa7 loader: Add new ICD search paths to loader
This change extends the functionality of searching for ICD JSONs by
adding registry locations specific to given display adapter and
software components associated with this display adapter.

The exact locations in registry are queried using Windows public PnP
Configuration Manager API[1].

This change is required, as previous ICD locations (constant path
in "HKLM/Software") may be unreachable for drivers and their
installers on Windows RS3[2].

Similar change is being made for OpenCL[2]

[1]https://msdn.microsoft.com/en-us/library/windows/hardware/ff549713.aspx
[2]https://github.com/KhronosGroup/OpenCL-ICD-Loader/pull/21
2017-08-10 09:49:24 -06:00
Mark Young bffc700093 loader: Add validation for apiVersion
Add a check to determine if the API version being requested can be
handled by the loader.  If it can't, then we return incompatible driver.
If we can, we continue along our merry way.

An addendum is that we also bumped the Loader/ICD interface version.
This was requested by Nvidia so that the ICDs know that we pay attention
to the version in the loader.  If they don't see the new Loader/ICD
interface version, they will handle the failing on all non-1.0 API
requests.

Change-Id: Icb7dd45e754c9f6a6c8186198333bacc68077b93
2017-06-29 11:08:04 -06:00
Mark Lobodzinski aeff1b7d52 docs: Remove swapchain refs from docs/text files
Change-Id: I88d9c5ae82159ad6b1976b0b498fbe4ee7f5e2d5
2017-06-12 07:32:50 -06:00
Mark Young f207daf0a2 docs: Update docs with env vars
Added table of all environmental variables.  Also added note
about using LD_BIND_NOW usage for discovering problematic ICDs.

Change-Id: Iba4234b2226ab145491fc913f4361b098b21fd0b
2017-05-19 14:54:22 -06:00
Mark Young e369637f79 loader: Update meta-layers
Use the meta-layer Manifest API version to check against each
of its component layer API versions.  This will force us to
make sure each JSON file is properly updated in sync.

Add a section to the LoaderAndLayerInterface markdown doc about
the usage of meta-layers, and an example of how they look in a
Manifest JSON file.

Change-Id: I667cfd3013cbcf201c83935dc6f1c2bb937c7742
2017-05-09 11:01:03 -06:00
Lenny Komow cc442e30ef docs: Update loader doc for linking and format
Change-Id: Id51ce907ca167a44f9f2db6db48b4ade679b129b
2017-05-04 17:31:08 -06:00
Mark Young cfa187e113 docs: LX666 - Typos in Docs
Fix issue brought up by Masaki Takano in LunarXchange.

Change-Id: Ib6caa931decf5976e96bcd4629602b7f25b88001
2017-03-20 08:27:14 -06:00
Lenny Komow aa62ae19f9 docs: Add new layer registries to loader doc
Change-Id: I185d37096db07585d8b4015201656937fbf5714d
2017-03-02 11:30:51 -07:00
Mark Young 8369c4ca09 docs: Update LoaderAndLayerInterface
Added section detailing the loader's instance extension name
filtering behavior and the environment varaible that can be used
to disable the behavior.

Change-Id: Iadbde47e2933a163906a7cfa1c4b340da0d73789
2017-02-13 15:39:22 -07:00
Jeff Juliano f663b4bf29 loader: Minor language clarification, fix markup 2017-02-01 20:00:16 -07:00
Mark Young 274e4bcf33 loader: Update the loader to 1.0.39
Add new extensions for 1.0.39.  Also, updated layers to include
minimal set of functionality for 1.0.39 extensions. Extensions include:
 - VK_KHR_get_physical_device_properties2
 - VK_KHR_shader_draw_parameters
 - VK_EXT_direct_mode_display
 - VK_EXT_display_surface_counter
 - VK_EXT_display_control

Also, redo the LoaderAndLayerIf document.

Change-Id: I10412086da7a798afe832a3892e18f606259b5af
2017-01-24 14:07:22 -07:00
Mark Young 8e56b15115 docs: Fix loader doc mention of linux dirs
The Linux "Properly-Installed ICDs" section wasn't coming across
into HTML properly.

Change-Id: I2538b3c027c88ad5923d23f554bba1734c60ec06
2016-11-22 08:44:21 -07:00
Karl Schultz a198e30aca docs: Remove references to "this repo"
Remove references to "this repository" in the loader and layers design doc since this file can appear on web sites, etc.
2016-11-02 13:50:35 -06:00
Karl Schultz 7443610976 docs: Updates for Linux loader /usr/local search paths.
Change-Id: I899c55815ef51efd141c22a5ce37b0800c2a8430
2016-10-31 15:59:21 -06:00
Karl Schultz 3f57b4afb1 docs: LX617: Fix Android layer path info 2016-10-31 08:52:38 -06:00
Rene Lindsay f4ebbac6b4 docs: Fix .md syntax typo in header 2016-10-25 11:05:09 -06:00