-# Explicit GL (VK) Ecosystem Components\r
-*Version 0.8, 04 Feb 2015*\r
-\r
-This project provides *open source* tools for VK Developers.\r
-\r
-## Introduction\r
-\r
-VK is an Explicit API, enabling direct control over how GPUs actually work. No validation, shader recompilation, memory management or synchronization is done inside an VK driver. Applications have full control and responsibility. Any errors in how VK is used are likely to result in a crash. This project provides layered utility libraries to ease development and help guide developers to proven safe patterns.\r
-\r
-New with VK in an extensible layered architecture that enables significant innovation in tools:\r
-- Cross IHV support enables tools vendors to plug into a common, extensible layer architecture\r
-- Layered tools during development enable validating, debugging and profiling without production performance impact\r
-- Modular validation architecture encourages many fine-grained layers--and new layers can be added easily\r
-- Encourages open community of tool developers: led by Valve, LunarG, Codeplay and others\r
-- Customized interactive debugging and validation layers will be available together with first drivers\r
-\r
-The components here are being shared with the Khronos community to provide\r
-insights into the specification as we approach an alpha header, and to assists those doing\r
-demos for GDC.\r
-\r
-The following components are available:\r
-- VK Library and header files, which include:\r
- - [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md)\r
- - Snapshot of *VK* and *BIL* header files from [*Khronos*](www.khronos.org)\r
-\r
-- [*VKTRACE tools*](tools/vktrace)\r
-\r
- \r
-\r
-- Core [*Validation Layers*](layers/)\r
-\r
-- [*Sample Driver*](icd)\r
-\r
-## New\r
-\r
-- Updated loader, driver, demos, tests and many tools to use "alpha" vulkan.h (~ version 47).\r
- Supports new resource binding model, memory allocation, pixel FORMATs and\r
- other updates.\r
- APIDump layer is working with these new API elements.\r
- VkTrace can trace and replay the cube and tri demos.\r
- Other layers in progress.\r
-- Warning: Recent versions of ubuntu 14.10 have **REMOVED** DRI 3.\r
- Version: 2:2.99.914-1~exp1ubuntu4.1 is known to work.\r
- Ubuntu 15.04 requires customization to add DRI3.\r
- See BUILD.md for details.\r
-\r
-## Prior updates\r
-\r
-- VK API trace and capture tools. See tools/vktrace/README.md for details.\r
-- Sample driver now supports multiple render targets. Added TriangleMRT to test that functionality.\r
-- Added VK_SLOT_SHADER_TEXTURE_RESOURCE to vulkan.h as a descriptor slot type to work around confusion in GLSL\r
- between textures and buffers as shader resources.\r
-- Misc. fixes for layers and Intel sample driver\r
-- Added mutex to APIDump, APIDumpFile and DrawState to prevent apparent threading issues using printf\r
-- Fix support for {Fill,Copy}Memory\r
-- MemTracker can report issues to application via debug callback\r
-- Update test infrastructure to improve ease of writing new tests. Add image comparison feature for regression testing. Requires ImageMagick library.\r
-- Misc. fixes to demos, layers and Intel sample driver\r
-- Added mutex to APIDump, APIDumpFile and DrawState to prevent apparent threading issues using printf\r
-- Fix support for {Fill,Copy}Memory\r
-- MemTracker can report issues to application via debug callback\r
-- Update test infrastructure to improve ease of writing new tests. Add image comparison feature for regression testing. Requires ImageMagick library.\r
-- Misc. fixes to demos, layers and Intel sample driver\r
-\r
-## How to Build and Run\r
-\r
-[BUILD.md](BUILD.md)\r
-includes directions for building all the components, running the validation tests and running the demo applications.\r
-\r
-Information on how to enable the various Debug and Validation layers is in\r
-[layers/README.md](layers/README.md).\r
-\r
-## References\r
-This version of the components are written based on the following preliminary specs and proposals:\r
-- [**VK Programers Reference**, 1 Jul 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/AMD/Explicit%20GL%20Programming%20Guide%20and%20API%20Reference.pdf)\r
-- [**BIL**, revision 29](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)\r
-\r
-## License\r
-This work is intended to be released as open source under a BSD-style\r
-license once the VK specification is public. Until that time, this work\r
-is covered by the Khronos NDA governing the details of the VK API.\r
-\r
-## Acknowledgements\r
-While this project is being developed by LunarG, Inc; there are many other\r
-companies and individuals making this possible: Valve Software, funding\r
-project development; Intel Corporation, providing full hardware specifications\r
-and valuable technical feedback; AMD, providing VK spec editor contributions;\r
-ARM, contributing a Chairman for this working group within Khronos; Nvidia,\r
-providing an initial co-editor for the spec; Qualcomm for picking up the\r
-co-editor's chair; and Khronos, for providing hosting within GitHub.\r
-\r
-## Contact\r
-If you have questions or comments about this driver; or you would like to contribute\r
-directly to this effort, please contact us at VK@LunarG.com; or if you prefer, via\r
-the GL Common mailing list: gl_common@khronos.org\r
+# Vulkan Ecosystem Components
+
+This project provides Khronos official Vulkan Tools and Utilities for Windows, Linux, Android, and MacOS.
+
+## CI Build Status
+| Platform | Build Status |
+|:--------:|:------------:|
+| Linux/Android | [](https://travis-ci.org/KhronosGroup/Vulkan-Tools) |
+| Windows |[](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-tools/branch/master) |
+
+
+## Introduction
+
+This project provides Vulkan tools and utilities that can assist development by enabling developers to
+verify their applications correct use of the Vulkan API.
+
+The following components are available in this repository:
+- [*Mock ICD*](icd/)
+- [*Vkcube and Vkcube++ Demo*](cube/)
+- [*VulkanInfo*](vulkaninfo/)
+- [*Windows Runtime*](windows-runtime-installer/)
+
+## Contact Information
+* [Tobin Ehlis](mailto:tobine@google.com)
+* [Mark Lobodzinski](mailto:mark@lunarg.com)
+
+## Information for Developing or Contributing:
+
+Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
+Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details.
+
+## How to Build and Run
+
+[BUILD.md](BUILD.md)
+Includes directions for building all components as well as running the vkcube demo applications.
+
+## Version Tagging Scheme
+
+Updates to the `Vulkan-Tools` 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 COPYRIGHT.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.
projects / platform / upstream / Vulkan-Tools.git / blobdiff