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