xref: /third_party/openGLES/xml/README.adoc (revision 5bd8dead)
1// Copyright 2017-2021 The Khronos Group Inc.
2// SPDX-License-Identifier: CC-BY-4.0
3
4# OpenGL XML API Registry
5
6This directory contains the OpenGL, GLX, and WGL XML API registries, in
7gl.xml, glx.xml, and wgl.xml respectively. They are used to reserve
8enumerant ranges for vendors working on new extensions, to register
9extension interfaces when an extension is published, and to generate the
10Khronos-supplied header files in ../api .
11
12The canonical versions are always found in the master branch of the github
13repository at https://github.com/KhronosGroup/OpenGL-Registry
14
15The 'validate' Makefile target uses the 'jing' tool to confirm that each XML
16file is structurally valid and conforms to the registry schema in
17registry.rnc. The schema is described in detail in readme.pdf.
18
19The 'default' Makefile target generates updated headers in ../api/ from the
20XML files.
21
22Note that while there are targets for ../api/{gl.h,glx.h,wgl.h} in
23genglvnd.py and genheaders.py, these targets are not generated by default
24and are experimental. At present, you should use the versions of these
25headers shipped with your OS or IHV SDK.
26