1 # Vulkan® Window System Integration Layer
5 This project is a Vulkan® layer which implements some of the Vulkan® window system
6 integration extensions such as `VK_KHR_swapchain`. The layer is designed to be
7 GPU vendor agnostic when used as part of the Vulkan® ICD/loader architecture.
9 Our vision for the project is to become the de facto implementation for Vulkan®
10 window system integration extensions so that they need not be implemented in the
11 ICD; instead, the implementation of these extensions are shared across vendors
14 The project currently implements support for `VK_EXT_headless_surface` and
15 its dependencies. We hope to extend support for further platforms such as Wayland
16 and direct-to-display rendering in the future.
22 * [CMake](https://cmake.org) version 2.8.11 or above.
24 * Vulkan® loader and associated headers with support for the
25 `VK_EXT_headless_surface` extension.
27 ### Building the Vulkan® loader
29 This step is not necessary if your system already has a loader and associated
30 headers with support for the `VK_EXT_headless_surface` extension. We include
31 these instructions for completeness.
34 git clone https://github.com/KhronosGroup/Vulkan-Loader.git
35 mkdir Vulkan-Loader/build
36 cd Vulkan-Loader/build
37 ../scripts/update_deps.py
38 cmake -C helper.cmake ..
43 ### Building the layer
45 The layer requires a version of the loader and headers that includes support for
46 the `VK_EXT_headless_surface` extension. By default, the build system will use
47 the system Vulkan® headers as reported by `pkg-config`. This may be overriden by
48 specifying `VULKAN_CXX_INCLUDE` in the CMake configuration, for example:
51 cmake . -DVULKAN_CXX_INCLUDE="path/to/vulkan-headers"
54 If the loader and associated headers already meet the requirements of the layer
55 then the build steps are straightforward:
64 Copy the shared library `libVkLayer_window_system_integration.so` and JSON
65 configuration `VkLayer_window_system_integration.json` into a Vulkan®
66 [implicit layer directory](https://vulkan.lunarg.com/doc/view/1.0.39.0/windows/layers.html#user-content-configuring-layers-on-linux).
70 We are open for contributions.
72 * The software is provided under the MIT license. Contributions to this project
73 are accepted under the same license.
74 * Please also ensure that each commit in the series has at least one
75 `Signed-off-by:` line, using your real name and email address. The names in
76 the `Signed-off-by:` and `Author:` lines must match. If anyone else
77 contributes to the commit, they must also add their own `Signed-off-by:`
78 line. By adding this line the contributor certifies the contribution is made
79 under the terms of the [Developer Certificate of Origin (DCO)](DCO.txt).
80 * Questions, bug reports, et cetera are raised and discussed on the issues page.
81 * Please make merge requests into the master branch.
82 * Code should be formatted with clang-format using the project's .clang-format
85 Contributors are expected to abide by the
86 [freedesktop.org code of conduct](https://www.freedesktop.org/wiki/CodeOfConduct/).
88 ## Khronos® Conformance
90 This software is based on a published Khronos® Specification and is expected to
91 pass the relevant parts of the Khronos® Conformance Testing Process when used as
92 part of a conformant Vulkan® implementation.