blob: 068149312e825b73f55e0c010cf1cef28f5a00a9 [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
26GPU. Included are instructions for
27[building all the components](https://github.com/KhronosGroup/GL-Next/tree/master/BUILD.md)
28and
29[running the XGL spinning cube demo application](https://github.com/KhronosGroup/GL-Next/tree/master/demos/README.md).
30
31Information on how to enable the API Dump and Validation layers is in
32[layers/README.md](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md).
33
34## References
JensOwen786bcc62014-11-01 09:28:29 -060035This version of the components are written based on the following preliminary specs and proposals:
36- [**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)
37- [**BIL**, version 1.0, revision 18](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)
38- [**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 -060039- [**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 -060040
JensOwen95c62272014-11-01 13:05:43 -060041## License
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -060042This work is intended to be released as open source under a BSD-style
43license once the XGL specification is public. Until that time, this work
44is covered by the Khronos NDA governing the details of the XGL API.
45
JensOwen95c62272014-11-01 13:05:43 -060046## Acknowledgements
Courtney Goeltzenleuchter21f8ea52014-09-01 17:18:57 -060047While this project is being developed by LunarG, Inc; there are many other
48companies and individuals making this possible: Valve Software, funding
49project development; Intel Corporation, providing full hardware specifications
50and valuable technical feedback; AMD, providing XGL spec editor contributions;
51ARM, contributing a Chairman for this working group within Khronos; Nvidia,
52providing an initial co-editor for the spec; Qualcomm for picking up the
53co-editor's chair; and Khronos, for providing hosting within GitHub.
54
JensOwen95c62272014-11-01 13:05:43 -060055## Contact
56If you have questions or comments about this driver; or you would like to contribute
57directly to this effort, please contact us at XGL@LunarG.com; or if you prefer, via
58the GL Common mailing list: gl_common@khronos.org