third_party/angle/README.md

   1 # ANGLE - Almost Native Graphics Layer Engine
   2
   3 The goal of ANGLE is to allow users of multiple operating systems to seamlessly run WebGL and other
   4 OpenGL ES content by translating OpenGL ES API calls to one of the hardware-supported APIs available
   5 for that platform. ANGLE currently provides translation from OpenGL ES 2.0, 3.0 and 3.1 to Vulkan,
   6 desktop OpenGL, OpenGL ES, Direct3D 9, and Direct3D 11. Future plans include ES 3.2, translation to
   7 Metal and MacOS, Chrome OS, and Fuchsia support.
   8
   9 ### Level of OpenGL ES support via backing renderers
  10
  11 |                |  Direct3D 9   |  Direct3D 11     |   Desktop GL   |    GL ES      |    Vulkan     |    Metal      |
  12 |----------------|:-------------:|:----------------:|:--------------:|:-------------:|:-------------:|:-------------:|
  13 | OpenGL ES 2.0  |    complete   |    complete      |    complete    |    complete   |    complete   |    complete   |
  14 | OpenGL ES 3.0  |               |    complete      |    complete    |    complete   |    complete   |    complete   |
  15 | OpenGL ES 3.1  |        | [incomplete][ES31OnD3D] |    complete    |    complete   |    complete   |               |
  16 | OpenGL ES 3.2  |               |                  |  in progress   |  in progress  |  in progress  |               |
  17
  18 Additionally, OpenGL ES 1.1 is implemented in the front-end using OpenGL ES 3.0 features.  This
  19 version of the specification is thus supported on all platforms specified above that support OpenGL
  20 ES 3.0 with [known issues][ES1].
  21
  22 [ES31OnD3D]: doc/ES31StatusOnD3D11.md
  23 [ES1]: doc/ES1Status.md
  24
  25 ### Platform support via backing renderers
  26
  27 |              |    Direct3D 9  |   Direct3D 11  |   Desktop GL  |    GL ES    |   Vulkan    |    Metal    |
  28 |-------------:|:--------------:|:--------------:|:-------------:|:-----------:|:-----------:|:-----------:|
  29 | Windows      |    complete    |    complete    |   complete    |   complete  |   complete  |             |
  30 | Linux        |                |                |   complete    |             |   complete  |             |
  31 | Mac OS X     |                |                |   complete    |             |             |   complete  |
  32 | iOS          |                |                |               |             |             |   complete  |
  33 | Chrome OS    |                |                |               |   complete  |   planned   |             |
  34 | Android      |                |                |               |   complete  |   complete  |             |
  35 | GGP (Stadia) |                |                |               |             |   complete  |             |
  36 | Fuchsia      |                |                |               |             |   complete  |             |
  37
  38 ANGLE v1.0.772 was certified compliant by passing the OpenGL ES 2.0.3 conformance tests in October 2011.
  39
  40 ANGLE has received the following certifications with the Vulkan backend:
  41 * OpenGL ES 2.0: ANGLE 2.1.0.d46e2fb1e341 (Nov, 2019)
  42 * OpenGL ES 3.0: ANGLE 2.1.0.f18ff947360d (Feb, 2020)
  43 * OpenGL ES 3.1: ANGLE 2.1.0.f5dace0f1e57 (Jul, 2020)
  44
  45 ANGLE also provides an implementation of the EGL 1.5 specification.
  46
  47 ANGLE is used as the default WebGL backend for both Google Chrome and Mozilla Firefox on Windows
  48 platforms. Chrome uses ANGLE for all graphics rendering on Windows, including the accelerated
  49 Canvas2D implementation and the Native Client sandbox environment.
  50
  51 Portions of the ANGLE shader compiler are used as a shader validator and translator by WebGL
  52 implementations across multiple platforms. It is used on Mac OS X, Linux, and in mobile variants of
  53 the browsers. Having one shader validator helps to ensure that a consistent set of GLSL ES shaders
  54 are accepted across browsers and platforms. The shader translator can be used to translate shaders
  55 to other shading languages, and to optionally apply shader modifications to work around bugs or
  56 quirks in the native graphics drivers. The translator targets Desktop GLSL, Vulkan GLSL, Direct3D
  57 HLSL, and even ESSL for native GLES2 platforms.
  58
  59 ## Sources
  60
  61 ANGLE repository is hosted by Chromium project and can be
  62 [browsed online](https://chromium.googlesource.com/angle/angle) or cloned with
  63
  64     git clone https://chromium.googlesource.com/angle/angle
  65
  66
  67 ## Building
  68
  69 View the [Dev setup instructions](doc/DevSetup.md).
  70
  71 ## Contributing
  72
  73 * Join our [Google group](https://groups.google.com/group/angleproject) to keep up to date.
  74 * Join us on [Slack](https://chromium.slack.com) in the #angle channel. You can
  75   follow the instructions on the [Chromium developer page](https://www.chromium.org/developers/slack)
  76   for the steps to join the Slack channel. For Googlers, please follow the
  77   instructions on this [document](https://docs.google.com/document/d/1wWmRm-heDDBIkNJnureDiRO7kqcRouY2lSXlO6N2z6M/edit?usp=sharing)
  78   to use your google or chromium email to join the Slack channel.
  79 * [File bugs](http://anglebug.com/new) in the [issue tracker](https://bugs.chromium.org/p/angleproject/issues/list) (preferably with an isolated test-case).
  80 * [Choose an ANGLE branch](doc/ChoosingANGLEBranch.md) to track in your own project.
  81
  82
  83 * Read ANGLE development [documentation](doc).
  84 * Look at [pending](https://chromium-review.googlesource.com/q/project:angle/angle+status:open)
  85   and [merged](https://chromium-review.googlesource.com/q/project:angle/angle+status:merged) changes.
  86 * Become a [code contributor](doc/ContributingCode.md).
  87 * Use ANGLE's [coding standard](doc/CodingStandard.md).
  88 * Learn how to [build ANGLE for Chromium development](doc/BuildingAngleForChromiumDevelopment.md).
  89 * Get help on [debugging ANGLE](doc/DebuggingTips.md).
  90 * Go through [ANGLE's orientation](doc/Orientation.md) and sift through [starter projects](https://bugs.chromium.org/p/angleproject/issues/list?q=Hotlist%3DStarterBug). If you decide to take on any task, write a comment so you can get in touch with us, and more importantly, set yourself as the "owner" of the bug. This avoids having multiple people accidentally working on the same issue.
  91
  92
  93 * Read about WebGL on the [Khronos WebGL Wiki](http://khronos.org/webgl/wiki/Main_Page).
  94 * Learn about the initial ANGLE implementation details in the [OpenGL Insights chapter on ANGLE](http://www.seas.upenn.edu/~pcozzi/OpenGLInsights/OpenGLInsights-ANGLE.pdf) (this is not the most up-to-date ANGLE implementation details, it is listed here for historical reference only) and this [ANGLE presentation](https://drive.google.com/file/d/0Bw29oYeC09QbbHoxNE5EUFh0RGs/view?usp=sharing&resourcekey=0-CNvGnQGgFSvbXgX--Y_Iyg).
  95 * Learn about the past, present, and future of the ANGLE implementation in [this presentation](https://docs.google.com/presentation/d/1CucIsdGVDmdTWRUbg68IxLE5jXwCb2y1E9YVhQo0thg/pub?start=false&loop=false).
  96 * Watch a [short presentation](https://youtu.be/QrIKdjmpmaA) on the Vulkan back-end.
  97 * Track the [dEQP test conformance](doc/dEQP-Charts.md)
  98 * Read design docs on the [Vulkan back-end](src/libANGLE/renderer/vulkan/README.md)
  99 * Read about ANGLE's [testing infrastructure](infra/README.md)
 100 * View information on ANGLE's [supported extensions](doc/ExtensionSupport.md)
 101 * If you use ANGLE in your own project, we'd love to hear about it!