Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / vulkan-validation-layers / e3b0f3a139301c1bb37a8ef28a64e012e70f0406 / . / README.md
blob: 72ba984080be2b9346d8e118cf4d7d99b4d0c485 [file] [log] [blame] [view]
JensOwen786bcc62014-11-01 09:28:29 -0600[diff] [blame]1# Explicit GL (XGL) Ecosystem Components
Courtney Goeltzenleuchter376a71c2015-02-04 17:50:32 -0700[diff] [blame]2*Version 0.8, 04 Feb 2015*
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -0600[diff] [blame]3
Jens Owenf27b4542014-12-17 11:58:21 -0700[diff] [blame]4This project provides *open source* tools for XGL Developers.
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -0600[diff] [blame]5
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]6## Introduction
7
Jens Owen9fc73fc2014-12-17 12:03:04 -0700[diff] [blame]8XGL is an Explicit API, enabling direct control over how GPUs actually work. No validation, shader recompilation, memory management or synchronization is done inside an XGL driver. Applications have full control and responsibility. Any errors in how XGL 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.
Jens Owenf27b4542014-12-17 11:58:21 -0700[diff] [blame]9
10New with XGL in an extensible layered architecture that enables significant innovation in tools:
11- Cross IHV support enables tools vendors to plug into a common, extensible layer architecture
12- Layered tools during development enable validating, debugging and profiling without production performance impact
13- Modular validation architecture encourages many fine-grained layers--and new layers can be added easily
14- Encourages open community of tool developers: led by Valve, LunarG, Codeplay and others
15- Customized interactive debugging and validation layers will be available together with first drivers
16
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]17The components here are being shared with the Khronos community to provide
Jens Owen8b5ed542014-12-18 14:36:31 -0700[diff] [blame]18insights into the specification as we approach an alpha header, and to assists those doing
19demos for GDC.
JensOwen786bcc62014-11-01 09:28:29 -0600[diff] [blame]20
21The following components are available:
Jens Owen00266782014-12-18 07:08:39 -0700[diff] [blame]22- XGL Library and header files, which include:
23 - [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md)
24 - Snapshot of *XGL* and *BIL* header files from [*Khronos*](www.khronos.org)
25
Jens Owen78a25a22014-12-17 12:21:12 -0700[diff] [blame]26- [*GLAVE Debugger*](tools/glave)
Jens Owenc8984db2014-12-17 14:18:22 -0700[diff] [blame]27
28 ![ScreenShot](docs/images/Glave-Small.png)
Jens Owen00266782014-12-18 07:08:39 -0700[diff] [blame]29
30- Core [*Validation Layers*](layers/)
31
32- [*Sample Driver*](icd)
JensOwen786bcc62014-11-01 09:28:29 -0600[diff] [blame]33
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -0700[diff] [blame]34## New
35
Courtney Goeltzenleuchter376a71c2015-02-04 17:50:32 -0700[diff] [blame]36- Updated loader, driver, demos, tests and many tools to use "alpha" xgl.h (~ version 47).
37 Supports new resource binding model, memory allocation, pixel FORMATs and
38 other updates.
39 APIDump layer is working with these new API elements.
40 Glave can trace and replay the cube and tri demos.
41 Other layers in progress.
Courtney Goeltzenleuchterfc82da62015-02-05 17:02:39 -0700[diff] [blame]42- Warning: Recent versions of 14.10 have **REMOVED** DRI 3.
43 Version: 2:2.99.914-1~exp1ubuntu4.1 is known to work.
Courtney Goeltzenleuchter376a71c2015-02-04 17:50:32 -0700[diff] [blame]44
45## Prior updates
46
Courtney Goeltzenleuchterb66da032014-12-11 16:41:43 -0700[diff] [blame]47- XGL API trace and capture tools. See tools/glave/README.md for details.
Courtney Goeltzenleuchter7b193492014-12-09 09:33:18 -0700[diff] [blame]48- Sample driver now supports multiple render targets. Added TriangleMRT to test that functionality.
49- Added XGL_SLOT_SHADER_TEXTURE_RESOURCE to xgl.h as a descriptor slot type to work around confusion in GLSL
50 between textures and buffers as shader resources.
51- Misc. fixes for layers and Intel sample driver
Courtney Goeltzenleuchter7b193492014-12-09 09:33:18 -0700[diff] [blame]52- Added mutex to APIDump, APIDumpFile and DrawState to prevent apparent threading issues using printf
53- Fix support for {Fill,Copy}Memory
54- MemTracker can report issues to application via debug callback
55- Update test infrastructure to improve ease of writing new tests. Add image comparison feature for regression testing. Requires ImageMagick library.
56- Misc. fixes to demos, layers and Intel sample driver
Courtney Goeltzenleuchter16a0a172014-12-02 11:54:27 -0700[diff] [blame]57- Added mutex to APIDump, APIDumpFile and DrawState to prevent apparent threading issues using printf
58- Fix support for {Fill,Copy}Memory
59- MemTracker can report issues to application via debug callback
60- Update test infrastructure to improve ease of writing new tests. Add image comparison feature for regression testing. Requires ImageMagick library.
61- Misc. fixes to demos, layers and Intel sample driver
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -0700[diff] [blame]62
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]63## How to Build and Run
64
Jens Owen78a25a22014-12-17 12:21:12 -0700[diff] [blame]65[BUILD.md](BUILD.md)
JensOwen3ceb4752014-11-01 13:18:21 -0600[diff] [blame]66includes directions for building all the components, running the validation tests and running the demo applications.
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]67
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -0700[diff] [blame]68Information on how to enable the various Debug and Validation layers is in
Jens Owen78a25a22014-12-17 12:21:12 -0700[diff] [blame]69[layers/README.md](layers/README.md).
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]70
71## References
JensOwen786bcc62014-11-01 09:28:29 -0600[diff] [blame]72This version of the components are written based on the following preliminary specs and proposals:
73- [**XGL Programers Reference**, 1 Jul 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/AMD/Explicit%20GL%20Programming%20Guide%20and%20API%20Reference.pdf)
Courtney Goeltzenleuchter2016e972015-02-05 15:35:26 -0700[diff] [blame]74- [**BIL**, revision 29](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -0600[diff] [blame]75
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]76## License
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -0600[diff] [blame]77This work is intended to be released as open source under a BSD-style
78license once the XGL specification is public. Until that time, this work
79is covered by the Khronos NDA governing the details of the XGL API.
80
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]81## Acknowledgements
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -0600[diff] [blame]82While this project is being developed by LunarG, Inc; there are many other
83companies and individuals making this possible: Valve Software, funding
84project development; Intel Corporation, providing full hardware specifications
85and valuable technical feedback; AMD, providing XGL spec editor contributions;
86ARM, contributing a Chairman for this working group within Khronos; Nvidia,
87providing an initial co-editor for the spec; Qualcomm for picking up the
88co-editor's chair; and Khronos, for providing hosting within GitHub.
89
JensOwen95c62272014-11-01 13:05:43 -0600[diff] [blame]90## Contact
91If you have questions or comments about this driver; or you would like to contribute
92directly to this effort, please contact us at XGL@LunarG.com; or if you prefer, via
93the GL Common mailing list: gl_common@khronos.org