README.md

   1 NOTE: Recent changes have been made regarding the loading of the shared layer utilities library on Windows.
   2       Please see [BUILD.md](BUILD.md) for details.
   3
   4 # Vulkan Ecosystem Components
   5
   6 This project provides Khronos official ICD loader and validation layers for Vulkan developers on Windows and Linux.
   7
   8 ## Introduction
   9
  10 Vulkan is an Explicit API, enabling direct control over how GPUs actually work. No (or very little) validation
  11 or error checking is done inside a Vulkan driver. Applications have full control and responsibility. Any errors in
  12 how Vulkan is used often result in a crash. This project provides standard validation layers that can be enabled
  13 to ease development by helping developers verify their applications correctly use the Vulkan API.
  14
  15 Vulkan supports multiple GPUs and multiple global contexts (VkInstance). The ICD loader is necessary to
  16 support multiple GPUs  and the VkInstance level Vulkan commands.  Additionally, the loader manages inserting
  17 Vulkan layer libraries, including validation layers between the application and the ICD.
  18
  19 The following components are available in this repository:
  20 - Vulkan header files
  21 - [*ICD Loader*](loader/)
  22 - [*Validation Layers*](layers/)
  23 - Demos and tests for the loader and validation layers
  24
  25 ## Contributing
  26
  27 If you intend to contribute, the preferred work flow is for you to develop your contribution
  28 in a fork of this repo in your GitHub account and then submit a pull request.
  29 Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this respository for more details
  30
  31 ## How to Build and Run
  32
  33 [BUILD.md](BUILD.md)
  34 includes directions for building all the components, running the validation tests and running the demo applications.
  35
  36 Information on how to enable the various Validation layers is in
  37 [layers/README.md](layers/README.md).
  38
  39 Architecture and interface information for the loader is in
  40 [loader/LoaderAndLayerInterface.md](loader/LoaderAndLayerInterface.md).
  41
  42 ## License
  43 This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.
  44
  45 See COPYRIGHT.txt for a full list of licenses used in this repository.
  46
  47 ## Acknowledgements
  48 While this project has been developed primarily by LunarG, Inc; there are many other
  49 companies and individuals making this possible: Valve Corporation, funding
  50 project development; Google providing significant contributions to the validation layers;
  51 Khronos providing oversight and hosting of the project.
  52
  53