blob: e93eb43724cf20dc78e15ac7583a2be3454c61d0 [file] [log] [blame] [view]
JensOwen786bcc62014-11-01 09:28:29 -06001# Explicit GL (XGL) Ecosystem Components
JensOwen95c62272014-11-01 13:05:43 -06002*Version 0.2, Spinning Cube, 31 Oct 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)
17- *GLAVE Debugger* ([API Dump](https://github.com/KhronosGroup/GL-Next/blob/master/layers/api_dump.c) only)
18- [*Sample Driver*](https://github.com/KhronosGroup/GL-Next/tree/master/icd)
19 - [Common Infrastructure](https://github.com/KhronosGroup/GL-Next/tree/master/icd/common)
20 - [Implementation for Intel GPUs](https://github.com/KhronosGroup/GL-Next/tree/master/icd/intel)
21
JensOwen95c62272014-11-01 13:05:43 -060022## How to Build and Run
23
24This release demonstrates a spinning textured cube as an example of the
25vertical slice of XGL functionality running on Ubuntu 14.10 with an Intel
JensOwen3ceb4752014-11-01 13:18:21 -060026GPU.
27[BUILD.md](https://github.com/KhronosGroup/GL-Next/tree/master/BUILD.md)
28includes directions for building all the components, running the validation tests and running the demo applications.
JensOwen95c62272014-11-01 13:05:43 -060029
30Information on how to enable the API Dump and Validation layers is in
31[layers/README.md](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md).
32
33## References
JensOwen786bcc62014-11-01 09:28:29 -060034This version of the components are written based on the following preliminary specs and proposals:
35- [**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)
36- [**BIL**, version 1.0, revision 18](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)
37- [**IMG's Fixed Function Proposal**, 28 Oct 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/IMG/xgl_vertex_input_description2_img.h)
JensOwene3429322014-11-01 09:39:46 -060038- [**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 -060039
JensOwen95c62272014-11-01 13:05:43 -060040## License
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -060041This work is intended to be released as open source under a BSD-style
42license once the XGL specification is public. Until that time, this work
43is covered by the Khronos NDA governing the details of the XGL API.
44
JensOwen95c62272014-11-01 13:05:43 -060045## Acknowledgements
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -060046While this project is being developed by LunarG, Inc; there are many other
47companies and individuals making this possible: Valve Software, funding
48project development; Intel Corporation, providing full hardware specifications
49and valuable technical feedback; AMD, providing XGL spec editor contributions;
50ARM, contributing a Chairman for this working group within Khronos; Nvidia,
51providing an initial co-editor for the spec; Qualcomm for picking up the
52co-editor's chair; and Khronos, for providing hosting within GitHub.
53
JensOwen95c62272014-11-01 13:05:43 -060054## Contact
55If you have questions or comments about this driver; or you would like to contribute
56directly to this effort, please contact us at XGL@LunarG.com; or if you prefer, via
57the GL Common mailing list: gl_common@khronos.org