README.md

   1 # Explicit GL (XGL) Ecosystem Components\r
   2 *Version 0.2, Spinning Cube, 31 Oct 2014*\r
   3 \r
   4 This project provides *open source* components for the XGL Ecosystem.\r
   5 \r
   6 ## Introduction\r
   7 \r
   8 The components here are being shared with the Khronos community to provide\r
   9 early insights into the specification of XGL and to assists those doing\r
  10 prototyping at this point.\r
  11 \r
  12 The following components are available:\r
  13 - 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))\r
  14 - Proposed Reference [*Validation Layers*](https://github.com/KhronosGroup/GL-Next/tree/master/layers/)\r
  15   - [Object Tracker](https://github.com/KhronosGroup/GL-Next/blob/master/layers/object_track.c)\r
  16   - [Draw State](https://github.com/KhronosGroup/GL-Next/blob/master/layers/draw_state.c)\r
  17 - *GLAVE Debugger* ([API Dump](https://github.com/KhronosGroup/GL-Next/blob/master/layers/api_dump.c) only)\r
  18 - [*Sample Driver*](https://github.com/KhronosGroup/GL-Next/tree/master/icd)\r
  19   - [Common Infrastructure](https://github.com/KhronosGroup/GL-Next/tree/master/icd/common)\r
  20   - [Implementation for Intel GPUs](https://github.com/KhronosGroup/GL-Next/tree/master/icd/intel)\r
  21 \r
  22 ## How to Build and Run\r
  23 \r
  24 This release demonstrates a spinning textured cube as an example of the\r
  25 vertical slice of XGL functionality running on Ubuntu 14.10 with an Intel\r
  26 GPU. Included are instructions for\r
  27 [building all the components](https://github.com/KhronosGroup/GL-Next/tree/master/BUILD.md)\r
  28 and\r
  29 [running the XGL spinning cube demo application](https://github.com/KhronosGroup/GL-Next/tree/master/demos/README.md).\r
  30 \r
  31 Information on how to enable the API Dump and Validation layers is in\r
  32 [layers/README.md](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md).\r
  33 \r
  34 ## References\r
  35 This version of the components are written based on the following preliminary specs and proposals:\r
  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)\r
  37 - [**BIL**, version 1.0, revision 18](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)\r
  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)\r
  39 - [**Valve's Loader Proposal**, 7 Oct 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/Valve/xglLayers.pptx)\r
  40 \r
  41 ## License\r
  42 This work is intended to be released as open source under a BSD-style\r
  43 license once the XGL specification is public. Until that time, this work\r
  44 is covered by the Khronos NDA governing the details of the XGL API.\r
  45 \r
  46 ## Acknowledgements\r
  47 While this project is being developed by LunarG, Inc; there are many other\r
  48 companies and individuals making this possible: Valve Software, funding\r
  49 project development; Intel Corporation, providing full hardware specifications\r
  50 and valuable technical feedback; AMD, providing XGL spec editor contributions;\r
  51 ARM, contributing a Chairman for this working group within Khronos; Nvidia,\r
  52 providing an initial co-editor for the spec; Qualcomm for picking up the\r
  53 co-editor's chair; and Khronos, for providing hosting within GitHub.\r
  54 \r
  55 ## Contact\r
  56 If you have questions or comments about this driver; or you would like to contribute\r
  57 directly to this effort, please contact us at XGL@LunarG.com; or if you prefer, via\r
  58 the GL Common mailing list: gl_common@khronos.org\r