blob: 342e7ebcb0d63ef0cdb5ab6fa85d6dab58864eea [file] [log] [blame] [view]
JensOwen786bcc62014-11-01 09:28:29 -06001# Explicit GL (XGL) Ecosystem Components
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -07002*Version 0.3, 26 Nov 2014*
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -06003
JensOwen95c62272014-11-01 13:05:43 -06004This project provides *open source* components for the XGL Ecosystem.
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -06005
JensOwen95c62272014-11-01 13:05:43 -06006## Introduction
7
8The components here are being shared with the Khronos community to provide
9early insights into the specification of XGL and to assists those doing
10prototyping at this point.
JensOwen786bcc62014-11-01 09:28:29 -060011
12The following components are available:
JensOwend7e99e72014-11-01 09:37:13 -060013- Proposed Reference [*ICD Loader*](https://github.com/KhronosGroup/GL-Next/tree/master/loader) (including [*Layer Management*](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md))
JensOwen786bcc62014-11-01 09:28:29 -060014- Proposed Reference [*Validation Layers*](https://github.com/KhronosGroup/GL-Next/tree/master/layers/)
15 - [Object Tracker](https://github.com/KhronosGroup/GL-Next/blob/master/layers/object_track.c)
16 - [Draw State](https://github.com/KhronosGroup/GL-Next/blob/master/layers/draw_state.c)
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -070017 - [MemTracker](https://github.com/KhronosGroup/GL-Next/blob/master/layers/mem_tracker.c)
18- *GLAVE Debugger*
19 - API Dump (generated)
20 - APIDumpFile (generated)
JensOwenf629f222014-11-01 14:05:50 -060021- [*Sample Drivers*](https://github.com/KhronosGroup/GL-Next/tree/master/icd)
JensOwen786bcc62014-11-01 09:28:29 -060022 - [Common Infrastructure](https://github.com/KhronosGroup/GL-Next/tree/master/icd/common)
23 - [Implementation for Intel GPUs](https://github.com/KhronosGroup/GL-Next/tree/master/icd/intel)
24
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -070025## New
26
27- Added APIDumpFile to write APIDump directly to a file
28- Added MemTracker validation layer
29- Added various turn-on tests for variety of driver / compiler features
30- Fix to wsiPresent to avoid deadlock with X server
31- Misc. fixes to layers and Intel sample driver
32
JensOwen95c62272014-11-01 13:05:43 -060033## How to Build and Run
34
JensOwen3ceb4752014-11-01 13:18:21 -060035[BUILD.md](https://github.com/KhronosGroup/GL-Next/tree/master/BUILD.md)
36includes directions for building all the components, running the validation tests and running the demo applications.
JensOwen95c62272014-11-01 13:05:43 -060037
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -070038Information on how to enable the various Debug and Validation layers is in
JensOwen95c62272014-11-01 13:05:43 -060039[layers/README.md](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md).
40
41## References
JensOwen786bcc62014-11-01 09:28:29 -060042This version of the components are written based on the following preliminary specs and proposals:
43- [**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)
44- [**BIL**, version 1.0, revision 18](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)
Courtney Goeltzenleuchter76793e62014-11-26 09:56:28 -070045- [**IMG's Fixed Function Proposal**, 13 Nov 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/XGL/accepted/xgl_fixed_function_vertex_fetch_proposal.txt)
JensOwene3429322014-11-01 09:39:46 -060046- [**Valve's Loader Proposal**, 7 Oct 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/Valve/xglLayers.pptx)
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -060047
JensOwen95c62272014-11-01 13:05:43 -060048## License
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -060049This work is intended to be released as open source under a BSD-style
50license once the XGL specification is public. Until that time, this work
51is covered by the Khronos NDA governing the details of the XGL API.
52
JensOwen95c62272014-11-01 13:05:43 -060053## Acknowledgements
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -060054While this project is being developed by LunarG, Inc; there are many other
55companies and individuals making this possible: Valve Software, funding
56project development; Intel Corporation, providing full hardware specifications
57and valuable technical feedback; AMD, providing XGL spec editor contributions;
58ARM, contributing a Chairman for this working group within Khronos; Nvidia,
59providing an initial co-editor for the spec; Qualcomm for picking up the
60co-editor's chair; and Khronos, for providing hosting within GitHub.
61
JensOwen95c62272014-11-01 13:05:43 -060062## Contact
63If you have questions or comments about this driver; or you would like to contribute
64directly to this effort, please contact us at XGL@LunarG.com; or if you prefer, via
65the GL Common mailing list: gl_common@khronos.org