README.md

   1 # Vulkan® Window System Integration Layer
   2
   3 ## Introduction
   4
   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.
   8
   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
  12 for mutual benefit.
  13
  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.
  17
  18 ## Building
  19
  20 ### Dependencies
  21
  22 * [CMake](https://cmake.org) version 2.8.11 or above.
  23 * C++11 compiler.
  24 * Vulkan® loader and associated headers with support for the
  25   `VK_EXT_headless_surface` extension.
  26
  27 ### Building the Vulkan® loader
  28
  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.
  32
  33 ```
  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 make -C Vulkan-Headers install
  39 cmake -C helper.cmake .. -DBUILD_WSI_HEADLESS_SUPPORT=ON
  40 make
  41 make install
  42 ```
  43
  44 ### Building the layer
  45
  46 The layer requires a version of the loader and headers that includes support for
  47 the `VK_EXT_headless_surface` extension. By default, the build system will use
  48 the system Vulkan® headers as reported by `pkg-config`. This may be overriden by
  49 specifying `VULKAN_CXX_INCLUDE` in the CMake configuration, for example:
  50
  51 ```
  52 cmake . -DVULKAN_CXX_INCLUDE="path/to/vulkan-headers"
  53 ```
  54
  55 If the loader and associated headers already meet the requirements of the layer
  56 then the build steps are straightforward:
  57
  58 ```
  59 cmake . -Bbuild
  60 make -C build
  61 ```
  62
  63 ## Installation
  64
  65 Copy the shared library `libVkLayer_window_system_integration.so` and JSON
  66 configuration `VkLayer_window_system_integration.json` into a Vulkan®
  67 [implicit layer directory](https://vulkan.lunarg.com/doc/view/1.0.39.0/windows/layers.html#user-content-configuring-layers-on-linux).
  68
  69 ## Contributing
  70
  71 We are open for contributions.
  72
  73  * The software is provided under the MIT license. Contributions to this project
  74    are accepted under the same license.
  75  * Please also ensure that each commit in the series has at least one
  76    `Signed-off-by:` line, using your real name and email address. The names in
  77    the `Signed-off-by:` and `Author:` lines must match. If anyone else
  78    contributes to the commit, they must also add their own `Signed-off-by:`
  79    line. By adding this line the contributor certifies the contribution is made
  80    under the terms of the [Developer Certificate of Origin (DCO)](DCO.txt).
  81  * Questions, bug reports, et cetera are raised and discussed on the issues page.
  82  * Please make merge requests into the master branch.
  83  * Code should be formatted with clang-format using the project's .clang-format
  84    configuration.
  85
  86 Contributors are expected to abide by the
  87 [freedesktop.org code of conduct](https://www.freedesktop.org/wiki/CodeOfConduct/).
  88
  89 ## Khronos® Conformance
  90
  91 This software is based on a published Khronos® Specification and is expected to
  92 pass the relevant parts of the Khronos® Conformance Testing Process when used as
  93 part of a conformant Vulkan® implementation.