| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 1 | # Vulkan Ecosystem Components |
| 2 | |
| Mark Lobodzinski | d147bdc | 2018-05-11 09:20:23 -0600 | [diff] [blame] | 3 | This project provides the Khronos official Vulkan validation layers for Windows, Linux, Android, and MacOS. |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 4 | |
| Karl Schultz | 64ff686 | 2016-12-30 10:24:21 -0700 | [diff] [blame] | 5 | ## CI Build Status |
| Karl Schultz | 04962d4 | 2016-12-08 11:41:14 -0700 | [diff] [blame] | 6 | | Platform | Build Status | |
| 7 | |:--------:|:------------:| |
| Mark Lobodzinski | d147bdc | 2018-05-11 09:20:23 -0600 | [diff] [blame] | 8 | | Linux/Android | [](https://travis-ci.org/KhronosGroup/Vulkan-ValidationLayers) | |
| Karl Schultz | 110e8c3 | 2018-05-12 06:53:22 -0600 | [diff] [blame] | 9 | | Windows |[](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-validationlayers/branch/master) | |
| Karl Schultz | 64ff686 | 2016-12-30 10:24:21 -0700 | [diff] [blame] | 10 | |
| Karl Schultz | 04962d4 | 2016-12-08 11:41:14 -0700 | [diff] [blame] | 11 | |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 12 | ## Introduction |
| 13 | |
| Mark Lobodzinski | 863defa | 2018-01-04 14:55:26 -0700 | [diff] [blame] | 14 | Vulkan is an Explicit API, enabling direct control over how GPUs actually work. By design, minimal error checking is done inside |
| 15 | a Vulkan driver. Applications have full control and responsibility for correct operation. Any errors in |
| 16 | how Vulkan is used can result in a crash. This project provides Vulkan validation layers that can be enabled |
| 17 | to assist development by enabling developers to verify their applications correct use of the Vulkan API. |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 18 | |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 19 | The following components are available in this repository: |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 20 | - [*Validation Layers*](layers/) |
| Mark Lobodzinski | 863defa | 2018-01-04 14:55:26 -0700 | [diff] [blame] | 21 | - [*Tests*](tests/) |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 22 | |
| Mark Lobodzinski | 863defa | 2018-01-04 14:55:26 -0700 | [diff] [blame] | 23 | ## Contact Information |
| Tobin Ehlis | 5c8040b | 2018-04-05 09:30:09 -0600 | [diff] [blame] | 24 | * [Tobin Ehlis](mailto:tobine@google.com) |
| Mark Lobodzinski | 83a744e | 2018-01-05 09:04:50 -0700 | [diff] [blame] | 25 | * [Mark Lobodzinski](mailto:mark@lunarg.com) |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 26 | |
| Mark Lobodzinski | 863defa | 2018-01-04 14:55:26 -0700 | [diff] [blame] | 27 | ## Information for Developing or Contributing: |
| 28 | |
| Mark Lobodzinski | 83a744e | 2018-01-05 09:04:50 -0700 | [diff] [blame] | 29 | Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details. |
| 30 | Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details. |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 31 | |
| 32 | ## How to Build and Run |
| 33 | |
| 34 | [BUILD.md](BUILD.md) |
| Mark Lobodzinski | d147bdc | 2018-05-11 09:20:23 -0600 | [diff] [blame] | 35 | Includes directions for building all components as well as running validation tests. |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 36 | |
| 37 | Information on how to enable the various Validation layers is in |
| 38 | [layers/README.md](layers/README.md). |
| 39 | |
| Shannon McPherson | ebef1f3 | 2018-12-18 11:14:54 -0700 | [diff] [blame] | 40 | ## Version Tagging Scheme |
| 41 | |
| 42 | Updates to the `Vulkan-ValidationLayers` repository which correspond to a new Vulkan specification release are tagged using the following format: `v<`_`version`_`>` (e.g., `v1.1.96`). |
| 43 | |
| 44 | **Note**: Marked version releases have undergone thorough testing but do not imply the same quality level as SDK tags. SDK tags follow the `sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `sdk-1.1.92.0`). |
| 45 | |
| 46 | This scheme was adopted following the 1.1.96 Vulkan specification release. |
| 47 | |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 48 | ## License |
| 49 | This work is released as open source under a Apache-style license from Khronos including a Khronos copyright. |
| 50 | |
| 51 | See COPYRIGHT.txt for a full list of licenses used in this repository. |
| 52 | |
| 53 | ## Acknowledgements |
| Mark Lobodzinski | 863defa | 2018-01-04 14:55:26 -0700 | [diff] [blame] | 54 | While this project has been developed primarily by LunarG, Inc., there are many other |
| Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 55 | companies and individuals making this possible: Valve Corporation, funding |
| 56 | project development; Google providing significant contributions to the validation layers; |
| 57 | Khronos providing oversight and hosting of the project. |