README.md

   1 # Vulkan Ecosystem Components
   2
   3 This project provides Khronos official ICD loader and validation layers for Vulkan developers on Windows and Linux.
   4
   5 ## CI Build Status
   6 | Platform | Build Status |
   7 |:--------:|:------------:|
   8 | Linux/Android | [![Build Status](https://travis-ci.org/KhronosGroup/Vulkan-LoaderAndValidationLayers.svg?branch=master)](https://travis-ci.org/KhronosGroup/Vulkan-LoaderAndValidationLayers) |
   9 | Windows |[![Build status](https://ci.appveyor.com/api/projects/status/ri4584d6qramrjiv/branch/master?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-loaderandvalidationlayers/branch/master) |
  10
  11
  12 ## Introduction
  13
  14 Vulkan is an Explicit API, enabling direct control over how GPUs actually work. No (or very little) validation
  15 or error checking is done inside a Vulkan driver. Applications have full control and responsibility. Any errors in
  16 how Vulkan is used often result in a crash. This project provides standard validation layers that can be enabled
  17 to ease development by helping developers verify their applications correctly use the Vulkan API.
  18
  19 Vulkan supports multiple GPUs and multiple global contexts (VkInstance). The ICD loader is necessary to
  20 support multiple GPUs and the VkInstance level Vulkan commands.  Additionally, the loader manages inserting
  21 Vulkan layer libraries, including validation layers between the application and the ICD.
  22
  23 The following components are available in this repository:
  24 - Vulkan header files
  25 - [*ICD Loader*](loader/)
  26 - [*Validation Layers*](layers/)
  27 - [*Mock ICD*](icd/)
  28 - Demos and tests for the loader and validation layers
  29
  30 ## Contributing
  31
  32 If you intend to contribute, the preferred work flow is for you to develop your contribution
  33 in a fork of this repo in your GitHub account and then submit a pull request.
  34 Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this repository for more details
  35
  36 ## How to Build and Run
  37
  38 [BUILD.md](BUILD.md)
  39 includes directions for building all the components, running the validation tests and running the demo applications.
  40
  41 Information on how to enable the various Validation layers is in
  42 [layers/README.md](layers/README.md).
  43
  44 Architecture and interface information for the loader is in
  45 [loader/LoaderAndLayerInterface.md](loader/LoaderAndLayerInterface.md).
  46
  47 #### **NOTE**: Update Nvidia Drivers
  48 - A recent glslang change exposed a bug in the texel fetch behavior on Nvidia devices under certain situations.
  49 - Previously, we reverted the glslang change which exposed it.
  50 - Nvidia has since resolved the issue, and we are now removing the workaround.
  51 - Driver installs with the fix are available on their download page, just look for:
  52  - Linux Drivers starting with version 367.35
  53  - Windows Drivers starting at version 372.54
  54
  55 ## License
  56 This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.
  57
  58 See COPYRIGHT.txt for a full list of licenses used in this repository.
  59
  60 ## Acknowledgements
  61 While this project has been developed primarily by LunarG, Inc; there are many other
  62 companies and individuals making this possible: Valve Corporation, funding
  63 project development; Google providing significant contributions to the validation layers;
  64 Khronos providing oversight and hosting of the project.
  65
  66