sdk: Update release notes for 0.9 SDK
[platform/upstream/Vulkan-Tools.git] / README.md
1 # Explicit GL (VK) Ecosystem Components\r
2 *Version 0.9, 28 Sep 2015*\r
3 \r
4 This project provides *open source* tools for VK Developers.\r
5 \r
6 ## Introduction\r
7 \r
8 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
9 \r
10 New with VK in an extensible layered architecture that enables significant innovation in tools:\r
11 - Cross IHV support enables tools vendors to plug into a common, extensible layer architecture\r
12 - Layered tools during development enable validating, debugging and profiling without production performance impact\r
13 - Modular validation architecture encourages many fine-grained layers--and new layers can be added easily\r
14 - Encourages open community of tool developers: led by Valve, LunarG, Codeplay and others\r
15 - Customized interactive debugging and validation layers will be available together with first drivers\r
16 \r
17 The components here are being shared with the Khronos community to provide\r
18 insights into the specification as we approach an alpha header, and to assists those doing\r
19 demos for GDC.\r
20 \r
21 The following components are available:\r
22 - VK Library and header files, which include:\r
23     - [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md)\r
24     - Snapshot of *VK* and *SPIR-V* header files from [*Khronos*](www.khronos.org)\r
25 \r
26 - [*VKTRACE tools*](vktrace)\r
27 \r
28 - Core [*Validation Layers*](layers/)\r
29 \r
30 - [*Sample Driver*](icd)\r
31 \r
32 ## New\r
33 \r
34 - Header matches provisional specification (v170) with two changes.\r
35  - DrawIndirect correction (bug #14715)\r
36  - DynamicState refactor (bug #14365)\r
37 - Provisional specification document (PDF & HTML)\r
38 - Loader now uses JSON manifest files for ICDs and layers. See BUILD.md for details on customizing loader behavior.\r
39 - All validation errors now reported via DEBUG_REPORT extension. [*DEBUG_REPORT*, Extension Document](TODO: link to VulkanDbgExtensions.docx)\r
40 - Warning: The sample driver requires DRI3 and recent versions of ubuntu 14.10 have **REMOVED** DRI 3.\r
41   Version: 2:2.99.914-1~exp1ubuntu4.1 is known to work.\r
42   Ubuntu 15.04 requires customization to add DRI3.\r
43   See BUILD.md for details.\r
44 \r
45 ## Prior updates\r
46 \r
47 \r
48 ## How to Build and Run\r
49 \r
50 [BUILD.md](BUILD.md)\r
51 includes directions for building all the components, running the validation tests and running the demo applications.\r
52 \r
53 Information on how to enable the various Debug and Validation layers is in\r
54 [layers/README.md](layers/README.md).\r
55 \r
56 ## References\r
57 This version of the components are written based on the following preliminary specs and proposals:\r
58 - [**Core Vulkan Header**, vulkan.h](https://gitlab.khronos.org/vulkan/vulkan/blob/6e1463d85b747fcad43c48eb8abd94d0f58824de/src/include/vulkan.h)\r
59 - [**SPIR-V**, revision 32](https://cvs.khronos.org/svn/repos/SPIRV/trunk/Promoter32)\r
60 - [**WSI Device Swapchain**, Revision 53 for VK_EXT_KHR_device_swapchain](https://cvs.khronos.org/svn/repos/promoters/specs/candidates/oglc/extensions/20150910/vk_ext_khr_device_swapchain.txt)\r
61 - [**WSI Swapchain**, Revision 17 for VK_EXT_KHR_swapchain](https://cvs.khronos.org/svn/repos/promoters/specs/candidates/oglc/extensions/20150910/vk_ext_khr_swapchain.txt)\r
62 \r
63 \r
64 ## License\r
65 This work is intended to be released as open source under a BSD-style\r
66 license once the VK specification is public. Until that time, this work\r
67 is covered by the Khronos NDA governing the details of the VK API.\r
68 \r
69 ## Acknowledgements\r
70 While this project is being developed by LunarG, Inc; there are many other\r
71 companies and individuals making this possible: Valve Software, funding\r
72 project development; Intel Corporation, providing full hardware specifications\r
73 and valuable technical feedback; AMD, providing VK spec editor contributions;\r
74 ARM, contributing a Chairman for this working group within Khronos; Nvidia,\r
75 providing an initial co-editor for the spec; Qualcomm for picking up the\r
76 co-editor's chair; and Khronos, for providing hosting within GitHub.\r
77 \r
78 ## Contact\r
79 If you have questions or comments about this driver; or you would like to contribute\r
80 directly to this effort, please contact us at VK@LunarG.com; or if you prefer, via\r
81 the GL Common mailing list: gl_common@khronos.org\r