Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 3.41 KB

README.md

File metadata and controls

61 lines (43 loc) · 3.41 KB

Vulkan Ecosystem Components

This project provides the Khronos official Vulkan validation layers for Windows, Linux, Android, and MacOS.

Default branch changed to 'main' (January 23, 2023)

As discussed in KhronosGroup#5084, the default branch of this repository is now 'main'. This change should be largely transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github:

git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a

CI Build Status

Build Status Build Status Build Status Build Status

Introduction

Vulkan is an Explicit API, enabling direct control over how GPUs actually work. By design, minimal error checking is done inside a Vulkan driver. Applications have full control and responsibility for correct operation. Any errors in how Vulkan is used can result in a crash. This project provides Vulkan validation layers that can be enabled to assist development by enabling developers to verify their applications correct use of the Vulkan API.

This repository contains both the Validation Layers source as well as Tests for them.

Contact Information

  • @KhronosGroup/VVL-CODEOWNERS
  • VVL-CODEOWNERS members can also be found on the Khronos Slack

Info

  • BUILD.md - Instructions for building the Validation Layers
  • LAYER_CONFIGURATION.md - Instructions for configuring the Validation Layers at runtime.
  • CONTRIBUTING.md - Information needed to make a contribution.
    • ./docs - Details of the Validation Layer source code. For those wanting to make contributions
    • ./tests - Information about testing the Validation Layers.
    • GOVERNANCE.md - Repository management details.

Version Tagging Scheme

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).

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).

This scheme was adopted following the 1.1.96 Vulkan specification release.

License

This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.

See LICENSE.txt for a full list of licenses used in this repository.

Acknowledgements

While this project has been developed primarily by LunarG, Inc., there are many other companies and individuals making this possible: Valve Corporation, funding project development; Google providing significant contributions to the validation layers; Khronos providing oversight and hosting of the project.