xref: /aosp_15_r20/external/vulkan-validation-layers/README.md (revision b7893ccf7851cd6a48cc5a1e965257d8a5cdcc70)
1*b7893ccfSSadaf Ebrahimi# Vulkan Ecosystem Components
2*b7893ccfSSadaf Ebrahimi
3*b7893ccfSSadaf EbrahimiThis project provides the Khronos official Vulkan validation layers for Windows, Linux, Android, and MacOS.
4*b7893ccfSSadaf Ebrahimi
5*b7893ccfSSadaf Ebrahimi## CI Build Status
6*b7893ccfSSadaf Ebrahimi| Platform | Build Status |
7*b7893ccfSSadaf Ebrahimi|:--------:|:------------:|
8*b7893ccfSSadaf Ebrahimi| Linux/Android | [![Build Status](https://travis-ci.org/KhronosGroup/Vulkan-ValidationLayers.svg?branch=master)](https://travis-ci.org/KhronosGroup/Vulkan-ValidationLayers) |
9*b7893ccfSSadaf Ebrahimi| Windows |[![Build status](https://ci.appveyor.com/api/projects/status/8wduq4r5d9j8nhdv?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-validationlayers/branch/master) |
10*b7893ccfSSadaf Ebrahimi
11*b7893ccfSSadaf Ebrahimi
12*b7893ccfSSadaf Ebrahimi## Introduction
13*b7893ccfSSadaf Ebrahimi
14*b7893ccfSSadaf EbrahimiVulkan is an Explicit API, enabling direct control over how GPUs actually work. By design, minimal error checking is done inside
15*b7893ccfSSadaf Ebrahimia Vulkan driver. Applications have full control and responsibility for correct operation. Any errors in
16*b7893ccfSSadaf Ebrahimihow Vulkan is used can result in a crash. This project provides Vulkan validation layers that can be enabled
17*b7893ccfSSadaf Ebrahimito assist development by enabling developers to verify their applications correct use of the Vulkan API.
18*b7893ccfSSadaf Ebrahimi
19*b7893ccfSSadaf EbrahimiThe following components are available in this repository:
20*b7893ccfSSadaf Ebrahimi- [*Validation Layers*](layers/)
21*b7893ccfSSadaf Ebrahimi- [*Tests*](tests/)
22*b7893ccfSSadaf Ebrahimi
23*b7893ccfSSadaf Ebrahimi## Contact Information
24*b7893ccfSSadaf Ebrahimi* [Tobin Ehlis](mailto:[email protected])
25*b7893ccfSSadaf Ebrahimi* [Mark Lobodzinski](mailto:[email protected])
26*b7893ccfSSadaf Ebrahimi
27*b7893ccfSSadaf Ebrahimi## Information for Developing or Contributing:
28*b7893ccfSSadaf Ebrahimi
29*b7893ccfSSadaf EbrahimiPlease see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
30*b7893ccfSSadaf EbrahimiPlease see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details.
31*b7893ccfSSadaf Ebrahimi
32*b7893ccfSSadaf Ebrahimi## How to Build and Run
33*b7893ccfSSadaf Ebrahimi
34*b7893ccfSSadaf Ebrahimi[BUILD.md](BUILD.md)
35*b7893ccfSSadaf EbrahimiIncludes directions for building all components as well as running validation tests.
36*b7893ccfSSadaf Ebrahimi
37*b7893ccfSSadaf EbrahimiInformation on how to enable the various Validation layers is in
38*b7893ccfSSadaf Ebrahimi[layers/README.md](layers/README.md).
39*b7893ccfSSadaf Ebrahimi
40*b7893ccfSSadaf Ebrahimi## Version Tagging Scheme
41*b7893ccfSSadaf Ebrahimi
42*b7893ccfSSadaf EbrahimiUpdates 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*b7893ccfSSadaf Ebrahimi
44*b7893ccfSSadaf Ebrahimi**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*b7893ccfSSadaf Ebrahimi
46*b7893ccfSSadaf EbrahimiThis scheme was adopted following the 1.1.96 Vulkan specification release.
47*b7893ccfSSadaf Ebrahimi
48*b7893ccfSSadaf Ebrahimi## License
49*b7893ccfSSadaf EbrahimiThis work is released as open source under a Apache-style license from Khronos including a Khronos copyright.
50*b7893ccfSSadaf Ebrahimi
51*b7893ccfSSadaf EbrahimiSee COPYRIGHT.txt for a full list of licenses used in this repository.
52*b7893ccfSSadaf Ebrahimi
53*b7893ccfSSadaf Ebrahimi## Acknowledgements
54*b7893ccfSSadaf EbrahimiWhile this project has been developed primarily by LunarG, Inc., there are many other
55*b7893ccfSSadaf Ebrahimicompanies and individuals making this possible: Valve Corporation, funding
56*b7893ccfSSadaf Ebrahimiproject development; Google providing significant contributions to the validation layers;
57*b7893ccfSSadaf EbrahimiKhronos providing oversight and hosting of the project.
58